Controls the lighting and atmosphere of your island over time. You can fade in and out the device's visual effects, and toggle individual components like fog, sun, skylight, sky atmosphere, skybox, and clouds based on the device's override settings. Values set from Verse are sent to every player and replace the Details panel settings until the round ends, then the device returns to those settings. Set the look players should see at spawn in the Details panel and apply Verse changes in OnBegin.
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. |
Exposed Interfaces
This class exposes the following interfaces:
| Name | Description |
|---|---|
enableable |
Implemented by classes whose instances can be enabled and disabled. |
Members
This class has both data members and functions.
Data
| Data Member Name | Type | Description |
|---|---|---|
BlendDistance |
?float |
Maps to the device option for Blend Distance.Distance in centimeters from the volume boundary over which the settings are blended, from |
BlendMode |
?day_sequence_blend_mode |
Maps to the device option for Blending.How this device blends its settings at the volume boundary. Only used when |
BlendTime |
?float |
Maps to the device option for Blend Time.Time in seconds over which the settings are blended, from |
CloudCoverage |
?float |
Maps to the device option for Cloud Coverage.Cloud coverage from |
CloudDirectionX |
?float |
Maps to the device option for Cloud Direction X.X component of the direction in which the clouds move, from |
CloudDirectionY |
?float |
Maps to the device option for Cloud Direction Y.Y component of the direction in which the clouds move, from |
CloudLightColor |
?color |
Maps to the device option for Cloud Light Color.Color of the lit side of the clouds. A color with a |
CloudLightingBrightness |
?float |
Maps to the device option for Cloud Lighting Brightness.Unitless brightness of the cloud lighting, |
CloudOpacity |
?float |
Maps to the device option for Cloud Opacity.Opacity of the clouds from |
CloudShadowColor |
?color |
Maps to the device option for Cloud Shadow Color.Color of the shadowed side of the clouds. A color with a |
CloudSize |
?float |
Maps to the device option for Cloud Size.Unitless scale of the cloud shapes from |
CloudSpeed |
?float |
Maps to the device option for Cloud Speed.Unitless speed multiplier of the cloud movement, |
CustomSunColorBlend |
?float |
Maps to the device option for Custom Sun Color Blend.Blend between the default sun disc color and |
DayNightCycleMode |
?day_night_cycle_mode |
Maps to the device option for Day Night Cycle Mode.How this device controls the day/night cycle time. |
DayNightCycleTime |
?float |
Maps to the device option for Day Night Cycle Time.Time of day in hours from |
FadeSpeed |
?float |
Maps to the device option for Fade Speed.Unitless speed multiplier for |
FogColor |
?color |
Maps to the device option for Fog Color.Color of the fog. A color with a |
FogDensity |
?float |
Maps to the device option for Fog Density.Unitless density of the fog from |
FogDirectionalInscatteringColor |
?color |
Maps to the device option for Fog Directional Inscattering Color.Color of the fog inscattering towards the sun. A color with a |
FogHeightFalloff |
?float |
Maps to the device option for Fog Height Falloff.Unitless rate at which the fog density falls off with height, from |
FogMaxOpacity |
?float |
Maps to the device option for Fog Max Opacity.Maximum opacity of the fog from |
IsFogEnabled |
?logic |
Maps to the device option for Enable Fog Component.If |
IsSkyAtmosphereEnabled |
?logic |
Maps to the device option for Enable Sky Atmosphere Component.If |
IsSkyboxEnabled |
?logic |
Maps to the device option for Enable Skybox Component.If |
IsSkylightEnabled |
?logic |
Maps to the device option for Enable Skylight Component.If |
IsSunEnabled |
?logic |
Maps to the device option for Enable Sun Component.If |
IsSunFlareEnabled |
?logic |
Maps to the device option for Enable Sun Flare.If |
IsVolumeEnabled |
?logic |
Maps to the device option for Use Volume.If |
MoonColor |
?color |
Maps to the device option for Moon Color.Color of the moon in the sky. A color with a |
MoonHaloIntensity |
?float |
Maps to the device option for Moon Halo Intensity.Unitless intensity of the halo around the moon, |
MoonHaloSize |
?float |
Maps to the device option for Moon Halo Size.Unitless size of the halo around the moon, |
MoonIntensity |
?float |
Maps to the device option for Moon Intensity.Unitless intensity of the moon in the sky, |
MoonSize |
?float |
Maps to the device option for Moon Size.Unitless size of the moon in the sky from |
Priority |
?int |
Maps to the device option for Priority.Priority of this device relative to other Day Sequence devices. Settings of a device with a higher priority are applied on top of those with a lower priority. |
SecondaryFogDensity |
?float |
Maps to the device option for Secondary Fog Density.Unitless density of the secondary fog layer from |
SecondaryFogFalloff |
?float |
Maps to the device option for Secondary Fog Falloff.Unitless rate at which the secondary fog density falls off with height, from |
SecondaryFogOffset |
?float |
Maps to the device option for Secondary Fog Offset.Height offset of the secondary fog layer in centimeters, relative to the device. Setting it to |
ShouldOverrideCloud |
?logic |
Maps to the device option for Override Clouds.If |
ShouldOverrideFog |
?logic |
Maps to the device option for Override Fog.If |
ShouldOverrideSky |
?logic |
Maps to the device option for Override Sky.If |
ShouldOverrideSkylight |
?logic |
Maps to the device option for Override Skylight.If |
ShouldOverrideSunlight |
?logic |
Maps to the device option for Override Sunlight.If |
SkyGradientBlend |
?float |
Maps to the device option for Sky Gradient Blend.How strongly the sky gradient colors blend onto the sky, from |
SkyGradientHighColor |
?color |
Maps to the device option for Sky Gradient High Color.Color of the sky gradient at the zenith. A color with a |
SkyGradientLowColor |
?color |
Maps to the device option for Sky Gradient Low Color.Color of the sky gradient near the horizon. A color with a |
SkyGradientMidColor |
?color |
Maps to the device option for Sky Gradient Mid Color.Color of the sky gradient between the horizon and the zenith. A color with a |
SkylightColor |
?color |
Maps to the device option for Skylight Color.Color of the skylight. A color with a |
SkylightIntensity |
?float |
Maps to the device option for Skylight Intensity.Unitless intensity scale of the skylight, |
StarBrightness |
?float |
Maps to the device option for Star Brightness.Unitless brightness of the stars from |
SunColor |
?color |
Maps to the device option for Sun Color.Color of the sun disc in the sky. A color with a |
SunIntensity |
?float |
Maps to the device option for Sun Intensity.Unitless intensity of the sun disc in the sky, |
SunlightColor |
?color |
Maps to the device option for Sunlight Color.Color of the sunlight. A color with a |
SunlightIntensity |
?float |
Maps to the device option for Sunlight Intensity.Intensity of the sunlight in lux, |
SunlightRotationX |
?float |
Maps to the device option for Sunlight Rotation X.Rotation of the sunlight around the X axis in degrees. Values outside |
SunlightRotationZ |
?float |
Maps to the device option for Sunlight Rotation Z.Rotation of the sunlight around the Z axis in degrees. Values outside |
SunlightVolumetricScattering |
?float |
Maps to the device option for Sunlight Volumetric Scattering.Unitless intensity of the volumetric scattering of the sunlight in the fog, |
SunSize |
?float |
Maps to the device option for Sun Size.Unitless size of the sun disc in the sky, |
VolumeExtent |
?vector3 |
Maps to the device options Volume Extent X, Volume Extent Y and Volume Extent Z.Size of the trigger volume in centimeters along the Forward, Left and Up axes, |
Functions
| Function Name | Description |
|---|---|
AddTag |
Adds a |
ContainsAllTags |
Fails if at least one type in |
ContainsAnyTag |
Succeeds if at least one of the types in |
ContainsTag |
Succeeds if at least one tag of type |
Disable |
Disables this device. |
Enable |
Enables this device. |
FadeIn |
Fades in this device's visual effects at the speed set by |
FadeOut |
Fades out this device's visual effects at the speed set by |
GetGlobalTransform |
Gets the global transform of this object. |
GetTransform |
Returns the transform of the |
IsEnabled |
Succeeds if this device is enabled, fails if it's disabled. |
MoveTo |
Moves the |
MoveTo |
Moves the |
MoveTo |
Moves the |
RemoveAllTags |
Removes all tag instances of type |
RemoveAllTagsExcept |
Removes all tag instances that are not of type |
RemoveAllTagsExcept |
Removes all tag instances that are not of any of the types in |
RemoveTag |
Removes the tag instance associated with the |
SetGlobalTransform |
Sets the global transform of this object. |
TeleportTo |
Teleports the |
TeleportTo |
Teleports the |
TeleportTo |
Teleports the |