new ArchActionClearSlot(coreClearSlotActionViewModel)
The Architect Scripting class that represents the Clear Slot action.
Instances of this action should be created by calling ArchFactoryActions#addActionClearSlot
Parameters:
| Name | Type | Description |
|---|---|---|
coreClearSlotActionViewModel |
Object | ( Internal ) an Architect core clear slot action view model. |
Extends
Members
-
static, readonly displayTypeName :string
-
Returns the display type name string 'ArchActionClearSlot'.
-
readonly displayTypeName :string
-
Returns the display type name string 'ArchBaseAction'.
- Overrides:
-
readonly displayTypeNameArchitect :string
-
The Architect action type label
- Inherited From:
-
readonly isArchActionClearSlot :boolean
-
Returns true indicating that this is an ArchActionClearSlot 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 slotCount :number
-
Returns the current slot count on the action
-
readonly trackingId :number
-
The integer tracking identifier for this action. This is the numeric identifier is displayed in the Architect user interface.
- Inherited From:
Methods
-
addSlot(slotName)
-
Adds a slot to the action with the specified slot name.
Parameters:
Name Type Description slotNamestring the name of the slot to clear
-
deleteSlotByIndex(index) → {void}
-
Deletes a slot from the action at the specified index.
Parameters:
Name Type Description indexnumber the zero-based index of the slot to delete. This value should be a non-negative integer.
Returns:
void