Component:RawDataTool: Difference between revisions

From Resonite Wiki
Automated: update Categories
Add info
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<!--T:1-->
{{Infobox Component
{{stub}}<!--T:2-->
|Image=RawDataToolComponent.png
|Name=Raw Data Tool
}}
The '''RawDataTool''' or Raw Data Tool Tip component is used in many different tooltip creations to allow for getting tooltip related actions on the hand its equipped in. This component has a ProtoFlux node associated with it ([[ProtoFlux:RawDataTool Events]])
 
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true|{{stub}}
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true| {{Template:ITool _equipLink}}
|TipReference|Slot|{{stub}}
|TipReference|Slot| {{Template:ITool TipReference}}
|BlockGripEquip|Bool|{{stub}}
|BlockGripEquip|Bool| {{Template:ITool BlockGripEquip}}
|BlockRemoteEquip|Bool|{{stub}}
|BlockRemoteEquip|Bool| {{Template:ITool BlockRemoteEquip}}
|EquipName|String|{{stub}}
|EquipName|String| {{Template:ITool EquipName}}
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true|{{stub}}
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}}
|_gripPosesGenerated|Bool|{{stub}}
|_gripPosesGenerated|Bool| {{Template:ITool _gripPosesGenerated}}
|LocalTipOffset|Float3|{{stub}}
|LocalTipOffset|Float3| How much to offset the tooltip and its laser
|LocalTipReference|Slot|{{stub}}
|LocalTipReference|Slot| The slot to use for the laser source and tip location.
|UseLaser|Bool|{{stub}}
|UseLaser|Bool| Whether to enable the use of and visual of the Laser.
|BlockPrimaryWhenTouching|Bool|{{stub}}
|BlockPrimaryWhenTouching|Bool| blocks use of primary when the tooltip is touching a wall.
|UseSecondary|Bool|{{stub}}
|UseSecondary|Bool| Allow for use of secondary. When disabled on quest this disables the Tank Controls mode which many quest users in the resonite community dislike.
|AllowUseWhenHolding|Bool|{{stub}}
|AllowUseWhenHolding|Bool| Allow use of the tool when the user is holding onto the tool rather than having it equipped.
|Equipped|Bool|{{stub}}
|Equipped|Bool| Whether the tool is equipped or not. This will still return true if the user is holding onto the tip. Commonly referred to as "Soft Equipping" or "Sudo Equipping".
|ControllerType|{{RootFieldType|SyncType}}|TypeAdv14=true| {{stub}}
|ControllerType|{{RootFieldType|SyncType}}|TypeAdv14=true| The [[Type:Type|Type]] (C# class) of the controller holding this tooltip.
|ControllerSide|Chirality|{{stub}}
|ControllerSide|Chirality| Whether the left, right, or none controller is holding this tooltip.
|PrimaryStrength|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv16=true|{{stub}}
|PrimaryStrength|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv16=true| The live updated value of the user's primary strength on this hand. Applies to VRcontrollers or game pad type controllers.
|SecondaryAxis|{{RootFieldType|RawOutput`1|[[Type:Float2|Float2]]}}|TypeAdv17=true|{{stub}}
|SecondaryAxis|{{RootFieldType|RawOutput`1|[[Type:Float2|Float2]]}}|TypeAdv17=true| The position of the thumb on the track pad used for secondary on this hand.
|Primary|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv18=true|{{stub}}
|Primary|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv18=true| Whether the user is pressing primary on this hand. See [[Controls]]
|Secondary|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv19=true|{{stub}}
|Secondary|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv19=true| Whether the user is pressing secondary on this hand. See [[Controls]].
|_primaryStrengthStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv20=true|{{stub}}
|_primaryStrengthStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv20=true| The value stream of the primary strength value. This comes from a user's value streams which can be viewed through a [[User Inspector]].
|_secondaryAxisStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float2|Float2]]&gt;'''|TypeAdv21=true|{{stub}}
|_secondaryAxisStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Float2|Float2]]&gt;'''|TypeAdv21=true| The value stream of the secondary strength value. This comes from a user's value streams which can be viewed through a [[User Inspector]].
|_primaryStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv22=true|{{stub}}
|_primaryStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv22=true| The value stream of the primary pressed value. This comes from a user's value streams which can be viewed through a [[User Inspector]].
|_secondaryStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv23=true|{{stub}}
|_secondaryStream|'''[[Type:ValueStream`1|ValueStream`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv23=true| The value stream of the secondary pressed value. This comes from a user's value streams which can be viewed through a [[User Inspector]].
|_rawStrength|Float|{{stub}}
|_rawStrength|Float| The Raw unfiltered value of the primary strength value.
|_rawAxis|Float2|{{stub}}
|_rawAxis|Float2| the Raw unfiltered value of the secondary axis value.
|_rawPrimary|Bool|{{stub}}
|_rawPrimary|Bool| the Raw unfiltered value of the primary pressed value.
|_rawSecondary|Bool|{{stub}}
|_rawSecondary|Bool| the Raw unfiltered value of the secondary pressed value.
|PrimaryActionDescription|String|
|PrimaryActionDescription|String| sets the label that tells the user what primary on this tool does.
|SecondaryActionDescription|String|
|SecondaryActionDescription|String| sets the label that tells the user what secondary on this tool does.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{stub}}
Attach to a slot and this component will generate the needed slots for this tool to work. This component will need a collider in its slot hierarchy so the tool can be grabbed and used. Combining this tool with protoflux or Components is needed to add custom behavior.


<!--T:4-->
<!--T:4-->
Line 44: Line 48:


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
 
[[Category:Components:Tools{{#translation:}}|Raw Data Tool]]
[[Category:Components:Tools{{#translation:}}|Raw Data Tool]]
[[Category:Components{{#translation:}}|Raw Data Tool]]
[[Category:Components{{#translation:}}|Raw Data Tool]]
[[Category:ComponentStubs]]

Latest revision as of 17:57, 11 November 2024

Component image 
File:RawDataToolComponent.png
Raw Data Tool component as seen in the Scene Inspector

The RawDataTool or Raw Data Tool Tip component is used in many different tooltip creations to allow for getting tooltip related actions on the hand its equipped in. This component has a ProtoFlux node associated with it (ProtoFlux:RawDataTool Events)

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.
_equipLink direct LinkTarget`1<ITool> This is Internal, and is used by the engine to retrieve the component this field is a part of. It cannot be assigned to.
TipReference Slot The slot to use as the tool's tip, instead of the component's slot.
BlockGripEquip Bool Whether to prevent legacy double grip equipping from equipping this tooltip.
BlockRemoteEquip Bool Whether to prevent equipping by clicking via laser
EquipName String The name of the tool in the context menu when equipping via context menu.
_overrideActiveTool InteractionHandler The interaction handler to use instead of this tool as an interaction handler.
_gripPosesGenerated Bool Whether the Grip Pose Reference components and slots have been generated for this tool.
LocalTipOffset Float3 How much to offset the tooltip and its laser
LocalTipReference Slot The slot to use for the laser source and tip location.
UseLaser Bool Whether to enable the use of and visual of the Laser.
BlockPrimaryWhenTouching Bool blocks use of primary when the tooltip is touching a wall.
UseSecondary Bool Allow for use of secondary. When disabled on quest this disables the Tank Controls mode which many quest users in the resonite community dislike.
AllowUseWhenHolding Bool Allow use of the tool when the user is holding onto the tool rather than having it equipped.
Equipped Bool Whether the tool is equipped or not. This will still return true if the user is holding onto the tip. Commonly referred to as "Soft Equipping" or "Sudo Equipping".
ControllerType direct SyncType The Type (C# class) of the controller holding this tooltip.
ControllerSide Chirality Whether the left, right, or none controller is holding this tooltip.
PrimaryStrength raw output of Float The live updated value of the user's primary strength on this hand. Applies to VRcontrollers or game pad type controllers.
SecondaryAxis raw output of Float2 The position of the thumb on the track pad used for secondary on this hand.
Primary raw output of Bool Whether the user is pressing primary on this hand. See Controls
Secondary raw output of Bool Whether the user is pressing secondary on this hand. See Controls.
_primaryStrengthStream ValueStream`1<Float> The value stream of the primary strength value. This comes from a user's value streams which can be viewed through a User Inspector.
_secondaryAxisStream ValueStream`1<Float2> The value stream of the secondary strength value. This comes from a user's value streams which can be viewed through a User Inspector.
_primaryStream ValueStream`1<Bool> The value stream of the primary pressed value. This comes from a user's value streams which can be viewed through a User Inspector.
_secondaryStream ValueStream`1<Bool> The value stream of the secondary pressed value. This comes from a user's value streams which can be viewed through a User Inspector.
_rawStrength Float The Raw unfiltered value of the primary strength value.
_rawAxis Float2 the Raw unfiltered value of the secondary axis value.
_rawPrimary Bool the Raw unfiltered value of the primary pressed value.
_rawSecondary Bool the Raw unfiltered value of the secondary pressed value.
PrimaryActionDescription String sets the label that tells the user what primary on this tool does.
SecondaryActionDescription String sets the label that tells the user what secondary on this tool does.

Usage

Attach to a slot and this component will generate the needed slots for this tool to work. This component will need a collider in its slot hierarchy so the tool can be grabbed and used. Combining this tool with protoflux or Components is needed to add custom behavior.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


See Also