Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

LocalLightProps

Property Type Default value Description
color? ColorRepresentation white, #ffffff, as three’s point light The light’s colour: a CSS colour, a number, or a Color the game may change in place.
decay? number 2 How fast its light falls off with distance, as three’s point light’s decay: 2 is the physical inverse square.
distance? number 0 Metres past which it lights nothing, as three’s point light’s distance; 0 for no cut-off, where its light fades with decay alone.
intensity? number 1 As three’s point light’s intensity, in candela: 0 or more. 0 puts the light out for a while and frees its place in the pool.
position? Vector3Tuple [0, 0, 0] Metres from the object it is mounted under, in that object’s own axes, such as a lantern’s flame above its base.