Component:ToolMultiplexer: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
Add some info
Line 4: Line 4:
}}
}}
{{stub}}
{{stub}}
A Tool Multiplexer is a key component in almost every [[Tools#Multitool|multitool]] to ever exist. It handles the switching and usage of multiple tools, and allows all of them to act as one tool tip the user can equip, making multiple tool usage easier. Multitools can be assigned to the <code>Tools</code> list of other multitools.


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true|
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true|
|TipReference|Slot|
|TipReference|Slot|  
|BlockGripEquip|Bool|
|BlockGripEquip|Bool|
|BlockRemoteEquip|Bool|
|BlockRemoteEquip|Bool|
Line 14: Line 16:
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true|
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true|
|_gripPosesGenerated|Bool|
|_gripPosesGenerated|Bool|
|ActiveToolIndex|Int|
|ActiveToolIndex|Int| The tool that this tool tip is currently using
|Tools|{{RootFieldType|SyncRefList`1|[[Type:ITool|ITool]]}}|TypeAdv8=true|
|Tools|{{RootFieldType|SyncRefList`1|[[Type:ITool|ITool]]}}|TypeAdv8=true| A list of tools that this tool tip is to switch between using <code>ActiveToolIndex</code> as the one it should be currently using.
}}
}}


== Behavior ==
== Behavior ==
Curiously, the transform position of the slot of a tool listed in the <code>Tools</code> list and its tip transform position can cause the multitool's laser tip to move if that tool is selected. Putting all the tools used by the multitool under one slot and making sure their tip and tool roots are in the same transform place is the preferred way of making sure your tool tip laser position stays consistent.


== Examples ==
== Examples ==
From [[User:Ukilop|Uki's]] Redprint tip, to the default multitool in [[Resonite Essentials]] to H3's tool, this component is vital in a multitool, and what makes them function.


== See Also ==
== See Also ==

Revision as of 16:52, 17 October 2024

Component image 
Tool Multiplexer component as seen in the Scene Inspector


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


A Tool Multiplexer is a key component in almost every multitool to ever exist. It handles the switching and usage of multiple tools, and allows all of them to act as one tool tip the user can equip, making multiple tool usage easier. Multitools can be assigned to the Tools list of other multitools.


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>
TipReference Slot
BlockGripEquip Bool
BlockRemoteEquip Bool
EquipName String
_overrideActiveTool InteractionHandler
_gripPosesGenerated Bool
ActiveToolIndex Int The tool that this tool tip is currently using
Tools list of ITool A list of tools that this tool tip is to switch between using ActiveToolIndex as the one it should be currently using.

Behavior

Curiously, the transform position of the slot of a tool listed in the Tools list and its tip transform position can cause the multitool's laser tip to move if that tool is selected. Putting all the tools used by the multitool under one slot and making sure their tip and tool roots are in the same transform place is the preferred way of making sure your tool tip laser position stays consistent.

Examples

From Uki's Redprint tip, to the default multitool in Resonite Essentials to H3's tool, this component is vital in a multitool, and what makes them function.

See Also