DocumentationBot: Version 1

2026-10-01T04:13:05Z

Version 1

New page

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|func_damageable|section}}

Give owned geometry health and a reversible broken state.

Placement: Geometry owned by the entity.

== Set it up ==

Place the geometry beneath the entity. Hide And Disable Collision removes its owned presentation while broken; State Only lets your script control the presentation. damage and heal use maximum health when the amount is omitted or invalid. break can be reversed with reset; kill permanently removes the entity for this map load. A disabled damageable ignores gameplay damage but still accepts reset, heal, and break.

== Settings ==

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

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>max_health</code> Max Health || <code>100</code> || Maximum health before the damageable enters its broken state. Minimum: <code>1</code>.
|-
| <code>start_disabled</code> Start Disabled || <code>false</code> || If true, the damageable starts operationally disabled and ignores gameplay damage.
|-
| <code>starts_broken</code> Starts Broken || <code>false</code> || If true, the breakable starts broken (health = 0).
|-
| <code>break_presentation</code> Break Presentation || Hide And Disable Collision (<code>0</code>) || Default behavior hides owned renderers and disables owned colliders while broken. State Only keeps the authored presentation and collision unchanged. Choices: Hide And Disable Collision (<code>0</code>), State Only (<code>1</code>).
|-
| <code>min_damage</code> Min Damage || <code>0</code> || Ignore individual damage events below this threshold. Minimum: <code>0</code>.
|-
| <code>reset_delay_seconds</code> Reset Delay Seconds || <code>-1</code> || Seconds before restoring to full health after breaking. -1 = never auto-reset. Minimum: <code>-1</code>.
|-
| <code>allowed_teams</code> Allowed Teams || None (<code>0</code>) || Optional team filter. None means any team can damage it. Supports multiple teams via flags. Choices: None (<code>0</code>), Spectate (<code>1</code>), Order (<code>2</code>), Union (<code>4</code>), All (<code>7</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>break</code> || <code>string</code> || Server
|-
| Input || <code>damage</code> || <code>string</code> || Server
|-
| Input || <code>disable</code> || <code>none</code> || Server
|-
| Input || <code>enable</code> || <code>none</code> || Server
|-
| Input || <code>heal</code> || <code>string</code> || Server
|-
| Input || <code>kill</code> || <code>none</code> || Server
|-
| Input || <code>reset</code> || <code>string</code> || Server
|-
| Input || <code>toggle</code> || <code>none</code> || Server
|-
| Output || <code>break</code> || <code>string</code> || Server
|-
| Output || <code>damaged</code> || <code>string</code> || Server
|-
| Output || <code>disabled</code> || <code>none</code> || Server
|-
| Output || <code>enabled</code> || <code>none</code> || Server
|-
| Output || <code>healed</code> || <code>string</code> || Server
|-
| Output || <code>health_changed</code> || <code>float</code> || Server
|-
| Output || <code>killed</code> || <code>none</code> || Server
|-
| Output || <code>reset</code> || <code>string</code> || Server
|-
| Property || <code>health</code> || <code>float</code> || Server; read only
|-
| Property || <code>is_broken</code> || <code>bool</code> || Server; read only
|-
| Property || <code>is_enabled</code> || <code>bool</code> || Server; read only
|-
| Property || <code>max_health</code> || <code>float</code> || Server; read only
|-
| State || <code>state</code> || <code>DamageableEntityState</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.

This entity supports operational enable/disable. Repeating the current state does not emit another transition. <code>kill</code> is permanent for this map load.

[[Category:Grimwar entities]]

Grimwar/Entities/func damageable - Revision history

DocumentationBot: Version 1