Component:DevTool: Difference between revisions

Revision as of 20:18, 12 January 2025

Component image

**Dev Tool** component as seen in the Scene Inspector

Detailed information can be located at Dev Tool.

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. Some components stop their functionality when this field is disabled, but some don't.
`_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	See Interaction section.
`_selectedAnchor`	PointAnchor	The point anchor which is part of a gizmo this tool is moving currently.
`_selectedAnchorHighlight`	Slot	The slot being used to indicate what gizmo is currently being moved. Is an icosphere.
`_material`	reference drive of OverlayFresnelMaterial	The visual material used for the default cone mesh.
`_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

Lua error in mw.text.lua at line 25: bad argument #1 to 'match' (string expected, got nil).

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description

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.

Interaction

Interaction: What gizmo transformation should be relative to:
- Tip: Gizmo transformation is relative to the tool's tip.
- Projection: Gizmo transformation is relative to the projected point.

Examples

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.

@@ Line 5: / Line 5: @@
 Detailed information can be located at [[Dev Tool]].
-== Usage ==
+== Fields ==
 {{Table ComponentFields
 |_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true| {{Template:ITool _equipLink}}
@@ Line 14: / Line 14: @@
 |_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}}
 |_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|See [[#Interaction|Interaction section]].
-|_selectedAnchor|'''[[Component:PointAnchor|PointAnchor]]'''|TypeAdv9=true|
+|_selectedAnchor|'''[[Component:PointAnchor|PointAnchor]]'''|TypeAdv9=true| The point anchor which is part of a gizmo this tool is moving currently.
-|_selectedAnchorHighlight|Slot|
+|_selectedAnchorHighlight|Slot| The slot being used to indicate what gizmo is currently being moved. Is an icosphere.
-|_material|{{RootFieldType|DriveRef`1|[[OverlayFresnelMaterial|OverlayFresnelMaterial]]}}|TypeAdv11=true|
+|_material|{{RootFieldType|DriveRef`1|[[OverlayFresnelMaterial|OverlayFresnelMaterial]]}}|TypeAdv11=true| The visual material used for the default cone mesh.
 |_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.
@@ Line 25: / Line 25: @@
 == Sync Delegates ==
 {{Table ComponentTriggers
-|SelectParent()|[[Type:Action|Action]]|
+|SelectParent()|[[Type:Action|Action]]| Switches the gizmo to the parent Slot, and deletes the old gizmo.
-|ToggleSpace()|[[Type:Action|Action]]|
+|ToggleSpace()|[[Type:Action|Action]]| toggles the gizmo orientation between global and local.
-|SetTranslation()|[[Type:Action|Action]]|
+|SetTranslation()|[[Type:Action|Action]]| Sets the currently targeted gizmo to Translation
-|SetRotation()|[[Type:Action|Action]]|
+|SetRotation()|[[Type:Action|Action]]| Sets the currently targeted gizmo to rotation.
-|SetScale()|[[Type:Action|Action]]|
+|SetScale()|[[Type:Action|Action]]| Sets the currently targeted gizmo to scaling.
 }}
@@ Line 35: / Line 35: @@
 {{Template:DevTool_Selection}}
-== Behavior ==
+== Interaction ==
-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.
+{{Template:DevTool_Interaction}}
 == Examples ==
+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.
 == See Also ==
@@ Line 45: / Line 46: @@
 [[Category:Components{{#translation:}}|Dev Tool]]
 [[Category:Components With Nested Enums{{#translation:}}|Dev Tool]]
-[[Category:ComponentStubs]]