💡 Light
A Light represents a Lighting source.
💂Authority
👪Inheritance
This class shares methods and events from Base Entity, Base Actor.
🧑💻API Source
The methods, properties and events descriptions from this page are defined in our GitHub API Repository!
🎒 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?
)
🛠 Constructors
Default 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 | ||
| Rotator | rotation | Rotator(0, 0, 0) | Relevant only for Rect and Spot LightTypes |
| Color | color | Color(1, 1, 1) | |
| LightType | light_type | LightType.Point | |
| float | intensity | 30 | |
| float | attenuation_radius | 250 | |
| float | cone_angle | 44 | Relevant only for Spot LightType |
| float | inner_cone_angle_percent | 0 | Inner Cone Angle Percent (Relevant only for Spot LightType) (0-1) |
| float | 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 😉.
🗿 Static Functions
Inherited Entity Static Functions
Base Entityscripting-reference/classes/base-classes/Entity
| Returns | Name | Description | |
|---|---|---|---|
 | table of Base Entity | GetAll | Returns a table containing all Entities of the class this is called on |
| Base Entity | GetByIndex | Returns a specific Entity of this class at an index |
| integer | GetCount | Returns how many Entities of this class exist |
| table of table | GetInheritedClasses | Gets a list of all directly inherited classes from this Class created with the Inheriting System |
| iterator | GetPairs | Returns an iterator with all Entities of this class to be used with pairs() |
| table or nil | GetParentClass | Gets the parent class if this Class was created with the Inheriting System |
| table | Inherit | Inherits this class with the Inheriting System |
| boolean | IsChildOf | Gets if this Class is child of another class if this Class was created with the Inheriting System |
| function | Subscribe | Subscribes to an Event for all entities of this Class |
| function | SubscribeRemote | Subscribes to a custom event called from server |
| Unsubscribe | Unsubscribes all callbacks from this Event in this Class within this Package, or only the callback passed |
🦠 Functions
Inherited Entity Functions
Base Entityscripting-reference/classes/base-classes/Entity
| Returns | Name | Description | |
|---|---|---|---|
 | BroadcastRemoteEvent | Calls a custom remote event directly on this entity to all Players | |
| CallRemoteEvent | Calls a custom remote event directly on this entity to a specific Player | |
 | CallRemoteEvent | Calls a custom remote event directly on this entity | |
 | Destroy | Destroys this Entity | |
| table | GetClass | Gets the class of this entity |
| integer | GetID | Gets the universal network ID of this Entity (same on both client and server) |
| any | GetValue | Gets a Value stored on this Entity at the given key |
| boolean | IsA | Recursively checks if this entity is inherited from a Class |
| boolean | IsValid | Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity) |
| SetValue | Sets a Value in this Entity | |
| function | Subscribe | Subscribes to an Event on this specific entity |
| function | SubscribeRemote | Subscribes to a custom event called from server on this specific entity |
| Unsubscribe | Unsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed |
Inherited Actor Functions
Base Actorscripting-reference/classes/base-classes/Actor
| Returns | Name | Description | |
|---|---|---|---|
| AddActorTag | Adds an Unreal Actor Tag to this Actor | |
 | AddImpulse | Applies a force in world world to this Actor | |
