Filter Classes¶
Object Filters¶
Base Object Filter¶
- class CommonMatchObjectFilterBase(*args, **kwargs)¶
Bases:
TunableObjectFilterA filter that will match on objects.
- get_filter_type()¶
Indicates the type of filter.
- Return type:
CommonObjectFilterType
- matches(obj)¶
Whether or not the specified object matches this filter.
- Parameters:
obj (ScriptObject) – An instance of an object.
- Returns:
True, if the object matches the filter. False, if not.
- Return type:
bool
Match All Sims¶
- class CommonMatchAllSimsObjectFilter(*args, **kwargs)¶
Bases:
CommonMatchObjectFilterBaseA filter that will match on all Sims.
- matches(obj)¶
Whether or not the specified object matches this filter.
- Parameters:
obj (ScriptObject) – An instance of an object.
- Returns:
True, if the object matches the filter. False, if not.
- Return type:
bool
Match All Non Sims¶
- class CommonMatchAllNonSimsObjectFilter(*args, **kwargs)¶
Bases:
CommonMatchObjectFilterBaseAn object filter that will match on all non-Sim objects.
- matches(obj)¶
Whether or not the specified object matches this filter.
- Parameters:
obj (ScriptObject) – An instance of an object.
- Returns:
True, if the object matches the filter. False, if not.
- Return type:
bool