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

Env spark: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(-added class hierarchy, cleanup)
mNo edit summary
Line 27: Line 27:


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


==Outputs==
==Outputs==
{{IO|OnSpark|nofgd=1|Fired when the sparks emit.}}
{{O|OnSpark|nofgd=1|Fired when the sparks emit.}}


[[Category:Special effects]]
[[Category:Special effects]]

Revision as of 09:57, 25 September 2024

English (en)Translate (Translate)
env_spark with directional, glowing medium-sized sparks. By default, the sparks jump up a bit from the origin of the entity, so if you are attempting to create a sparks like this, you must use the Directional flag and point the entity downwards.
C++ Class hierarchy
CEnvSpark
CPointEntity
CBaseEntity
C++ EnvSpark.cpp
Env spark.png

env_spark is a point entity available in all Source Source games. It is used to create sparks at its origin.

Note.pngNote:The "DoSpark" soundscript this entity plays on spark is set to misc/null.wav. You will need to override this soundscript in your map, or manually play sound effects using the OnSpark output
Todo: likely the case in other games, only observed in Team Fortress 2

Flags

Start ON : [64]
Glow : [128]
Silent : [256]
Directional : [512]

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

Max Delay (MaxDelay) <string>
The longest delay between sparks (in seconds). If this value is changed with AddOutput, the change will only take effect after the entity sparks again.
Magnitude (Magnitude) <choices>
The amount of the sparks.
  • 1: Small
  • 2: Medium
  • 5: Large
  • 8: Huge
Spark Trail Length (TrailLength) <choices>
Length of the spark trails. Other numbers may be entered to create extremely long or short trails.
  • 1: Short
  • 2: Medium
  • 3: Long

Inputs

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

Outputs

OnSpark  !FGD
Fired when the sparks emit.