| AttachTo | Attaches this Actor to any other Actor, optionally at a specific bone | |
| Detach | Detaches this Actor from AttachedTo Actor | |
| table of string | GetActorTags | Gets all Unreal Actor Tags on this 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 |
| integer | GetDimension | Gets this Actor's dimension |
| float | GetDistanceFromCamera | Gets the distance of this Actor from the Camera |
| Vector | GetForce | Gets this Actor's force (set by SetForce()) |
| Vector | GetLocation | Gets this Actor's location in the game world |
| Player or nil | GetNetworkAuthority | Gets this Actor's Network Authority Player |
| Vector | GetRelativeLocation | Gets this Actor's Relative Location if it's attached |
| Rotator | GetRelativeRotation | Gets this Actor's Relative Rotation if it's attached |
| Rotator | GetRotation | Gets this Actor's angle in the game world |
| Vector | GetScale | Gets this Actor's scale |
| float | GetScreenPercentage | Gets the percentage of this Actor size in the screen |
| Vector | GetVelocity | Gets this Actor's current velocity |
| boolean | HasAuthority | Gets if this Actor was spawned by the client side |
| boolean | HasNetworkAuthority | Returns true if the local Player is currently the Network Authority of this Actor |
| boolean | IsBeingDestroyed | Returns true if this Actor is being destroyed |
| 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 | IsVisible | Returns true if this Actor is visible |
| RemoveActorTag | Removes an Unreal Actor Tag from this Actor | |
| RotateTo | Smoothly rotates this actor to an angle over a certain time | |
| SetCollision | Sets this Actor's collision type | |
| SetDimension | Sets this Actor's Dimension | |
| 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 | |
| SetHighlightEnabled | Sets whether the highlight is enabled on this Actor, and which highlight 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 | |
| SetNetworkAuthority | Sets the Player to have network authority over this Actor | |
| SetNetworkAuthorityAutoDistributed | Sets if this Actor will auto distribute the network authority betwen players | |
| SetOutlineEnabled | Sets whether the outline is enabled on this Actor, and which outline index to use | |
| 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) | |
| SetRotation | Sets this Actor's rotation in the game world | |
| SetScale | Sets this Actor's scale | |
| SetVisibility | Sets whether the actor is visible or not | |
| TranslateTo | Smoothly moves this actor to a location over a certain time | |
| boolean | WasRecentlyRendered | Gets if this Actor was recently rendered on screen |
| Returns | Name | Description | |
|---|---|---|---|
| float | GetAttenuationRadius | |
| boolean | GetCastShadows | |
| Color | GetColor | |
| float | GetIntensity | |
| SetAttenuationRadius | ||
| SetCastShadows | ||
| SetColor | Sets the light color | |
| SetIntensity | ||
| SetTextureLightProfile | Sets the light Texture Profile |
GetAttenuationRadius
— Returns float.
local ret = my_light:GetAttenuationRadius()
See also SetAttenuationRadius.
GetCastShadows
— Returns boolean.
local ret = my_light:GetCastShadows()
See also SetCastShadows.
GetColor
— Returns Color.
local ret = my_light:GetColor()
See also SetColor.
GetIntensity
— Returns float.
local ret = my_light:GetIntensity()
See also SetIntensity.
SetAttenuationRadius
my_light:SetAttenuationRadius(attenuation_radius)
| Type | Parameter | Default | Description |
|---|---|---|---|
| float | attenuation_radius |
See also GetAttenuationRadius.
SetCastShadows
my_light:SetCastShadows(is_shadows_enabled)
| Type | Parameter | Default | Description |
|---|---|---|---|
| boolean | is_shadows_enabled |
See also GetCastShadows.
SetColor
Sets the light color
my_light:SetColor(color)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Color | color | The light color |
See also GetColor.
SetIntensity
my_light:SetIntensity(intensity)
| Type | Parameter | Default | Description |
|---|---|---|---|
| float | intensity |
See also GetIntensity.
SetTextureLightProfile
Sets the light Texture Profile
my_light:SetTextureLightProfile(light_profile)
| Type | Parameter | Default | Description |
|---|---|---|---|
| LightProfile | light_profile | The Light Profile to use |
See also 💡 Light Profiles.
🚀 Events
Inherited Entity Events
Base Entityscripting-reference/classes/base-classes/Entity
| Name | Description | |
|---|---|---|
| ClassRegister | Triggered when a new Class is registered with the Inheriting System |
| Destroy | Triggered when an Entity is destroyed |
| Spawn | Triggered when an Entity is spawned/created |
| ValueChange | Triggered when an Entity has a value changed with :SetValue() |
Inherited Actor Events
Base Actorscripting-reference/classes/base-classes/Actor
| Name | Description | |
|---|---|---|
| ClassRegister | Triggered when a new Class is registered with the Inheriting System |
| Destroy | Triggered when an Entity is destroyed |
| Spawn | Triggered when an Entity is spawned/created |
| ValueChange | Triggered when an Entity 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.
