Component:InteractionHandlerStreamDriver: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page CommonToolStreamDriver (Component) to Component:CommonToolStreamDriver: Creating component Namespace
Style. This is no longer a stub. Added a description, added field descriptions, added usage description.
 
(3 intermediate revisions by one other user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=CommonToolStreamDriverComponent.png
|Image=InteractionHandlerStreamDriverComponent.png
|Name=CommonToolStreamDriver
|Name=InteractionHandlerStreamDriver
}}
}}


<!--T:2-->
<!--T:2-->
== Intoduction ==
The '''InteractionHandlerStreamDriver''' component uses streaming data from the [[Component:ValueStream|ValueStream]] component (seen in the [[user Inspector]]) to control the interaction (such as [[Component:Laser|lasers]]) on a [[User|user's]] [[Avatar|avatar]] or [[Userspace]].


<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Node|ControllerNode|  
|Side|Chirality| The side to get the data.
|PrimaryBlockedStream|ValueStream`1|TypeString1=ValueStream<Bool>|  
|PrimaryBlockedStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv1=true| The value interaction data currently being blocked. (Primary)
|SecondaryBlockedStream|ValueStream`1|TypeString2=ValueStream<Bool>|  
|SecondaryBlockedStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv2=true| The value interaction data currently being blocked. (Secondary)
|LaserActiveStream|ValueStream`1|TypeString3=ValueStream<Bool>|  
|LaserActiveStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv3=true| The streamed data for this interaction.
|ShowLaserToOthersStream|ValueStream`1|TypeString4=ValueStream<Bool>|  
|ShowLaserToOthersStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv4=true| Shows the laser data for the other stream.
|LaserTargetStream|ValueStream`1|TypeString5=ValueStream<Float3>|  
|LaserTargetStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float3|Float3]]&gt;'''|TypeAdv5=true| Shows the value for the target of this interaction.
|GrabDistanceStream|ValueStream`1|TypeString6=ValueStream<Float>|  
|GrabDistanceStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv6=true| Shows the data of the distance of this interaction.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
Used for [[Component:Laser|lasers]] and interactions.


<!--T:5-->
<!--T:5-->
Line 32: Line 31:
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:Components{{#translation:}}|CommonToolStreamDriver (Component){{#translation:}}]]
[[Category:Components{{#translation:}}|Interaction Handler Stream Driver]]
[[Category:ComponentStubs]]
[[Category:Components:Users{{#translation:}}|Interaction Handler Stream Driver]]
[[Category:Components:Users{{#translation:}}|CommonToolStreamDriver (Component){{#translation:}}]]

Latest revision as of 08:09, 6 October 2024

Component image 
InteractionHandlerStreamDriver component as seen in the Scene Inspector


The InteractionHandlerStreamDriver component uses streaming data from the ValueStream component (seen in the user Inspector) to control the interaction (such as lasers) on a user's avatar or Userspace.

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
Side Chirality The side to get the data.
PrimaryBlockedStream ValueStream`1<Bool> The value interaction data currently being blocked. (Primary)
SecondaryBlockedStream ValueStream`1<Bool> The value interaction data currently being blocked. (Secondary)
LaserActiveStream ValueStream`1<Bool> The streamed data for this interaction.
ShowLaserToOthersStream ValueStream`1<Bool> Shows the laser data for the other stream.
LaserTargetStream ValueStream`1<Float3> Shows the value for the target of this interaction.
GrabDistanceStream ValueStream`1<Float> Shows the data of the distance of this interaction.

Usage

Used for lasers and interactions.

Examples

Related Components