Env effectscript: Difference between revisions

Latest revision as of 04:31, 19 May 2025

Class hierarchy
CEnvEffectsScript ↳CBaseAnimating ↳CBaseEntity
`env_effectsscript.cpp`

env_effectscript is a model entity available in all Source games. It allows scripting special visual effects via a script file. Two are used in d1_trainstation_05.

Name (targetname) <string>[ Edit ]: The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report. See also: Generic Keyvalues, Inputs and Outputs available to all entities

Script Model (model) <model path>: Model to use for animation sequences. Defaults to models/Effects/teleporttrail.mdl.

Script File (scriptfile) <string>: Name of the script to use for this model. Defaults to scripts/effects/testeffect.txt.

SetSequence <stringRedirectInput/string>: Sets the script model's sequence.

@@ Line 1: / Line 1: @@
-An entity that allows you to script special visual effects via a script file.
+<!-- When this page is updated to {{langsp}} or {{langsp}} instead of {{lang}}, please move {{this is a}} to the base page, as it is automatically translated. -->{{lang|Env effectscript}}{{CD|CEnvEffectsScript|file1=1}}
-{{stub}}
+{{this is a|model entity|name=env_effectscript}} It allows scripting special visual effects via a script file. Two are used in {{ent|d1_trainstation_05}}{{hl2}}.
 ==Keyvalues==
-*{{kv targetname}}
+{{KV Targetname}}
-*{{kv parentname}}
+{{KV|Script Model|intn=model|studio|Model to use for animation sequences. Defaults to <code>models/Effects/teleporttrail.mdl</code>.}}
-*{{kv angles}}
+{{KV|Script File|intn=scriptfile|string|Name of the script to use for this model. Defaults to <code>scripts/effects/testeffect.txt</code>.}}
-*'''model''' <[[studio]]>
-:Model to use for animation sequences.
-*'''scriptfile''' <string>
-:Name of the script to use for this model.
 ==Inputs==
-*{{i targetname}}
+{{I|SetSequence|Sets the script model's sequence.|param=string}}
-*{{i parentname}}
-*'''SetSequence''' <string>
-:Sets the script model's sequence.
-==Outputs==
-*{{o targetname}}
 ==See also==
-* [[Creating an Effectscript model]]
+*[[Creating an Effectscript model]]
+*[[Particle System Overview]]