DocumentationBot: Version 1

2026-10-01T04:13:05Z

Version 1

New page

{{GameNav}}

Grimwar supplies 32 entity types for Vertex. Choose a type below for its placement, settings and defaults, VSig signals, and usage notes.

== Read the reference ==

Place an entity from Vertex's creation controls and edit it in the inspector. Point entities use a position and direction. Bounds entities define oriented volumes. Brush entities own the geometry beneath them in the hierarchy. Properties with metre units remain in metres even when the map uses inch-based geometry units.

Settings are the values authored into the map. Inputs are actions you call; outputs are events you listen to. Runtime properties and state snapshots describe a running entity. A server contract controls game state; a client contract controls local presentation. Use the correct VSig handler authority.

Many entity inputs accept a string parameter and parse a number, colour, or other value from it. In VSig, pass an expression: <code>push.set_speed(18)</code>. Multiple arguments use composite formatting, such as <code>label.set_text("Wave {0}: {1}", wave, remaining)</code>. An input with no argument receives no parameter. A string output in the catalog does not guarantee a nonempty payload on every event.

Every concrete runtime entity has <code>kill</code> and <code>killed</code>. Kill permanently removes that instance until the map reloads. Operational entities also have enable, disable, toggle, enabled, disabled, and is_enabled. Doors and continuous movers use their own motion controls; toggle does not mean the same thing for every entity.

When a state type is listed, capture <code>entity.state</code> and restore it with <code>entity.restore(saved_state)</code>. Reads require one matching entity. [[Grimwar/VSig|VSig]] explains refs, hierarchy matching, and <code>!activator</code>/<code>!caller</code>/<code>!self</code>.

== Entity index ==

