Difference between revisions of "Fog volume"

From Valve Developer Community
Jump to: navigation, search
(Created page with '{{l4d_brush|fog_volume}}<br>{{l4d2_brush|fog_volume}} ==Entity Description== <code>fog_volume</code> is a brush entity that controls fog and other visual cinematic elements with…')
 
Line 1: Line 1:
 
{{l4d_brush|fog_volume}}<br>{{l4d2_brush|fog_volume}}
 
{{l4d_brush|fog_volume}}<br>{{l4d2_brush|fog_volume}}
  
−
==Entity Description==
+
==Entity description==
−
<code>fog_volume</code> is a brush entity that controls fog and other visual cinematic elements within its volume. It is necessary to have at least one <code>fog_volume</code> in order for (a master) [[color_correction]] to take effect in Left 4 Dead and Left 4 Dead 2.
+
<code>fog_volume</code> is a brush entity that controls fog and other visual cinematic elements within its volume. It is necessary to have at least one <code>[[fog_volume]]</code> in order for (a master) [[color_correction]] to take effect in Left 4 Dead and Left 4 Dead 2.
  
 
==Keyvalues==
 
==Keyvalues==
Line 30: Line 30:
 
==Outputs==
 
==Outputs==
 
{{O Targetname}}
 
{{O Targetname}}
 +
 +
==See also==
 +
*[[fog_volume]]
 +
*[[color_correction]]
 +
*[[env_fog_controller]]
 +
 +
==External links==
 +
[http://www.l4d.com/blog/post.php?id=1962|L4D Art Direction, Part 1: Filmic Effects] - Valve blog regarding film effects in Left 4 Dead

Revision as of 17:37, 8 March 2010

<Left 4 Dead> fog_volume is a brush entity available in Left 4 Dead.
<Left 4 Dead 2> fog_volume is a brush entity available in Left 4 Dead 2.

Entity description

fog_volume is a brush entity that controls fog and other visual cinematic elements within its volume. It is necessary to have at least one fog_volume in order for (a master) color_correction to take effect in Left 4 Dead and Left 4 Dead 2.

Keyvalues

  • Targetname:

Name (targetname) <string>
The targetname that other entities refer to this entity by.
Entity Scripts (vscripts) <scriptlist> (New with Left 4 Dead 2)
Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
Script think function (thinkfunction) <string> (New with Left 4 Dead 2)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.
Note:Try to avoid expensive operations in this function, as it may cause performance problems.
  • EnableDisable:
Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (probably with the Enable input).

  • FogName:

Fog Name <target_destination>
The name of the fog entity associated with this volume.

  • PostProcessName:

Postprocess Name <target_destination>
The name of the postprocess entity associated with this volume.

  • ColorCorrectionName:

ColorCorrection Name <target_destination>
The name of the color_correction entity associated with this volume.

Inputs

Targetname:

Kill
Removes this entity and any entities parented to it from the world.
KillHierarchy
Functions the same as Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster than Kill.
AddOutput <string>
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Use  !FGD
Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile <script> (New with Left 4 Dead 2)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode <string> (New with Left 4 Dead 2)
Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.
Bug: In <Left 4 Dead 2>, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction <string> (New with Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (New with Alien Swarm) !FGD
Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
SetLocalAngles <angles> (New with Alien Swarm) !FGD
Set this entity's angles.

EnableDisable:

Enable
Disable
Enable/disable this entity from performing its task. It might also disappear from view.

Outputs

Targetname:

OnUser1 to OnUser4
These Outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  (Only in the Left 4 Dead series)
This Output fires when the entity is killed and removed from the game.

See also

External links

Art Direction, Part 1: Filmic Effects - Valve blog regarding film effects in Left 4 Dead

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