Component:ColorTool

CollapseComponent image 

Color Tool component as seen in the Scene Inspector

Color tool is a component that drives the color tool from Tools. Pressing Secondary allows for picking a color via raycast, and hitting Primary allows for setting the color of a material.

Usage

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.
Color	ColorX	The selected color for this tool.
EnsureUniqueMaterial	Bool	Creates a new material rather than changing the color of the material of a target object when hitting Primary.
ColorIndicators	list of FieldDrive`1<ColorX>	The field to drive to the current picked color. used for an indicator.
_colorDialog	direct SlotCleanupRef`1<ColorDialogInterface>	The currently open color picker dialogue.

Sync Delegates

Triggers Collapse

Method Name	Method type and Arguments.	Is the method hidden?	Description
OpenColorDialog:ButtonEventHandler	ButtonEventHandler	✓	Handles spawning the user's favorite color picker so they can edit this tool's color.

Examples

Can be used to pick colors from surfaces, or it can be used to quickly color objects.