DocumentationBot: Version 1

2026-10-01T04:13:05Z

Version 1

New page

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|func_door|section}}

Move owned geometry between closed and open positions.

Placement: Geometry owned by the entity.

== Set it up ==

Parent the door geometry under this entity and choose a local Move Direction. Positive Lip leaves part of the brush in the frame; negative Lip moves it beyond the measured length. open and close outputs fire after movement finishes. A locked door ignores movement inputs until unlocked. Linked Doors records references but does not synchronize motion; call both doors from VSig. Use an SDK spawn-door prefab for a ready-made trigger and door assembly.

== Settings ==

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

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>move_direction</code> Move Direction || Front (<code>4</code>) || Local direction (relative to this marker) that the door moves when opening. Choices: Up (<code>0</code>), Down (<code>1</code>), Left (<code>2</code>), Right (<code>3</code>), Front (<code>4</code>), Back (<code>5</code>).
|-
| <code>speed</code> Speed || <code>6</code> || Units per second the door moves between closed and open. Minimum: <code>0.01</code>.
|-
| <code>lip</code> Lip || <code>0</code> || Signed travel inset. Positive values leave this much of the door in-frame; negative values move beyond the measured door length.
|-
| <code>reset_delay</code> Reset Delay || <code>-1</code> || Automatically close after this many seconds once fully open. -1 = never auto close. Minimum: <code>-1</code>.
|-
| <code>damage</code> Damage || <code>0</code> || Damage dealt when this moving door drives into a damageable target. Separating and tangential contacts do not deal damage. 0 disables collision damage. Minimum: <code>0</code>.
|-
| <code>damage_cooldown_seconds</code> Damage Cooldown Seconds || <code>0.25</code> || Minimum seconds between collision-damage events against the same target. Minimum: <code>0.01</code>.
|-
| <code>start_locked</code> Start Locked || <code>false</code> || If true, the door starts locked and ignores open/close/toggle until unlocked.
|-
| <code>start_open</code> Start Open || <code>false</code> || If true, the door starts open.
|-
| <code>linked_doors</code> Linked Doors || <code>[]</code> || References only. Use VSig to synchronize the doors. Ordered list. Reference: <code>func_door</code>.
|-
| <code>ignore_nav_mesh</code> Ignore Nav Mesh || <code>true</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>close</code> || <code>string</code> || Server
|-
| Input || <code>kill</code> || <code>none</code> || Server
|-
| Input || <code>lock</code> || <code>string</code> || Server
|-
| Input || <code>open</code> || <code>string</code> || Server
|-
| Input || <code>toggle</code> || <code>string</code> || Server
|-
| Input || <code>unlock</code> || <code>string</code> || Server
|-
| Output || <code>close</code> || <code>string</code> || Server
|-
| Output || <code>killed</code> || <code>none</code> || Server
|-
| Output || <code>open</code> || <code>string</code> || Server
|-
| Property || <code>is_locked</code> || <code>bool</code> || Server; read/write
|-
| Property || <code>is_open</code> || <code>bool</code> || Server; read/write
|-
| State || <code>state</code> || <code>DoorEntityState</code> || Server; read/write
|}

Capture <code>ref.state</code> from one matching entity and use <code>ref.restore(saved_state)</code> to restore a compatible snapshot.

[[Category:Grimwar entities]]

Grimwar/Entities/func door - Revision history

DocumentationBot: Version 1