Component:AvatarRawToolData: Difference between revisions

From Resonite Wiki
Automated: update Fields, Categories
add info
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AvatarRawToolDataComponent.png
|Image=AvatarRawToolDataComponent.png
|Name=AvatarRawToolData
|Name=AvatarRawToolData
}}
}}
 
The '''AvatarRawToolData''' component is used to read controller data associated with [[Component:RawDataTool|RawDataTool]]s from.
<!--T:2-->
== Intoduction ==


<!--T:3-->
<!--T:3-->
== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|ControllerSide|Chirality|
|ControllerSide|Chirality| The side to read data from the user's controller for.
|PressingPrimary|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv1=true|
|PressingPrimary|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv1=true| Whether the user is pressing Primary
|PressingSecondary|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv2=true|
|PressingSecondary|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv2=true| Whether the user is pressing Secondary.
|PressingGrab|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv3=true|
|PressingGrab|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv3=true| Whether the user is pressing the grab button
|PrimaryStrength|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv4=true|
|PrimaryStrength|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv4=true| The strength the user is pressing Primary.
|SecondaryAxis|{{RootFieldType|RawOutput`1|[[Type:Float2|Float2]]}}|TypeAdv5=true|
|SecondaryAxis|{{RootFieldType|RawOutput`1|[[Type:Float2|Float2]]}}|TypeAdv5=true| What direction the user is moving their secondary button joystick
|_activeUser|User|
|_activeUser|User| The user this is reading data and getting streams from.
|_strengthStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv7=true|
|_strengthStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv7=true| The stream to get <code>PrimaryStrength</code>'s value from
|_axisStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float2|Float2]]&gt;'''|TypeAdv8=true|
|_axisStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float2|Float2]]&gt;'''|TypeAdv8=true| The stream to get <code>SecondaryAxis</code>'s value from.
|_primaryStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv9=true|
|_primaryStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv9=true| The stream to get <code>PressingPrimary</code>'s value from.
|_secondaryStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv10=true|
|_secondaryStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv10=true| The stream to get <code>PressingSecondary</code>'s value from.
|_grabStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv11=true|
|_grabStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv11=true| The stream to get <code>PressingGrab</code>'s value from.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==


<!--T:5-->
<!--T:5-->
Line 35: Line 32:


<!--T:6-->
<!--T:6-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:Components{{#translation:}}|Avatar Raw Tool Data]]
[[Category:Components{{#translation:}}|Avatar Raw Tool Data]]
[[Category:ComponentStubs]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar Raw Tool Data]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar Raw Tool Data]]

Latest revision as of 03:06, 1 January 2025

Component image 
AvatarRawToolData component as seen in the Scene Inspector

The AvatarRawToolData component is used to read controller data associated with RawDataTools from.

Fields

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.
ControllerSide Chirality The side to read data from the user's controller for.
PressingPrimary raw output of Bool Whether the user is pressing Primary
PressingSecondary raw output of Bool Whether the user is pressing Secondary.
PressingGrab raw output of Bool Whether the user is pressing the grab button
PrimaryStrength raw output of Float The strength the user is pressing Primary.
SecondaryAxis raw output of Float2 What direction the user is moving their secondary button joystick
_activeUser User The user this is reading data and getting streams from.
_strengthStream ValueStream`1<Float> The stream to get PrimaryStrength's value from
_axisStream ValueStream`1<Float2> The stream to get SecondaryAxis's value from.
_primaryStream ValueStream`1<Bool> The stream to get PressingPrimary's value from.
_secondaryStream ValueStream`1<Bool> The stream to get PressingSecondary's value from.
_grabStream ValueStream`1<Bool> The stream to get PressingGrab's value from.

Usage

Examples

See Also