This article's documentation is for anything that uses the Source engine. Click here for more information.

Env effectscript: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Robot: fixing template case.)
m (Classifying as model entity)
 
(15 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{wrongtitle|title=env_effectscript}}
<!-- 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}}
{{base_point}}
{{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}}.
 
==Entity Description==
An entity that allows you to script special visual effects via a script file.
 
===See also===
* [[Creating an Effectscript model]]


==Keyvalues==
==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]]> Script Model - Model to use for animation sequences. Defaulted to ''models/Effects/teleporttrail.mdl''.
* '''scriptfile'''
: <string> Script File - Name of the script to use for this model. Defaulted to ''scripts/effects/testeffect.txt''.


<!--This entity doesn't have any flags.-->
==Inputs==
==Inputs==
* {{I Targetname}}
{{I|SetSequence|Sets the script model's sequence.|param=string}}
* {{I Parentname}}
* '''SetSequence <string>'''
: Sets the script model's sequence, starting the effect.


==Outputs==
==See also==
*{{o targetname}}
*[[Creating an Effectscript model]]
*[[Particle System Overview]]

Latest revision as of 04:31, 19 May 2025

English (en)中文 (zh)Translate (Translate)
C++ Class hierarchy
CEnvEffectsScript
↳CBaseAnimating
↳CBaseEntity
C++ env_effectsscript.cpp

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

Keyvalues

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.

Inputs

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

See also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Env_effectscript&oldid=477842"