Calculations¶
Available For Sim¶
-
class
CommonAvailableForSim
(genders=(), ages=(), species=(), occult_types=())¶ Bases:
object
Holds information for what types of Sims this is available for.
Note
At least one argument must be supplied with values.
Parameters: - genders (Iterator[CommonGender], optional) – An iterator of CommonGender. Default is an empty collection.
- ages (Iterator[CommonAge], optional) – An iterator of CommonAge. Default is an empty collection.
- species (Iterator[CommonSpecies], optional) – An iterator of CommonSpecies. Default is an empty collection.
- occult_types (Iterator[CommonOccultType], optional) – An iterator of CommonOccultType. Default is an empty collection.
-
ages
¶ Ages this is available for.
-
clone
() → sims4communitylib.classes.calculations.common_available_for_sim.CommonAvailableForSim¶ Clone the available for.
-
static
everything
() → sims4communitylib.classes.calculations.common_available_for_sim.CommonAvailableForSim¶ Create an Available For instance that applies to everything.
-
genders
¶ Genders this is available for.
-
static
generate_for_sim
(sim_info)¶ Generate an available for, for a Sim.
Parameters: sim_info (SimInfo) – An instance of a Sim. Returns: An available for matching the specified Sim. Return type: CommonAvailableForSim
-
is_available_for
(sim_info)¶ Determine if available for a Sim.
Parameters: sim_info (SimInfo) – An instance of a Sim. Returns: True, if is available for the specified Sim. False, if not. Return type: bool
-
is_valid
()¶ Determine if the Available For is valid.
Returns: If the Available For is valid, the return will be True and a Success message. If the Available For is not valid, the return will be False and an error message. Return type: Tuple[bool, str]
-
occult_types
¶ Occult Types this is available for.
-
species
¶ Species this is available for.