Component:DevTool: Difference between revisions

From Resonite Wiki
template things, add some info
Automated: update DeDuplicate
 
(4 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|Name=Dev Tool
|Name=Dev Tool
}}
}}
See [[Dev Tool]].
Detailed information can be located at [[Dev Tool]].


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true|
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true| {{Template:ITool _equipLink}}
|TipReference|Slot| The slot that the laser should come out of.
|TipReference|Slot| {{Template:ITool TipReference}}
|BlockGripEquip|Bool| Whether to allow double gripping (legacy) to equip the tool
|BlockGripEquip|Bool| {{Template:ITool BlockGripEquip}}
|BlockRemoteEquip|Bool| Whether to allow clicking on a tool and clicking the equip button to equip the tool.
|BlockRemoteEquip|Bool| {{Template:ITool BlockRemoteEquip}}
|EquipName|String| Usually "Dev Tool"
|EquipName|String| {{Template:ITool EquipName}}
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true|
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}}
|_gripPosesGenerated|Bool| Whether the tool has it's left and right grip pose slots made.
|_gripPosesGenerated|Bool| {{Template:ITool _gripPosesGenerated}}
|SelectionMode|'''[[#Selection|Selection]]'''|TypeAdv7=true| See [[#Selection|Selection section]]
|SelectionMode|'''[[#Selection|Selection]]'''|TypeAdv7=true| See [[#Selection|Selection section]]
|InteractionMode|'''[[#Interaction|Interaction]]'''|TypeAdv8=true|  
|InteractionMode|'''[[#Interaction|Interaction]]'''|TypeAdv8=true|  
Line 21: Line 21:
|_currentGizmo|Slot| The gizmo that the dev tool is currently targeting for gizmo options.
|_currentGizmo|Slot| The gizmo that the dev tool is currently targeting for gizmo options.
|_previousGizmo|Slot| The previous gizmo that the dev tool targeted for gizmo options.
|_previousGizmo|Slot| The previous gizmo that the dev tool targeted for gizmo options.
}}
== Sync Delegates ==
{{Table ComponentTriggers
|SelectParent()|[[Type:Action|Action]]|
|ToggleSpace()|[[Type:Action|Action]]|
|SetTranslation()|[[Type:Action|Action]]|
|SetRotation()|[[Type:Action|Action]]|
|SetScale()|[[Type:Action|Action]]|
}}
}}


Line 27: Line 36:


== Behavior ==
== Behavior ==
The DevTool component can be used on it's own to create a [[Dev Tool|Developer Tool]] or be used in a [[Component:ToolMultiplexer|ToolMultiplexer]] to create a MultiTool.


== Examples ==
== Examples ==
Line 35: Line 45:
[[Category:Components{{#translation:}}|Dev Tool]]
[[Category:Components{{#translation:}}|Dev Tool]]
[[Category:Components With Nested Enums{{#translation:}}|Dev Tool]]
[[Category:Components With Nested Enums{{#translation:}}|Dev Tool]]
[[Category:ComponentStubs]]
[[Category:ComponentStubs]]

Latest revision as of 21:18, 6 November 2024

Component image 
Dev Tool component as seen in the Scene Inspector

Detailed information can be located at Dev Tool.

Usage

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.
SelectionMode Selection See Selection section
InteractionMode Interaction
_selectedAnchor PointAnchor
_selectedAnchorHighlight Slot
_material direct DriveRef`1<OverlayFresnelMaterial>
_currentGizmo Slot The gizmo that the dev tool is currently targeting for gizmo options.
_previousGizmo Slot The previous gizmo that the dev tool targeted for gizmo options.

Sync Delegates

Triggers
Name Arguments Description
SelectParent() Action
ToggleSpace() Action
SetTranslation() Action
SetRotation() Action
SetScale() Action

Selection

  • Selection: Sets the selection mode for the tool (select by using the secondary action):
    • Single: Select single object. Selecting an unselected object deselects any other selected object. Selecting a selected object unselects that object.
    • Multi: Select multiple objects. Selecting an unselected object adds that object to the selected objects. Selecting a selected object unselects that object.

Behavior

The DevTool component can be used on it's own to create a Developer Tool or be used in a ToolMultiplexer to create a MultiTool.

Examples

See Also