💡 Light
A Light represents a Lighting source.
💂Authority
👪Inheritance
This class inherits from Base Actor .
🎒 Examples
local my_light = Light(
Vector(-152, 245, 115),
Rotator(0, 90, 90), -- Relevant only for Rect and Spot light types
Color(1, 0, 0), -- Red Tint
LightType.Point, -- Point Light type
100, -- Intensity
250, -- Attenuation Radius
44, -- Cone Angle (Relevant only for Spot light type)
0, -- Inner Cone Angle Percent (Relevant only for Spot light type)
5000, -- Max Draw Distance (Good for performance - 0 for infinite)
true, -- Whether to use physically based inverse squared distance falloff, where Attenuation Radius is only clamping the light's contribution. (Spot and Point types only)
true, -- Cast Shadows?
true -- Enabled?
)
🏗️ Constructor
local my_light = Light(location?, rotation?, color?, light_type?, intensity?, attenuation_radius?, cone_angle?, inner_cone_angle_percent?, max_daw_distance?, use_inverse_squared_falloff?, cast_shadows?, visible?)
| Type | Name | Default | Description |
|---|---|---|---|
| Vector | location | Vector(0, 0, 0) | |
| Rotator | rotation | Rotator(0, 0, 0) | Relevant only for Rect and Spot LightTypes |
| Color | color | Color(1, 1, 1) | |
| LightType | light_type | LightType.Point | |
| number | intensity | 30 | |
| number | attenuation_radius | 250 | |
| number | cone_angle | 44 | Relevant only for Spot LightType |
| number | inner_cone_angle_percent | 0 | Inner Cone Angle Percent (Relevant only for Spot LightType) (0-1) |
| number | max_daw_distance | 5000 | Max Draw Distance (Good for performance) - 0 for infinite |
| boolean | use_inverse_squared_falloff | true | Whether to use physically based inverse squared distance falloff, where Attenuation Radius is only clamping the light's contribution. (Spot and Point types only) |
| boolean | cast_shadows | true | |
| boolean | visible | true |
tip
nanos world provides 3 types of lights: Spot, Point and Rect. All lights are Dynamic and because of that, very expensive! Keep that in mind before spawning 1000 lights 😉.
🦠 Functions
Inherited Actor Functions
Base Actorscripting-reference/classes/base-classes/actor
| Returns | Name | Description | |
|---|---|---|---|
 | AddImpulse | Applies a force in world world to this Actor | |
| | AttachTo | Attaches this Actor to any other Actor, optionally at a specific bone | |
| | Destroy | Destroys this Actor | |
| | Detach | Detaches this Actor from AttachedTo Actor | |
| | SetCollision | Sets this Actor's collision type | |
| | SetForce | Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel | |
| | SetGravityEnabled | Sets whether gravity is enabled on this Actor | |
 | SetVisibility | Sets whether the actor is visible or not | |
 | SetHighlightEnabled | Sets whether the highlight is enabled on this Actor, and which highlight index to use | |
| | SetOutlineEnabled | Sets whether the outline is enabled on this Actor, and which outline index to use | |
| | SetLifeSpan | Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed. | |
| | SetLocation | Sets this Actor's location in the game world | |
| | SetRotation | Sets this Actor's rotation in the game world | |
| | SetRelativeLocation | Sets this Actor's relative location in local space (only if this actor is attached) | |
| | SetRelativeRotation | Sets this Actor's relative rotation in local space (only if this actor is attached) | |
| | SetScale | Sets this Actor's scale | |
 | SetNetworkAuthority | Sets the Player to have network authority over this Actor | |
