[Home](./index.md) > [server](./server.md) > [Light](./server.light.md) ## Light class Represents a light in a world. Lights can be point lights or spotlights. **Signature:** ```typescript export default class Light extends EventRouter implements protocol.Serializable ``` **Extends:** [EventRouter](./server.eventrouter.md) **Implements:** protocol.Serializable ## Remarks Lights are created directly as instances. They support a variety of configuration options through the [LightOptions](./server.lightoptions.md) constructor argument.

Events

This class is an EventRouter, and instances of it emit events with payloads listed under [LightEventPayloads](./server.lighteventpayloads.md) ## Example ```typescript const light = new Light({ attachedToEntity: playerEntity, color: { r: 255, g: 0, b: 0 }, intensity: 5, offset: { x: 0, y: 1, z: 0 }, }); light.spawn(world); ``` ## Constructors
Constructor Modifiers Description
[(constructor)(options)](./server.light._constructor_.md) Constructs a new instance of the `Light` class
## Properties
Property Modifiers Type Description
[angle](./server.light.angle.md) `readonly` number \| undefined If type is spotlight, the angle of the spotlight.
[attachedToEntity](./server.light.attachedtoentity.md) `readonly` [Entity](./server.entity.md) \| undefined The entity to which the Light is attached if explicitly set.
[color](./server.light.color.md) `readonly` [RgbColor](./server.rgbcolor.md) The color of the light.
[distance](./server.light.distance.md) `readonly` number \| undefined The maximum distance the light will illuminate. 0 does not limit distance. Defaults to 0.
[id](./server.light.id.md) `readonly` number \| undefined The unique identifier for the Light.
[intensity](./server.light.intensity.md) `readonly` number The intensity of the light in candela (cd). Defaults to 1
[isSpawned](./server.light.isspawned.md) `readonly` boolean Whether the Light is spawned into the world.
[offset](./server.light.offset.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined The offset of the light from the attached entity or position.
[penumbra](./server.light.penumbra.md) `readonly` number \| undefined If type is spotlight, the penumbra of the spotlight.
[position](./server.light.position.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined The position of the light in the world if explicitly set.
[trackedEntity](./server.light.trackedentity.md) `readonly` [Entity](./server.entity.md) \| undefined If type is spotlight, the entity the spotlight will constantly point at.
[trackedPosition](./server.light.trackedposition.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined If type is spotlight, the position the spotlight will constantly point at.
[type](./server.light.type.md) `readonly` [LightType](./server.lighttype.md) The type of light. Defaults to point light.
[world](./server.light.world.md) `readonly` [World](./server.world.md) \| undefined The world the Light is spawned into.
## Methods
Method Modifiers Description
[despawn()](./server.light.despawn.md) Despawns the Light from the world.
[setAngle(angle)](./server.light.setangle.md) Sets the angle of the spotlight if the light type is spotlight.
[setAttachedToEntity(entity)](./server.light.setattachedtoentity.md) Sets the entity to which the Light is attached.
[setColor(color)](./server.light.setcolor.md) Sets the color of the light.
[setDistance(distance)](./server.light.setdistance.md) Sets the maximum distance the light will illuminate.
[setIntensity(intensity)](./server.light.setintensity.md) Sets the intensity of the light.
[setOffset(offset)](./server.light.setoffset.md) Sets the offset of the light from the attached entity or position.
[setPenumbra(penumbra)](./server.light.setpenumbra.md) Sets the penumbra of the spotlight if the light type is spotlight.
[setPosition(position)](./server.light.setposition.md) Sets the position of the light.
[setTrackedEntity(entity)](./server.light.settrackedentity.md) Sets the entity the spotlight will constantly point at if the light type is spotlight.
[setTrackedPosition(position)](./server.light.settrackedposition.md) Sets the position the spotlight will constantly point at if the light type is spotlight.
[spawn(world)](./server.light.spawn.md) Spawns the Light into the world.