new ArchActionWait(coreWaitAction)
The Architect Scripting class for the Wait action.
Instances of this action should be created by calling ArchFactoryActions#addActionWait
Parameters:
| Name | Type | Description |
|---|---|---|
coreWaitAction |
Object | ( Internal ) an Architect core wait action. |
Extends
Members
-
static, readonly displayTypeName :string
-
Returns the display type name string 'ArchActionWait'.
-
readonly displayTypeName :string
-
Returns the display type name string 'ArchBaseAction'.
- Overrides:
-
readonly displayTypeNameArchitect :string
-
The Architect action type label
- Inherited From:
-
readonly duration :ArchValueDuration
-
The wait duration.
-
readonly isArchActionWait :boolean
-
Returns true indicating that this is an ArchActionWait 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, theArchMenuDisconnect#actionDisconnectproperty on anArchMenuDisconnectinstance.- 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
taskorlooping task. Otherwise, nothing is returned.- Inherited From:
-
readonly trackingId :number
-
The integer tracking identifier for this action. This is the numeric identifier is displayed in the Architect user interface.
- Inherited From:
-
readonly trimDurationNearMaxRunningTime :ArchValueBoolean
-
Returns whether or not the action should trim the wait duration below the max value so as not to throw an error at runtime. If the runtime value evaluates to true, the duration will be trimmed. Any other value, false or a NOT_SET boolean, will result in the duration not being modified.