ArchActionChangeState(coreChangeStateActionViewModel)

new ArchActionChangeState(coreChangeStateActionViewModel)

The Architect Scripting class for the Change State action. Instances of this action should be created by calling ArchFactoryActions#addActionChangeState

Parameters:
Name Type Description
coreChangeStateActionViewModel Object

( Internal ) an Architect core change state action view model.
See:

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionChangeState'.

readonly displayTypeName :string

Returns the display type name string 'ArchBaseAction'.

Overrides:

readonly displayTypeNameArchitect :string

The Architect action type label

Inherited From:

readonly isArchActionChangeState :boolean

Returns true indicating that this is an ArchActionChangeState instance.

readonly isArchBaseAction :boolean

A property that can be checked to verify the scripting object is a type of ArchBaseAction

Inherited From:

readonly isMenuChoiceAction :boolean

Returns whether or not this action is the action property for a menu choice. For example, the ArchMenuDisconnect#actionDisconnect property on an ArchMenuDisconnect instance.

Inherited From:

readonly isReachable :boolean

Returns whether or not this action is reachable at runtime.

Inherited From:

readonly isSecure :boolean

Returns whether or not this action is secure which means either the action by its very nature is secure or it consumes secure data.

Inherited From:

readonly isUnreachable :boolean

Returns whether or not this action is unreachable at runtime.

Inherited From:

readonly logStr :string

A string suitable for logging that contains information about this action. This will contain the action tracking id, name and scripting type name.

Inherited From:

name :string

The name of the action

Inherited From:

readonly parentFlow :ArchBaseFlow

Returns the parent flow for this action.

Inherited From:

readonly parentMenuChoice :ArchBaseMenuChoice

Returns the parent menu choice if this action is the action for a menu choice. Otherwise, nothing is returned.

Inherited From:

readonly parentState :ArchState

Returns the parent state that contains this action if this action is in a state. Otherwise, nothing is returned.

Inherited From:

readonly parentTask :ArchTask|ArchTaskLoop

Returns the parent task that contains this action if this action is in a task or looping task. Otherwise, nothing is returned.

Inherited From:

targetState :ArchState

The target state for this change state action. To clear the state, set the value to either null or undefined.

readonly trackingId :number

The integer tracking identifier for this action. This is the numeric identifier is displayed in the Architect user interface.

Inherited From: