💡 Light

A Light represents a Lighting source.

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 ;).

tip

You can spawn this entity is both Client or Server (if you spawn it on client, it won’t be synchronized with other players).

info

⏬ Inheritance: This class inherits from Actor. Please check it's pages for inherited Methods and Events.

Usage

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 Parameters

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	enabled	true

Functions

Inherited Actor Functions

Base Actorscripting-reference/classes/base-classes/actor

	Returns	Name	Description
		AddImpulse	Applies a Force in world coordinate on this Actor
		AttachTo	Attaches this Actor to any other Actor
		Destroy	Destroys this Actor
		Detach	Detaches this Actor if attached
		SetCollision	Sets the actor’s collision type
		SetForce	Adds a permanent force to this actor
		SetGravityEnabled	Sets the actor’s gravity enabled
		SetHighlightEnabled	Enables this Actor Highlighting at a specific Index color
		SetLifeSpan	Sets the actor’s life span to be destroyed
		SetLocation	Sets the actor’s location in the game world
		SetNetworkAuthority	Sets this actor’s new Player Network Authority
		SetRelativeLocation	Sets the actor’s relative location in local space
		SetRelativeRotation	Sets the actor’s relative rotation in local space
		SetRotation	Sets the actor’s rotation in the game world
		SetScale	Sets the actor’s scale
		SetValue	Sets a value in this entity, which can be accessed by any package
		TranslateTo	Smoothly moves this actor to a Location
		RotateTo	Smoothly rotates this actor to a Rotation
	boolean	IsGravityEnabled	Gets the actor’s gravity enabled
	boolean	IsInWater	Gets if the actor is in Water
	boolean	IsNetworkDistributed	Gets if the actor is Network Distributed
	boolean	IsValid	Returns if this entity is valid (i.e. not destroyed)
	table	GetAttachedEntities	Gets all actors attached to this entity
	any	GetAttachedTo	Gets the actor this actor is attached to
	table	GetBounds	Gets the actor bounds size
	number	GetCollision	Gets the current actor’s collision
	number	GetID	Gets the universal network ID of this entity
	Vector	GetLocation	Get the actor’s position in the game world
	Vector	GetInitialLocation	Gets the initial location
	Rotator	GetRotation	Gets the actor’s rotation in the game world
	Vector	GetScale	Gets the actor’s scale
	string	GetType	Returns the type of this Actor
	any	GetValue	Gets a value given a key
	Vector	GetVelocity	Returns the current actor Velocity
		Subscribe	Subscribes for an Event
		Unsubscribe	Unsubscribes from Events

Returns	Name	Description
	SetColor	Sets the light color

SetColor

Sets the light color

my_light:SetColor(color)

Type	Parameter	Default Value	Description
Color	color		The light color

Events

Inherited Actor Events

Base Actorscripting-reference/classes/base-classes/actor

	Name	Description
	Destroy	Triggered when an Entity is Destroyed
	Spawn	Triggered when an Entity is Spawned/Created
	ValueChange	Triggered when an Entity has it’s value changed