Verse API reference page for the customizable_light_device class
Used to create a light which can have its color and brightness manipulated in response to in-game events.
Verse using statement |
using { /Fortnite.com/Devices } |
Inheritance Hierarchy
This class is derived from the following hierarchy, starting with creative_object:
| Name | Description |
|---|---|
creative_object |
Base class for creative devices and props. |
creative_device_base |
Base class for creative_device. |
Members
This class has functions, but no data members.
Functions
| Function Name | Description |
|---|---|
DimLight |
Dims the light by Dimming Amount. |
Disable |
Disables this device. |
Enable |
Enables this device. |
GetGlobalTransform |
Gets the global transform of this object. |
GetTransform |
Returns the transform of the creative_object with units in cm. You must check creative_object.IsValid before calling this if there is a possibility the object has been disposed or destroyed by gameplay. Otherwise a runtime error will result. |
MoveTo |
Moves the creative_object to the specified Position and Rotation over the specified time, in seconds. If an animation is currently playing on the creative_object it will be stopped and put into the AnimationNotSet state. |
MoveTo |
Moves the creative_object to the specified Transform over the specified time, in seconds. If an animation is currently playing on the creative_object it will be stopped and put into the AnimationNotSet state. |
MoveTo |
Moves the creative_device to the specified Transform over the specified time, in seconds. If an animation is currently playing on the creative_device it will be stopped and put into the AnimationNotSet state. |
Reset |
Resets the light to its initial state. |
SetGlobalTransform |
Sets the global transform of this object. |
TeleportTo |
Teleports the creative_object to the specified Position and Rotation. |
TeleportTo |
Teleports the creative_object to the specified location defined by Transform, also applies rotation and scale accordingly. |
TeleportTo |
Teleports the creative_device to the specified location defined by Transform, also applies rotation and scale accordingly. |
Toggle |
Toggles between TurnOn and TurnOff. |
TurnOff |
Turns off the light. |
TurnOn |
Turns on the light. |
UndimLight |
Brightens the light by Dimming Amount. |