Env spark: Difference between revisions

Latest revision as of 10:03, 25 September 2024

Class hierarchy
CEnvSpark ↳CPointEntity ↳CBaseEntity
`EnvSpark.cpp`

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

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.

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.

@@ Line 1: / Line 1: @@
-{{wrongtitle|title=env_spark}}
+{{LanguageBar}}
+{{CD|CEnvSpark|file1=EnvSpark.cpp}}
+{{This is a|point entity|name=env_spark|sprite=1}} It is used to create sparks at its origin.
+__NOTOC__
-[[Image:env_spark.jpg|thumb|300px|right|env_spark with directional, glowing medium sized sparks]]
+[[File:env_spark.jpg|right|thumb|200px|<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.]]
-==Entity Description==
-An entity used to create sparks at its origin.
-==Notes==
+== Flags ==
+{{fl|64|Start ON}}
+{{fl|128|Glow}}
+{{fl|256|Silent}}
+{{fl|512|Directional}}
-* 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 ==
+{{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|Magnitude|intn=Magnitude|choices|The amount of the sparks.
+:*1: Small
+:*2: Medium
+:*5: Large
+:*8: Huge}}
+{{KV|Spark Trail Length|intn=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}}
-==Keyvalues==
+== Inputs ==
+{{I|StartSpark|Start the spark effect.}}
+{{I|StopSpark|Stop the spark effect.}}
+{{I|ToggleSpark|Toggle the on/off state of the spark effect.}}
+{{I|SparkOnce|Spark once.}}
-* {{kv targetname}}
+== Outputs ==
-* {{kv parentname}}
+{{O|OnSpark|nofgd=1|Fired when the sparks emit.}}
-* {{kv angles}}
-* '''MaxDelay'''
-: <integer> The longest delay between sparks (in seconds).
-* '''Magnitude'''
-: <integer> The size of the sparks. Feel free to try other values than the following:
-:{|
-! Literal Value || Description
-|-
-| 1 || Small
-|-
-| 2 || Medium
-|-
-| 5 || Large
-|-
-| 8 || Huge
-|}
-* '''TrailLength'''
-: <choices> Spark Trail Length
-:{|
-! Literal Value || Description
-|-
-| 1 || Short
-|-
-| 2 || Medium
-|-
-| 3 || Long
-|}
-==Flags==
+[[Category:Special effects]]
-* 64 : Start ON
-* 128 : Glow
-* 256 : Silent
-* 512 : Directional
-==Inputs==
-* {{i targetname}}
-* {{i parentname}}
-* '''StartSpark'''
-: Start the spark effect.
-* '''StopSpark'''
-: Stop the spark effect.
-* '''ToggleSpark'''
-: Toggle the on/off state of the spark effect.
-* '''SparkOnce'''
-: Spark once.
-==Outputs==
-* {{o targetname}}
-==External links==
-*[http://www.akilling.org/akg/tutorials/wiseElec.asp Shocking]
-[[Category:Entities]]
-[[Category:Special Effects]]