Env spark: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Robot: Automated text replacement (-\{\|\r +{| class=standard-table))
(Cleanup)
Line 1: Line 1:
{{TOC|left}}
{{base point|env_spark}}
{{wrongtitle|title=env_spark}}
{{base_point}}[[Category:Special effects]]
[[File:env_spark.jpg|thumb|300px|right|env_spark with directional, glowing medium sized sparks]]
{{clr}}
 
==Entity Description==
==Entity Description==
[[Image:env_spark.jpg|thumb|300px|right|env_spark with directional, glowing medium sized sparks]]
[[File:{{PAGENAME}}.png|left]]An entity used to create sparks at its origin.
[[Image:{{PAGENAME}}.png|left]]An entity used to create sparks at its origin.
{{note|By default, the sparks jump up a bit from the origin of the entity, so if you are attempting to create a situation like in the picture on the right, you must use the '''Directional''' flag and direct the entity downwards.}}
{{note|By default, the sparks jump up a bit from the origin of the entity, so if you are attempting to create a situation like in the picture on the right, you must use the '''Directional''' flag and direct the entity downwards.}}
{{clr}}
==Keyvalues==


* {{KV Targetname}}
== Keyvalues ==
* {{KV Parentname}}
{{KV|Max Delay|string|The longest delay between sparks (in seconds).}}
* {{KV Angles}}
{{KV|Magnitude|choices|The size of the sparks.}}
* '''MaxDelay'''
:* 1 : Small
: <integer> The longest delay between sparks (in seconds).
:* 2 : Medium
* '''Magnitude'''
:* 5 : Large
: <integer> The size of the sparks. Feel free to try other values than the following:
:* 8 : Huge
:{| class=standard-table
{{KV|Spark Trail Length|choices|Length of the spark trails.}}
! Literal Value || Description
:* 1 : Short
|-
:* 2 : Medium
| 1 || Small
:* 3 : Long
|-
{{KV Targetname}}
| 2 || Medium
{{KV Parentname}}
|-
{{KV Angles}}
| 5 || Large
|-
| 8 || Huge
|}
* '''TrailLength'''
: <choices> Spark Trail Length
:{| class=standard-table
! Literal Value || Description
|-
| 1 || Short
|-
| 2 || Medium
|-
| 3 || Long
|}
 
==Flags==


== Flags ==
* 64 : Start ON
* 64 : Start ON
* 128 : Glow
* 128 : Glow
Line 47: Line 28:
* 512 : Directional
* 512 : Directional


==Inputs==
== Inputs ==
 
{{IO|StartSpark|Start the spark effect.}}
* {{I Targetname}}
{{IO|StopSpark|Stop the spark effect.}}
* {{I Parentname}}
{{IO|ToggleSpark|Toggle the on/off state of the spark effect.}}
* '''StartSpark'''
{{IO|SparkOnce|Spark once.}}
: Start the spark effect.
{{I Targetname}}
* '''StopSpark'''
{{I Parentname}}
: Stop the spark effect.
* '''ToggleSpark'''
: Toggle the on/off state of the spark effect.
* '''SparkOnce'''
: Spark once.


==Outputs==
== Outputs ==
{{O Targetname}}


* {{O Targetname}}
[[Category:Special effects]]

Revision as of 10:19, 7 June 2011

Template:Base point

env_spark with directional, glowing medium sized sparks

Entity Description

Env spark.png

An entity used to create sparks at its origin.

Note.pngNote:By default, the sparks jump up a bit from the origin of the entity, so if you are attempting to create a situation like in the picture on the right, you must use the Directional flag and direct the entity downwards.

Keyvalues

Max Delay ([todo internal name (i)]) <string>
The longest delay between sparks (in seconds).
Magnitude ([todo internal name (i)]) <choices>
The size of the sparks.
  • 1 : Small
  • 2 : Medium
  • 5 : Large
  • 8 : Huge
Spark Trail Length ([todo internal name (i)]) <choices>
Length of the spark trails.
  • 1 : Short
  • 2 : Medium
  • 3 : Long
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.

Flags

  • 64 : Start ON
  • 128 : Glow
  • 256 : Silent
  • 512 : Directional

Inputs

StartSpark
Start the spark effect.
StopSpark
Stop the spark effect.
ToggleSpark
Toggle the on/off state of the spark effect.
SparkOnce
Spark once.


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

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