Grimwar/Entities/env ambient

Overview · Getting started · SDK setup · Maps · Custom content · Entities · VSig · VMod · Workshop · Addons · Servers · Help

All entities

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.

Setting	Default	Meaning and choices
event_name Event Name	Empty	Wwise Event name posted by this ambient marker.
custom_cue Custom Cue	None	Select imported or shared audio. This overrides Event Name; a shared cue requires its provider add-on. Reference: data.
audible_distance Audible Distance	10	Emitter radius in metres; default 10. Use 0 for a point source. The Wwise event controls falloff beyond this radius. Minimum: 0.
mode Mode	Point (0)	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 (0), Volumetric (1).
play_on_start Play On Start	true	Play when the entity starts on the client.
stop_on_disable Stop On Disable	true	Stop when the entity is disabled or destroyed.
ignore_nav_mesh Ignore Nav Mesh	false	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 Read the reference for arguments, authority, and common controls.

Kind	Member	Value	Authority / access
Input	kill	none	Client
Input	play	string	Client
Input	set_cue_id	string	Client
Input	set_event_name	string	Client
Input	stop	string	Client
Input	toggle	string	Client
Output	killed	none	Client
Output	played	string	Client
Output	stopped	string	Client
Property	audible_distance	float	Client; read only
Property	cue_id	string	Client; read only
Property	event_name	string	Client; read only