Difference between revisions of "Drive (LogiX node)"
(Update with new outputs in build 2020.8.5.1184) |
(Add usage details) |
||
| Line 2: | Line 2: | ||
<languages></languages> | <languages></languages> | ||
<translate> | <translate> | ||
| − | The '''Drive''' node. | + | The '''Drive''' value node will start driving the referenced DriveTarget value with the input Source value when an impulse is received at StartDrive. It will stop driving the DriveTarget if an impulse is received at StopDriving. |
<!--[[File:|border|256px|right]]--> | <!--[[File:|border|256px|right]]--> | ||
| Line 60: | Line 60: | ||
== Usage == | == Usage == | ||
| − | + | The Source input and HookedValue outputs start with an unset dummy type, the node will recast to the appropriate type when either of these, or the DriveTarget, is set. If the value referenced by TargetValue is being driven by another source, including another Drive node, when an impulse is received at StartDrive the previous drive will be overridden by the new drive Source. Driven values cannot be written to, however, if a Drive node has set up an active drive on the DriveTarget and an attempt is made to write to that value, an impulse is fired from OnHook and the HookedValue output provides the value which would have been written to the target (available for the duration of the impulse chain from OnHook). OnStartDrive and OnStopDrive fire impulses when a drive is successfully started or stopped as a result of impulses at StartDrive or StopDrive respectively. | |
== Examples == | == Examples == | ||
Revision as of 22:26, 5 August 2020
This article or section is a Stub. You can help the Neos Wiki by expanding it.
The Drive value node will start driving the referenced DriveTarget value with the input Source value when an impulse is received at StartDrive. It will stop driving the DriveTarget if an impulse is received at StopDriving.
Inputs & Outputs
| Color | Label | Type |
| StartDrive | Impulse | |
| StopDrive | Impulse | |
| Source | (dummy) |
| Color | Label | Type |
| DriveTarget | IField<T> | |
| OnStartDrive | Impulse | |
| OnStopDrive | Impulse | |
| OnHook | Impulse | |
| IsDriving | Boolean | |
| HookedValue | (dummy) |
Usage
The Source input and HookedValue outputs start with an unset dummy type, the node will recast to the appropriate type when either of these, or the DriveTarget, is set. If the value referenced by TargetValue is being driven by another source, including another Drive node, when an impulse is received at StartDrive the previous drive will be overridden by the new drive Source. Driven values cannot be written to, however, if a Drive node has set up an active drive on the DriveTarget and an attempt is made to write to that value, an impulse is fired from OnHook and the HookedValue output provides the value which would have been written to the target (available for the duration of the impulse chain from OnHook). OnStartDrive and OnStopDrive fire impulses when a drive is successfully started or stopped as a result of impulses at StartDrive or StopDrive respectively.
Examples
Node Menu
| Actions | ||||||
|---|---|---|---|---|---|---|
| Back | -- | ++ | Drive | Drive Playback | Tween | Write |
| Write Latch | Write Ref | Write Ref Latch | ||||