DocumentationBot: Version 1

2026-10-01T04:13:05Z

Version 1

New page

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|env_light|section}}

Place a light and optionally control it with scripts or a built-in effect.

Placement: Point.

== Set it up ==

Choose Point, Spot, or Area and set its colour and intensity. Area lights are baked only. Effects and scripts change Baked point/spot lights to Dynamic; Mixed retains baked indirect light. Use Map Environment for the sun. The color input accepts an HTML colour such as "#80c0ffff". The toggle output fires when the toggle input is received.

== Settings ==

These are the initial authoring values. Script inputs and runtime state are listed separately below.

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>light_type</code> Light type || Point (<code>2</code>) || Point, Spot or Area. Area lights are baked-only and cannot use effects or scripting. Choices: Point (<code>2</code>), Spot (<code>0</code>), Area (<code>3</code>).
|-
| <code>color</code> Color || <code>[1, 1, 1, 1]</code> || Value type: <code>color</code>.
|-
| <code>intensity</code> Intensity || <code>1</code> || Minimum: <code>0</code>. Maximum: <code>1000000</code>.
|-
| <code>range</code> Range (metres) || <code>10</code> || Minimum: <code>0.01</code>. Maximum: <code>1000000</code>. Shown when <code>light_type</code> is 2, 0.
|-
| <code>area_size</code> Area size (metres) || <code>[1, 1]</code> || Shown when <code>light_type</code> is 3.
|-
| <code>spot_angle</code> Spot angle || <code>30</code> || Minimum: <code>1</code>. Maximum: <code>179</code>. Shown when <code>light_type</code> is 0.
|-
| <code>shadows</code> Cast shadows || <code>true</code> || Value type: <code>bool</code>.
|-
| <code>enabled</code> Start on || <code>true</code> || Value type: <code>bool</code>.
|-
| <code>cookie</code> Cookie || <code>None</code> || Reference: <code>texture</code>.
|-
| <code>lighting</code> Lighting || Baked (<code>0</code>) || Effects or scripts change Baked point/spot lights to Dynamic. Mixed keeps baked indirect light. Choices: Baked (<code>0</code>), Mixed (<code>1</code>), Dynamic (<code>2</code>).
|-
| <code>effect</code> Effect || None (<code>0</code>) || Choices: None (<code>0</code>), Flicker (<code>1</code>), Strobe (<code>2</code>), Candle (<code>3</code>).
|-
| <code>scripted</code> Scripted || <code>false</code> || Enable for external scripts or mods. VSig enables this automatically. Creates a network entity.
|-
| <code>ignore_nav_mesh</code> Ignore Nav Mesh || <code>false</code> || Exclude this entity from navigation-mesh building. This does not disable its gameplay collision.
|}

== VSig contract ==

Use the names below with a ref bound to this entity. The value column describes the catalog value type, not a C# method signature. See [[Grimwar/Entities#Read the reference|Read the reference]] for arguments, authority, and common controls.

{| class="wikitable"
! Kind !! Member !! Value !! Authority / access
|-
| Input || <code>color</code> || <code>string</code> || Server
|-
| Input || <code>kill</code> || <code>none</code> || Server
|-
| Input || <code>off</code> || <code>string</code> || Server
|-
| Input || <code>on</code> || <code>string</code> || Server
|-
| Input || <code>toggle</code> || <code>string</code> || Server
|-
| Output || <code>killed</code> || <code>none</code> || Server
|-
| Output || <code>toggle</code> || <code>string</code> || Server
|}

== Build notes ==

Light effects need Mixed or Dynamic lighting. Baked point/spot lights export as Dynamic when an effect is enabled. Mixed keeps its baked indirect light; area lights cannot animate.

Script-controlled lights need Mixed or Dynamic lighting. Baked point/spot lights export as Dynamic when scripted. Mixed keeps its baked indirect light; area lights cannot animate.

[[Category:Grimwar entities]]

Grimwar/Entities/env light - Revision history

DocumentationBot: Version 1