Automated: update Fields |
add info |
||
Line 4: | Line 4: | ||
}} | }} | ||
{{stub}} | {{stub}} | ||
For more info on the protoflux tool in general, see [[ProtoFlux]] | |||
== 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| | |TipReference|Slot| {{Template:ITool TipReference}} | ||
|BlockGripEquip|Bool| | |BlockGripEquip|Bool| {{Template:ITool BlockGripEquip}} | ||
|BlockRemoteEquip|Bool| | |BlockRemoteEquip|Bool| {{Template:ITool BlockRemoteEquip}} | ||
|EquipName|String| | |EquipName|String| {{Template:ITool EquipName}} | ||
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| | |_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}} | ||
|_gripPosesGenerated|Bool| | |_gripPosesGenerated|Bool| {{Template:ITool _gripPosesGenerated}} | ||
|SpawnNodeType|{{RootFieldType|SyncType}}|TypeAdv7=true| | |SpawnNodeType|{{RootFieldType|SyncType}}|TypeAdv7=true| The type of the ProtoFlux node to spawn. | ||
|WirePoint|Slot| | |WirePoint|Slot| The slot that the tool is currently pulling a wire out of. | ||
|MaxConnectDistance|Float| | |MaxConnectDistance|Float| The distance this protoflux tool will search for nodes from it's tip before stopping. it's usually 20 meters in local space. | ||
|SelectionProgress|Float| | |SelectionProgress|Float| How far the user is to selecting nodes by holding [[Controls|Secondary]] | ||
|HoveringElementName|String| | |HoveringElementName|String| The name of the protoflux element this tool is currently hovering over | ||
|HoveringElementContentType|{{RootFieldType|SyncType}}|TypeAdv12=true| | |HoveringElementContentType|{{RootFieldType|SyncType}}|TypeAdv12=true| The type of the protoflux element this tool is currently hovering over | ||
|HoveringElementColor|ColorX| | |HoveringElementColor|ColorX| The color of <code>HoveringElementContentType</code> | ||
|_selectedNodes|{{RootFieldType|SyncRefList`1|[[Component:ProtoFluxNodeVisual|ProtoFluxNodeVisual]]}}|TypeAdv14=true| | |_selectedNodes|{{RootFieldType|SyncRefList`1|[[Component:ProtoFluxNodeVisual|ProtoFluxNodeVisual]]}}|TypeAdv14=true| The list of nodes the protoflux nodes that the tool currently has selected. | ||
|_wirePointPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv15=true| | |_wirePointPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv15=true| What field to drive on a [[Component:StripeMesh|StripeMesh]] for a currently pulled wire. | ||
|_text|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv16=true| | |_text|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv16=true| The text to drive with information from this tool. | ||
|_currentProxy|ProtoFluxElementProxy| | |_currentProxy|ProtoFluxElementProxy| What element the protoflux tool is currently pulling in order to connect to another element via the UI. | ||
|_currentTempWire|Slot| | |_currentTempWire|Slot| The current wire that this tool is pulling from a protoflux connector. | ||
|_currentCutLine|Slot| | |_currentCutLine|Slot| The current wire that this tool is trying to cut. | ||
|_cutLineScale|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv20=true| | |_cutLineScale|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv20=true| The current wire that this tool is trying to cut's scale. | ||
|_cutLineOrientation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv21=true| | |_cutLineOrientation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv21=true| The orientation of the current wire that this tool is trying to cut. | ||
|_currentHighlightedNode|'''[[Component:ProtoFluxNodeVisual|ProtoFluxNodeVisual]]'''|TypeAdv22=true| | |_currentHighlightedNode|'''[[Component:ProtoFluxNodeVisual|ProtoFluxNodeVisual]]'''|TypeAdv22=true| The current node this tool is looking at. | ||
}} | }} | ||
Line 37: | Line 38: | ||
== See Also == | == See Also == | ||
[[ProtoFlux]] | |||
[[Category:Components:Tools{{#translation:}}|Proto Flux Tool]] | [[Category:Components:Tools{{#translation:}}|Proto Flux Tool]] | ||
[[Category:Components{{#translation:}}|Proto Flux Tool]] | [[Category:Components{{#translation:}}|Proto Flux Tool]] | ||
Latest revision as of 19:57, 19 October 2024
Component image
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
For more info on the protoflux tool in general, see ProtoFlux
Usage
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. |
SpawnNodeType
|
direct SyncType | The type of the ProtoFlux node to spawn. |
WirePoint
|
Slot | The slot that the tool is currently pulling a wire out of. |
MaxConnectDistance
|
Float | The distance this protoflux tool will search for nodes from it's tip before stopping. it's usually 20 meters in local space. |
SelectionProgress
|
Float | How far the user is to selecting nodes by holding Secondary |
HoveringElementName
|
String | The name of the protoflux element this tool is currently hovering over |
HoveringElementContentType
|
direct SyncType | The type of the protoflux element this tool is currently hovering over |
HoveringElementColor
|
ColorX | The color of HoveringElementContentType
|
_selectedNodes
|
list of ProtoFluxNodeVisual | The list of nodes the protoflux nodes that the tool currently has selected. |
_wirePointPosition
|
field drive of Float3 | What field to drive on a StripeMesh for a currently pulled wire. |
_text
|
TextRenderer | The text to drive with information from this tool. |
_currentProxy
|
ProtoFluxElementProxy | What element the protoflux tool is currently pulling in order to connect to another element via the UI. |
_currentTempWire
|
Slot | The current wire that this tool is pulling from a protoflux connector. |
_currentCutLine
|
Slot | The current wire that this tool is trying to cut. |
_cutLineScale
|
field drive of Float3 | The current wire that this tool is trying to cut's scale. |
_cutLineOrientation
|
field drive of FloatQ | The orientation of the current wire that this tool is trying to cut. |
_currentHighlightedNode
|
ProtoFluxNodeVisual | The current node this tool is looking at. |