Env dustpuff: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(little more info)
(Cleanup)
Line 1: Line 1:
{{wrongtitle|title=env_dustpuff}}
{{base point|env_dustpuff}}
{{base_point}}
[[File:SmokePuffs.jpg|thumb|260px|Several env_dustpuffs spawning puffs with the default settings]]


== Entity description ==
== Entity description ==
[[{{ns:6}}:SmokePuffs.jpg|thumb|300px|Several env_dustpuffs spawning puffs with the default settings]]
An [[entity]] that can emit dust puffs from its [[origin]]. The size and transparency of the smoke cannot be controlled, but puff's color is adjustable. [[Input]]s are used to spawn the puffs; without inputs, the env_dustpuff does nothing.
An [[entity]] that can emit dust puffs from its [[origin]]. The size and transparency of the smoke cannot be controlled, but puff's color is adjustable. [[Input]]s are used to spawn the puffs; without inputs, the env_dustpuff does nothing.


== Availability ==
== Availability ==
{{in game|point}} {{game-base}}
{{in game|point}} {{game-base}}
In code it is represented by class CEnvDustPuff, defined in func_dust.cpp.
{{code class|CEnvDustPuff|func_dust.cpp}}


== Keyvalues ==
== Keyvalues ==
*{{KV Targetname}}
{{KV|Scale|float|Size of the dust puff.}}
*{{KV Parentname}}
{{KV|Speed|float|Speed at which the dust particles should move.}}
*{{KV Angles}}
{{KV|Dust color|color255|Color of the dust particles.}}
*'''scale'''
{{KV Targetname}}
:<float> Size of the dust puff.
{{KV Parentname}}
*'''speed'''
{{KV Angles}}
:<float> Speed at which the dust particles should move.
*'''color'''
:<[[color255]]> Spawn a dust puff.
 
<!--This entity doesn't have any flags.-->


== Inputs ==
== Inputs ==
*{{i Targetname}}
{{IO|SpawnDust|Spawn a dust puff.}}
*{{i Parentname}}
{{I Targetname}}
{{I Parentname}}


== Outputs ==
== Outputs ==
*{{o Targetname}}
{{O Targetname}}

Revision as of 10:26, 7 June 2011

Template:Base point

Several env_dustpuffs spawning puffs with the default settings

Entity description

An entity that can emit dust puffs from its origin. The size and transparency of the smoke cannot be controlled, but puff's color is adjustable. Inputs are used to spawn the puffs; without inputs, the env_dustpuff does nothing.

Availability

Template:In game Template:Game-base

C++ In code, it is represented by theCEnvDustPuffclass, defined in thefunc_dust.cppfile.

Keyvalues

Scale ([todo internal name (i)]) <float>
Size of the dust puff.
Speed ([todo internal name (i)]) <float>
Speed at which the dust particles should move.
Dust color ([todo internal name (i)]) <color255>
Color of the dust particles.
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

SpawnDust
Spawn a dust puff.


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