Module ForceFieldUnit
A force field to create an uncrossable energy barrier.
Element class: ForceFieldUnit
Extends: Element > ElementWithState > ElementWithToggle
Functions
| deploy () | Deploys the forcefield. |
| retract () | Retracts the forcefield. |
| isDeployed () | Checks if the forcefield is deployed. |
| setSignalIn (plug, state) | Set the value of a signal in the specified IN plug of the element. |
| getSignalIn (plug) | Return the value of a signal in the specified IN plug of the element. |
Functions
- deploy ()
- Deploys the forcefield.
- retract ()
- Retracts the forcefield.
- isDeployed ()
-
Checks if the forcefield is deployed.
Returns:
-
0/1
1 if the forcefield is deployed.
- setSignalIn (plug, state)
-
Set the value of a signal in the specified IN plug of the element.
Valid plug names are:
- "in" for the in signal (only appears to cause the element to refresh state to match actual input signal when it doesn't already).
Parameters:
- plug string A valid plug name to set.
- state 0/1 The plug signal state
- getSignalIn (plug)
-
Return the value of a signal in the specified IN plug of the element.
Valid plug names are:
- "in" for the in signal (seems to have no actual effect when modified this way).
Parameters:
- plug string A valid plug name to query.
Returns:
-
0/1
The plug signal state