DocumentationBot: Version 1

2026-10-01T04:13:05Z

Version 1

New page

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|env_ambient|section}}

Play a base-game audio event or a custom sound.

Placement: Point, or oriented volume in Volumetric mode.

== Set it up ==

Choose Event Name for an exposed game event, or Custom Cue for imported or shared audio. Custom Cue takes priority. Enable Play On Start for continuous ambience. Use client VSig handlers for play, stop, and toggle. A temporary argument to play or toggle selects a source for that call; set_event_name and set_cue_id change the current source override. See [[Grimwar/Custom content]] for a complete sound example.

== Settings ==

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

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>event_name</code> Event Name || <code>Empty</code> || Wwise Event name posted by this ambient marker.
|-
| <code>custom_cue</code> Custom Cue || <code>None</code> || Select imported or shared audio. This overrides Event Name; a shared cue requires its provider add-on. Reference: <code>data</code>.
|-
| <code>audible_distance</code> Audible Distance || <code>10</code> || Emitter radius in metres; default 10. Use 0 for a point source. The Wwise event controls falloff beyond this radius. Minimum: <code>0</code>.
|-
| <code>mode</code> Mode || Point (<code>0</code>) || Point plays at the marker. Volumetric uses its rotation and scale as a box: audio follows the nearest surface outside, then stops moving and plays in 2D inside. Choices: Point (<code>0</code>), Volumetric (<code>1</code>).
|-
| <code>play_on_start</code> Play On Start || <code>true</code> || Play when the entity starts on the client.
|-
| <code>stop_on_disable</code> Stop On Disable || <code>true</code> || Stop when the entity is disabled or destroyed.
|-
| <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>kill</code> || <code>none</code> || Client
|-
| Input || <code>play</code> || <code>string</code> || Client
|-
| Input || <code>set_cue_id</code> || <code>string</code> || Client
|-
| Input || <code>set_event_name</code> || <code>string</code> || Client
|-
| Input || <code>stop</code> || <code>string</code> || Client
|-
| Input || <code>toggle</code> || <code>string</code> || Client
|-
| Output || <code>killed</code> || <code>none</code> || Client
|-
| Output || <code>played</code> || <code>string</code> || Client
|-
| Output || <code>stopped</code> || <code>string</code> || Client
|-
| Property || <code>audible_distance</code> || <code>float</code> || Client; read only
|-
| Property || <code>cue_id</code> || <code>string</code> || Client; read only
|-
| Property || <code>event_name</code> || <code>string</code> || Client; read only
|}

[[Category:Grimwar entities]]

Grimwar/Entities/env ambient - Revision history

DocumentationBot: Version 1