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

PRStateAdd()

Adds a new state to an object.


Declaration

PRStateAdd(obj, stateName, script, optionalValidFromStates)

Parameters

obj

The object to add the new state to.

stateName

The name of the state to add.

script

The script that will be called to handle the state.

optionalValidFromStates

Array of state names that are valid from states (optional.)

Return Value

n/a