{| class="wikitable sortable"
! Entity !! Editor name !! Placement !! Use
|-
| {{Entity icon|env_ambient}} [[Grimwar/Entities/env_ambient|env_ambient]] || Ambient || point || Play a base-game audio event or a custom sound.
|-
| {{Entity icon|env_explosion}} [[Grimwar/Entities/env_explosion|env_explosion]] || Explosion || point || Apply radial damage and force, with an optional visual effect.
|-
| {{Entity icon|env_light}} [[Grimwar/Entities/env_light|env_light]] || Light || point || Place a light and optionally control it with scripts or a built-in effect.
|-
| {{Entity icon|env_particle}} [[Grimwar/Entities/env_particle|env_particle]] || Particle effect || point || Place a particle or VFX effect, with optional scripted playback.
|-
| {{Entity icon|env_screenshake}} [[Grimwar/Entities/env_screenshake|env_screenshake]] || Screen Shake || point || Shake player cameras within a radius.
|-
| {{Entity icon|func_button}} [[Grimwar/Entities/func_button|func_button]] || Button || point || Emit a pressed signal from native interaction or a script.
|-
| {{Entity icon|func_damageable}} [[Grimwar/Entities/func_damageable|func_damageable]] || Damageable || volume || Give owned geometry health and a reversible broken state.
|-
| {{Entity icon|func_door}} [[Grimwar/Entities/func_door|func_door]] || Door || volume || Move owned geometry between closed and open positions.
|-
| {{Entity icon|func_ladder}} [[Grimwar/Entities/func_ladder|func_ladder]] || Ladder || volume || Create a two-sided climbable volume.
|-
| {{Entity icon|func_resupply}} [[Grimwar/Entities/func_resupply|func_resupply]] || Resupply Locker || point || Refill health, magazines, and reserve ammunition for living players.
|-
| {{Entity icon|func_rotate}} [[Grimwar/Entities/func_rotate|func_rotate]] || Rotate || volume || Rotate owned geometry as a door or a continuously moving object.
|-
| {{Entity icon|func_team_barrier}} [[Grimwar/Entities/func_team_barrier|func_team_barrier]] || Team Barrier || volume || Allow selected teams through a barrier.
|-
| {{Entity icon|func_tracktrain}} [[Grimwar/Entities/func_tracktrain|func_tracktrain]] || Track Train || volume || Move owned geometry along an authored path.
|-
| {{Entity icon|game_blitz_checkpoint}} [[Grimwar/Entities/game_blitz_checkpoint|game_blitz_checkpoint]] || Blitz Checkpoint || point || Mark a named checkpoint along a Blitz tank route.
|-
| {{Entity icon|game_blitz_tank}} [[Grimwar/Entities/game_blitz_tank|game_blitz_tank]] || Blitz Tank || volume || Create a Blitz escort objective with a path and checkpoints.
|-
| {{Entity icon|game_capture_flag}} [[Grimwar/Entities/game_capture_flag|game_capture_flag]] || Capture Flag || volume || Create a flag in an Uplink capture graph.
|-
| {{Entity icon|game_capture_point}} [[Grimwar/Entities/game_capture_point|game_capture_point]] || Capture Point || volume || Create a team capture objective.
|-
| {{Entity icon|info_label}} [[Grimwar/Entities/info_label|info_label]] || Label || point || Display world-space text.
|-
| {{Entity icon|info_observer_point}} [[Grimwar/Entities/info_observer_point|info_observer_point]] || Observer Point || point || Place a spectator or presentation camera.
|-
| {{Entity icon|info_player_spawn}} [[Grimwar/Entities/info_player_spawn|info_player_spawn]] || Spawn Point || point || Choose where a team player spawns and faces.
|-
| {{Entity icon|info_stage_point}} [[Grimwar/Entities/info_stage_point|info_stage_point]] || Stage Point || point || Place a postgame or staged player pose.
|-
| {{Entity icon|info_teleport_destination}} [[Grimwar/Entities/info_teleport_destination|info_teleport_destination]] || Teleport Destination || point || Set the destination pose for a teleport trigger.
|-
| {{Entity icon|item_pickup}} [[Grimwar/Entities/item_pickup|item_pickup]] || Pickup || point || Spawn a health, ammunition, or skull pickup.
|-
| {{Entity icon|logic_script}} [[Grimwar/Entities/logic_script|logic_script]] || Logic Script || logic || Configure a reusable VSig module in the map.
|-
| {{Entity icon|trigger_gravewar_skull_deposit}} [[Grimwar/Entities/trigger_gravewar_skull_deposit|trigger_gravewar_skull_deposit]] || Gravewar Skull Deposit || volume || Let Gravewar survivors bank carried skulls.
|-
| {{Entity icon|trigger_gravewar_upgrade_zone}} [[Grimwar/Entities/trigger_gravewar_upgrade_zone|trigger_gravewar_upgrade_zone]] || Gravewar Upgrade Zone || volume || Open Gravewar upgrades for eligible players inside a volume.
|-
| {{Entity icon|trigger_hurt}} [[Grimwar/Entities/trigger_hurt|trigger_hurt]] || Trigger Hurt || volume || Damage or heal accepted occupants at an interval.
|-
| {{Entity icon|trigger_multiple}} [[Grimwar/Entities/trigger_multiple|trigger_multiple]] || Trigger || volume || Emit events as accepted objects enter, stay in, and leave a volume.
|-
| {{Entity icon|trigger_push}} [[Grimwar/Entities/trigger_push|trigger_push]] || Trigger Push || volume || Accelerate occupants or give them a one-time velocity impulse.
|-
| {{Entity icon|trigger_spawn_zone}} [[Grimwar/Entities/trigger_spawn_zone|trigger_spawn_zone]] || Spawn Zone || volume || Register participants inside a team spawn zone.
|-
| {{Entity icon|trigger_teleport}} [[Grimwar/Entities/trigger_teleport|trigger_teleport]] || Trigger Teleport || volume || Move accepted occupants to a destination point.
|-
| {{Entity icon|trigger_water}} [[Grimwar/Entities/trigger_water|trigger_water]] || Water || volume || Create a swimmable volume with a water surface.
|}

== Common setup mistakes ==

* Set a trigger's team filters. <code>trigger_multiple</code> defaults to None, which blocks participants.
* Set each spawn's Team explicitly. A new <code>info_player_spawn</code> defaults to Union.
* Parent moving geometry under its entity. Use Path Points for Vertex trains and Blitz tanks.
* Check the entity's authority before adding a script handler. Ambient sound calls are client-side; gameplay triggers and movers are server-side.
* Give entities stable hierarchy names for VSig refs. Copying an object gives it a new internal identity.

== Retired entities ==

{{Entity icon|game_crystal}} <code>game_crystal</code> is no longer in the current SDK. Older maps that used it need an authored replacement suited to their game mode. Use <code>func_damageable</code> for a breakable object; it does not automatically recreate an old objective's rules.

[[Category:Grimwar]] [[Category:Grimwar entities]] [[Category:Mapping]]

Grimwar/Entities - Revision history

DocumentationBot: Version 1