Env spark: Difference between revisions
Jump to navigation
Jump to search
Note: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
In code, it is represented by the
(add DoSpark note) |
No edit summary |
||
| Line 2: | Line 2: | ||
[[File:env_spark.jpg|thumb|200px|right|<code>env_spark</code> 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.]] | [[File:env_spark.jpg|thumb|200px|right|<code>env_spark</code> 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.]] | ||
{{this is a|point entity|name=env_spark|sprite=1}} It is used to create sparks at its origin. | {{this is a|point entity|name=env_spark|sprite=1}} It is used to create sparks at its origin. | ||
{{Note| | {{Note|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 <code>OnSpark</code> output{{todo|likely the case in other games, only observed in {{tf2}}}}}} | ||
{{code class|CEnvSpark|EnvSpark.cpp}} | {{code class|CEnvSpark|EnvSpark.cpp}} | ||
Revision as of 19:40, 4 June 2024
env_spark is a point entity available in all 
Source games. It is used to create sparks at its origin.
Note: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 outputTodo: likely the case in other games, only observed in 
In code, it is represented by theCEnvSparkclass, defined in theEnvSpark.cppfile.
Flags
- 64: Start ON
- 128: Glow
- 256: Silent
- 512: Directional
Keyvalues
- 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.