Note: This PRState documentation is out-dated and is for an older (pre-GMS v2.3) version of PRState. For the most up-to-date docs on the latest version of PRState, please refer to this page as well as the documentation included in the PRState package.

Documentation Topics
Function

PRStateCanSet()

Returns whether or not the object can be set to the given state taking into consideration the valid from states assigned to the object's current state.

Declaration

PRStateCanSet(obj, stateName)

Parameters

obj

The object to test.

stateName

The name of the state to test.

Return Value

true if the object is capable of switching to the given state, false otherwise.