Component:ProtoFluxTool

CollapseComponent image 

Proto Flux Tool component as seen in the Scene Inspector

For more info on the protoflux tool in general, see ProtoFlux and ProtoFlux Tool.

Fields

Fields Collapse

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.
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.

Sync Delegates

Triggers Collapse

Method Name	Method type and Arguments.	Is the method hidden?	Description
ToggleOverviewMode:ButtonEventHandler	ButtonEventHandler	✓	Called when the toggle overview mode button is touched.
OnPackInPlace:ButtonEventHandler`1<ProtoFluxNode>	ButtonEventHandler`1<ProtoFluxNode>	✓	Called when the pack in place button is touched.
OnUnpack:ButtonEventHandler`1<Slot>	ButtonEventHandler`1<Slot>	✓	Called when the unpack button is touched.
OnClearSelection:ButtonEventHandler	ButtonEventHandler	✓	Called when the clear selection button is touched.
OpenNodeBrowser:ButtonEventHandler	ButtonEventHandler	✓	Called when the open node browser button is touched.
OnCreateDrive:ButtonEventHandler`1<IWorldElement>	ButtonEventHandler`1<IWorldElement>	✓	Called when the create drive button is touched.
OnCreateWrite:ButtonEventHandler`1<IWorldElement>	ButtonEventHandler`1<IWorldElement>	✓	Called when the create write button is touched.
OnCreateLocal:ButtonEventHandler`1<ProtoFluxReferenceProxy>	ButtonEventHandler`1<ProtoFluxReferenceProxy>	✓	Called when the create local button is touched.
OnCreateStore:ButtonEventHandler`1<ProtoFluxReferenceProxy>	ButtonEventHandler`1<ProtoFluxReferenceProxy>	✓	Called when the create store button is touched.
OnCreateDataModelStore:ButtonEventHandler`1<ProtoFluxReferenceProxy>	ButtonEventHandler`1<ProtoFluxReferenceProxy>	✓	Called when the create data model store button is touched.
OnCreateSource:ButtonEventHandler`1<IWorldElement>	ButtonEventHandler`1<IWorldElement>	✓	Called when the create source button is touched.
OnCreateReference:ButtonEventHandler`1<IWorldElement>	ButtonEventHandler`1<IWorldElement>	✓	Called when the create reference button is touched.
OnCreateDelegateProxy:ButtonEventHandler`1<Delegate>	ButtonEventHandler`1<Delegate>	✓	Called when the create delegate proxy button is touched.

See Also

• ProtoFlux
• ProtoFlux Tool