DocumentationBot: Version 1

2026-10-01T04:13:05Z

Version 1

New page

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|env_particle|section}}

Place a particle or VFX effect, with optional scripted playback.

Placement: Point.

== Set it up ==

Select an effect prefab and use Effect Scale to resize this placement. An unreferenced ambient effect can run without a network entity. A VSig reference enables scripted control automatically; enable Scripted for external control. Scripted effects need authored play/stop bindings, and trigger needs a burst binding. A decorative effect without those bindings cannot be made controllable just by naming it in a script. Server play, stop, and restart update sustained playback; trigger sends a one-shot burst and does not change that state.

== Settings ==

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

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>effect</code> Effect || <code>None</code> || Choose a particle or VFX prefab. Use Effect scale to resize this placement. Reference: <code>prefab</code>.
|-
| <code>effect_scale</code> Effect scale || <code>[1, 1, 1]</code> || XYZ size multiplier relative to the effect prefab; 1 preserves its native size. Minimum: <code>0.001</code>. Maximum: <code>1000</code>.
|-
| <code>start_on</code> Start On || <code>true</code> || Value type: <code>bool</code>.
|-
| <code>scripted</code> Scripted || <code>false</code> || Enable external control. VSig references enable this automatically; unreferenced effects use no network entity.
|-
| <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>kill</code> || <code>none</code> || Server
|-
| Input || <code>play</code> || <code>string</code> || Server
|-
| Input || <code>restart</code> || <code>string</code> || Server
|-
| Input || <code>stop</code> || <code>string</code> || Server
|-
| Input || <code>trigger</code> || <code>string</code> || Server
|-
| Output || <code>killed</code> || <code>none</code> || Server
|}

[[Category:Grimwar entities]]

Grimwar/Entities/env particle - Revision history

DocumentationBot: Version 1