atk.state_set
Module for [StateSet] class
Types 3
An AtkStateSet contains the states of an object.
An AtkStateSet is a read-only representation of the full set of #AtkStates that apply to an object at a given time. This set is not meant to be modified, but rather created when #[atk.object.ObjectWrap.refStateSet] is called.
Methods
StateSetGidBuilder builder()Get builder for [atk.state_set.StateSet] Returns: New builder objectbool addState(atk.types.StateType type)Adds the state of the specified type to the state set if it is not already present.void addStates(atk.types.StateType[] types)Adds the states of the specified types to the state set.atk.state_set.StateSet andSets(atk.state_set.StateSet compareSet)Constructs the intersection of the two sets, returning null if the intersection is empty.void clearStates()Removes all states from the state set.bool containsState(atk.types.StateType type)Checks whether the state for the specified type is in the specified set.bool containsStates(atk.types.StateType[] types)Checks whether the states for all the specified types are in the specified set.bool isEmpty()Checks whether the state set is empty, i.e. has no states set. Returns: true if set has no states set, otherwise falseatk.state_set.StateSet orSets(atk.state_set.StateSet compareSet)Constructs the union of the two sets.bool removeState(atk.types.StateType type)Removes the state for the specified type from the state set.atk.state_set.StateSet xorSets(atk.state_set.StateSet compareSet)Constructs the exclusive-or of the two sets, returning null is empty. The set returned by this operation contains the states in exactly one of the two sets.