Env effectscript: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (link)
(Cleanup)
Line 1: Line 1:
{{wrongtitle|title=env_effectscript}}
{{base point|env_effectscript}}
{{base_point}}


==Entity Description==
==Entity Description==
An [[entity]] that allows scipting special visual effects via a script file.
An [[entity]] that allows scripting special visual effects via a script file.


===See also===
==Keyvalues==
* [[Creating an Effectscript model]]
{{KV|Script Model|studio|Model to use for animation sequences. Model to use for animation sequences. Defaulted to ''models/Effects/teleporttrail.mdl''.}}
{{KV|Script File|string|Name of the script to use for this model. Name of the script to use for this model. Defaulted to ''scripts/effects/testeffect.txt''.}}
{{KV Targetname}}
{{KV Parentname}}
{{KV Angles}}


==Keyvalues==
== Inputs ==
* {{KV Targetname}}
{{IO|SetSequence|Sets the script model's sequence.|param=string}}
* {{KV Parentname}}
{{I Targetname}}
* {{KV Angles}}
{{I Parentname}}
* '''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.-->
== Outputs ==
==Inputs==
{{O Targetname}}
* {{I Targetname}}
* {{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]]

Revision as of 01:04, 17 June 2011

Template:Base point

Entity Description

An entity that allows scripting special visual effects via a script file.

Keyvalues

Script Model ([todo internal name (i)]) <model path>
Model to use for animation sequences. Model to use for animation sequences. Defaulted to models/Effects/teleporttrail.mdl.
Script File ([todo internal name (i)]) <string>
Name of the script to use for this model. Name of the script to use for this model. Defaulted to scripts/effects/testeffect.txt.
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

Parentname:
Parent (parentname) <targetname>
Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.
Pitch Yaw Roll (Y Z X) (angles) <QAngle>
This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.

Inputs

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


Parentname:
SetParent <stringRedirectInput/string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <stringRedirectInput/string>
Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset <stringRedirectInput/string>
As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
ClearParent
Removes this entity from the the movement hierarchy, leaving it free to move independently.

Outputs

See also