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
No edit summary |
(-added class hierarchy, cleanup) |
||
| Line 1: | Line 1: | ||
{{ | {{LanguageBar}} | ||
[[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.]] | ||
{{CD|CEnvSpark|file1=EnvSpark.cpp}} | |||
{{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|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}}}}}} | {{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}}}}}} | ||
{{clearleft}} | {{clearleft}} | ||
==Flags== | ==Flags== | ||
{{fl|64|Start ON}} | |||
{{fl|128|Glow}} | |||
{{fl|256|Silent}} | |||
{{fl|512|Directional}} | |||
==Keyvalues== | ==Keyvalues== | ||
{{KV Targetname}} | |||
{{KV|Max Delay|intn=MaxDelay|string|The longest delay between sparks (in seconds). If this value is changed with {{ent|AddOutput}}, the change will only take effect after the entity sparks again.}} | {{KV|Max Delay|intn=MaxDelay|string|The longest delay between sparks (in seconds). If this value is changed with {{ent|AddOutput}}, the change will only take effect after the entity sparks again.}} | ||
{{KV|Magnitude|intn=Magnitude|choices|The amount of the sparks. | {{KV|Magnitude|intn=Magnitude|choices|The amount of the sparks. | ||
| Line 25: | Line 25: | ||
:*2: Medium | :*2: Medium | ||
:*3: Long}} | :*3: Long}} | ||
==Inputs== | ==Inputs== | ||
| Line 32: | Line 31: | ||
{{IO|ToggleSpark|Toggle the on/off state of the spark effect.}} | {{IO|ToggleSpark|Toggle the on/off state of the spark effect.}} | ||
{{IO|SparkOnce|Spark once.}} | {{IO|SparkOnce|Spark once.}} | ||
==Outputs== | ==Outputs== | ||
{{IO|OnSpark|nofgd=1|Fired when the sparks emit.}} | {{IO|OnSpark|nofgd=1|Fired when the sparks emit.}} | ||
[[Category:Special effects]] | [[Category:Special effects]] | ||
Revision as of 09:57, 25 September 2024
 Class hierarchy
|
|---|
| CEnvSpark |
| EnvSpark.cpp
|
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 
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.
parentnameortarget).
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.