Module ManualButtonUnit
Emits a signal for the duration it is pressed.
Element class: ManualButtonUnit
Extends: Element > ElementWithState
Functions
| isDown () | Checks if the manual button is down. |
| getSignalOut (plug) | Return the value of a signal in the specified OUT plug of the element. |
| EVENT_pressed () | Deprecated: Event: The button has been pressed. |
| EVENT_onPressed () | Event: Emitted when the button is pressed. |
| EVENT_released () | Deprecated: Event: The button has been released. |
| EVENT_onReleased () | Event: Emitted when the button is released. |
Functions
- isDown ()
-
Checks if the manual button is down.
Returns:
-
0/1
1 if the manual button is down.
- getSignalOut (plug)
-
Return the value of a signal in the specified OUT plug of the element.
Valid plug names are:
- "out" for the out signal.
Parameters:
- plug string A valid plug name to query.
Returns:
-
0/1
The plug signal state.
- EVENT_pressed ()
-
Deprecated: Event: The button has been pressed.
Note: This is documentation on an event handler, not a callable method.
This event is deprecated: EVENT_onPressed should be used instead.
See also:
- EVENT_onPressed ()
-
Event: Emitted when the button is pressed.
Note: This is documentation on an event handler, not a callable method.
- EVENT_released ()
-
Deprecated: Event: The button has been released.
Note: This is documentation on an event handler, not a callable method.
This event is deprecated: EVENT_onReleased should be used instead.
See also:
- EVENT_onReleased ()
-
Event: Emitted when the button is released.
Note: This is documentation on an event handler, not a callable method.