| | SetValue | Sets a value in this Actor | |
| | TranslateTo | Smoothly moves this actor to a location over a certain time | |
| | RotateTo | Smoothly rotates this actor to an angle over a certain time | |
| | boolean | IsBeingDestroyed | Returns true if this Actor is being destroyed |
| | boolean | IsVisible | Returns true if this Actor is visible |
| | boolean | IsGravityEnabled | Returns true if gravity is enabled on this Actor |
| | boolean | IsInWater | Returns true if this Actor is in water |
| | boolean | IsNetworkDistributed | Returns true if this Actor is currently network distributed |
| | boolean | IsValid | Returns true if this Actor is valid (i.e. wasn't destroyed and points to a valid Actor) |
| | table of Base Actor | GetAttachedEntities | Gets all Actors attached to this Actor |
| | Base Actor or nil | GetAttachedTo | Gets the Actor this Actor is attached to |
| | table | GetBounds | Gets this Actor's bounds |
| | CollisionType | GetCollision | Gets this Actor's collision type |
| | number | GetID | Gets the universal network ID of this Actor (same on both client and server) |
| | Vector | GetLocation | Gets this Actor's location in the game world |
| | Rotator | GetRotation | Gets this Actor's angle in the game world |
| | Vector | GetForce | Gets this Actor's force (set by SetForce()) |
| | boolean | HasNetworkAuthority | Returns true if the local Player is currently the Network Authority of this Actor |
| | boolean | HasAuthority | Gets if this Actor was spawned by the client side |
| | Vector | GetScale | Gets this Actor's scale |
| | string | GetType | Gets the type of this Actor |
| | any | GetValue | Gets a value stored on this Actor at the given key. Please refer to Entity Values for more information |
| | Vector | GetVelocity | Gets this Actor's current velocity |
| | AddActorTag | Adds an Unreal Actor Tag to this Actor | |
| | RemoveActorTag | Removes an Unreal Actor Tag from this Actor | |
| | table of string | GetActorTags | Gets all Unreal Actor Tags on this Actor |
| | function | Subscribe | Subscribes to an Event |
| | Unsubscribe | Unsubscribes all callbacks from this Event in this Actor within this Package, or only the callback passed |
| Returns | Name | Description | |
|---|---|---|---|
| | SetColor | Sets the light color | |
| | SetTextureLightProfile | Sets the light Texture Profile | |
| | SetCastShadows | ||
| | SetIntensity | ||
| | SetAttenuationRadius | ||
| | boolean | GetCastShadows | |
| | number | GetIntensity | |
| | number | GetAttenuationRadius | |
| | Color | GetColor |
SetColor
Sets the light color
my_light:SetColor(color)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Color | color | The light color |
SetTextureLightProfile
Sets the light Texture Profile
my_light:SetTextureLightProfile(light_profile)
| Type | Parameter | Default | Description |
|---|---|---|---|
| LightProfile | light_profile | The Light Profile to use |
SetCastShadows
my_light:SetCastShadows(is_shadows_enabled)
| Type | Parameter | Default | Description |
|---|---|---|---|
| boolean | is_shadows_enabled |
SetIntensity
my_light:SetIntensity(intensity)
| Type | Parameter | Default | Description |
|---|---|---|---|
| number | intensity |
SetAttenuationRadius
my_light:SetAttenuationRadius(attenuation_radius)
| Type | Parameter | Default | Description |
|---|---|---|---|
| number | attenuation_radius |
GetCastShadows
Returns boolean ()
local ret = my_light:GetCastShadows()
GetIntensity
Returns number ()
local ret = my_light:GetIntensity()
GetAttenuationRadius
Returns number ()
local ret = my_light:GetAttenuationRadius()
GetColor
Returns Color ()
local ret = my_light:GetColor()
🚀 Events
Inherited Actor Events
Base Actorscripting-reference/classes/base-classes/actor
| Name | Description | |
|---|---|---|
| | Destroy | Triggered when an Actor is destroyed |
| | Spawn | Triggered when an Actor is spawned/created |
| | ValueChange | Triggered when an Actor has a value changed with :SetValue() |
💡 Light Profiles
Light Profiles are texture files which describes a light's distribution from a light source using real world measured data.
tip
Please check Unreal Engine Light Profile documentation for more information about Light Profiles!
nanos world provides 50 Light Profiles included in the base game which you can use to enhance your Lights. You can set them using :SetTextureLightProfile() with the enum LightProfile.
