Filter Classes

Object Filters

Base Object Filter

class CommonMatchObjectFilterBase(*args, **kwargs)

Bases: sphinx.ext.autodoc.importer._MockObject

A filter that will match on objects.

get_filter_type() → sims4communitylib.enums.common_object_filter_type.CommonObjectFilterType

Indicates the type of filter.

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: sims4communitylib.classes.filters.common_match_object_filter.CommonMatchObjectFilterBase

A 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: sims4communitylib.classes.filters.common_match_object_filter.CommonMatchObjectFilterBase

An 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