Component:LightTool

Component image 

Light Tool component as seen in the Scene Inspector

The LightTool component can be best learned through its page, the Light Tool for non power users.

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. 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.
LightMode	Mode	See Mode.
Color	ColorX	The color to make new lights.
Intensity	Float	The intensity to make new lights.
ShadowType	ShadowType	The shadow type to make new lights.
ShadowStrength	Float	The strength for the shadows new lights should have.
Range	Float	The range of new lights.
SpotAngle	Float	The spot angle of new lights.
PointLightVisual	Slot	The current point light visual root.
SpotlightVisual	Slot	The current spot light visual root.
DirectionalLightVisual	Slot	The current directional light visual root.
ColorIndicators	list of FieldDrive`1<ColorX>	A list of color fields to drive with the indication color.
ShowGizmo	Bool	Whether to show the Gizmo of new lights.
_pointLightItem	Item	Legacy don't use.
_spotLightItem	Item	Legacy don't use.
_directionalLightItem	Item	Legacy don't use.
_shadowsItem	Item	Legacy don't use.
_colorPicker	direct SlotCleanupRef`1<ColorDialogInterface>	The current color picker being used to pick the color for Color.

Mode

Values

Name	Value	Description
PointLight	0	Point light mode will let you create point light orbs by clicking primary.
Spotlight	1	Spot will allow you to create spot light cones by clicking primary.
MoveSun	2	Sun will allow you to move the sun to where you are currently clicking in the sky.

Usage

See Light Tool.

See Also

• Light Tool