docs » plugins.core.tangent.manager.action
Represents a Tangent Action
- Constructors - API calls which return an object, typically one that offers API methods
- action
- Fields - Variables which can only be accessed from an object returned by a constructor
- active
- localActive
- Methods - API calls which can only be made on an object returned by a constructor
- is
- onPress
- onRelease
- xml
Signature | plugins.core.tangent.manager.action(id[, name[, parent[, localActive]]]) -> action |
---|---|
Type | Constructor |
Description | Creates a new Action instance. |
Parameters |
|
Returns |
|
Signature | plugins.core.tangent.manager.action.active <cp.prop: boolean; read-only> |
---|---|
Type | Field |
Description | Indicates if the action is active. It will only be active if |
Signature | plugins.core.tangent.manager.action.localActive <cp.prop: boolean> |
---|---|
Type | Field |
Description | Indicates if the action should ignore the parent's enabled state when determining if the action is active. |
Signature | plugins.core.tangent.manager.action.is() -> boolean |
---|---|
Type | Method |
Description | Is an object an action? |
Parameters |
|
Returns |
|
Signature | plugins.core.tangent.manager.action:onPress(pressFn) -> self |
---|---|
Type | Method |
Description | Sets the function that will be called when the Tangent sends a 'action on' request. |
Parameters |
|
Returns |
|
Signature | plugins.core.tangent.manager.action:onRelease(releaseFn) -> self |
---|---|
Type | Method |
Description | Sets the function that will be called when the Tangent sends a 'action off' request. |
Parameters |
|
Returns |
|
Signature | plugins.core.tangent.manager.action:xml() -> cp.web.xml |
---|---|
Type | Method |
Description | Returns the xml configuration for the Action. |
Parameters |
|
Returns |
|