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

Env wind: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Format please)
 
(activator/caller)
 
(45 intermediate revisions by 24 users not shown)
Line 1: Line 1:
env_wind
{{LanguageBar}}
{{Preserved entity}}
{{CD|CEnvWind|file1=effects.cpp}}
{{this is a|point entity|name=env_wind|sprite=1}} It creates wind throughout an entire map, which affect [[prop_physics|physics props]], [[$treesway|swaying trees]], and [[func_dustmotes|dust]].


An entity to control wind in the map. Partially functional.
{{note|Wind direction is determined by <code>env_wind</code>'s yaw value.}}
{{note|In most games, this entity is required for {{ent|$treesway}} to have any effect, unless {{code|$treeswaystatic}} {{only|{{tf2branch}}{{GMOD}}{{csgo}}{{mapbase}}}} is used.}}
{{bug|The wind effect in the client game will not reset when a new map is loaded which does not contain an env_wind entity.}}
{{tip|In {{bms|4}} this entity can be spawned via {{ent|point_template}} and killed with {{code|Kill}} input. This allows you to change the wind globally or turn it off completely by spawning new {{ent|env_wind}} and killing via {{code|Kill}} input the previous {{ent|env_wind}}.}}


KEYS
{{clr}}
__NOTOC__
== Keyvalues ==
{{KV Targetname}}
{{KV|Min normal speed|intn=minwind|integer|Minimum speed of the wind while idling.}}
{{KV|Max normal speed|intn=maxwind|integer|Maximum speed of the wind while idling.}}
{{KV|Min gust speed|intn=mingust|integer|Minimum speed of wind gusts.}}
{{KV|Max gust speed|intn=maxgust|integer|Maximum speed of wind gusts.}}
{{KV|Min gust delay|intn=mingustdelay|integer|Minimum time delay between random gusts.}}
{{KV|Max gust delay|intn=maxgustdelay|integer|Maximum time delay between random gusts.}}
{{KV|Gust Duration|intn=gustduration|integer|How long will the wind gust for.}}
{{KV|Max gust dir change (degrees)|intn=gustdirchange|integer|Maximum amount that the wind's direction changes due to a gust.}}
{{KV|Radius|intn=windradius|float|only=L4ds|The radius this entity applies wind effects to. -1 for global effect.}}


Name targetname <target_source> The name that other entities refer to this entity by.
== Inputs ==
{{I|SetWindDir|Set the wind's direction to this.|param=int|nofgd=1|only=GMOD}}
{{I|Enable|Turns the wind on.|only={{P2CE}}}}
{{I|Disable|Turns the wind off.|only={{P2CE}}}}


Pitch Yaw Roll (Y Z X) angles <angle> This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.
== Outputs ==
{{O|OnGustStart|activator=!caller = NULL|caller=hide|Fired when a wind gust begins.
:{{Bug|env_wind gusts can seemingly pile up and fire this output multiple times when a player first loads into a multiplayer map. {{Workaround|Use AddOutput to add OnGustStart effects when players are already connected}}{{Todo|Needs more testing, only observed in {{tf2}} }}}}}}
{{O|OnGustEnd|activator=!caller = NULL|caller=hide|Fired when a wind gust ends.}}


Gust Sound Filename gustsound <sound> Sound to be played to simulate the gusting wind.
== See also ==
 
* {{ent|trigger_wind}}
Min normal speed minwind <integer> Minimum speed of the wind while idling.
* {{ent|trigger_push}}
 
* {{ent|env_rotorwash}}
Max normal speed maxwind <integer> Maximum speed of the wind while idling.
 
Min gust speed mingust <integer> Minimum speed of wind gusts.
 
Max gust speed maxgust <integer> Maximum speed of wind gusts.
 
Min gust delay mingustdelay <integer> Minimum time delay between random gusts.
 
Max gust delay maxgustdelay <integer> Maximum time delay between random gusts.
 
Max gust dir change (degrees) gustdirchange <integer> Maximum amount that the wind's direction changes due to a gust.
 
 
INPUTS
 
Kill Removes this entity from the world.
 
KillHierarchy Removes this entity and all its children from the world.
 
AddOutput <string> Adds an entity I/O connection to this entity. Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>. Very dangerous, use with care.
 
FireUser1 Causes this entity's OnUser1 output to be fired.
 
FireUser2 Causes this entity's OnUser2 output to be fired.
 
FireUser3 Causes this entity's OnUser3 output to be fired.
 
FireUser4 Causes this entity's OnUser4 output to be fired.
 
 
OUTPUTS
 
OnUser1 Fired in response to FireUser1 input.
 
OnUser2 Fired in response to FireUser2 input.
 
OnUser3 Fired in response to FireUser3 input.
 
OnUser4 Fired in response to FireUser4 input.

Latest revision as of 18:20, 8 May 2025

English (en)Translate (Translate)
Recycle-warning.png
This is a preserved entity in Counter-Strike: SourceHalf-Life 2: DeathmatchDay of Defeat: SourceTeam Fortress 2Left 4 DeadLeft 4 Dead 2Portal 2Counter-Strike: Global Offensive
If the game has round restart mechanics this entity may not behave as expected.
C++ Class hierarchy
CEnvWind
↳CBaseEntity
C++ effects.cpp
Env wind.png

env_wind is a point entity available in all Source Source games. It creates wind throughout an entire map, which affect physics props, swaying trees, and dust.

Note.pngNote:Wind direction is determined by env_wind's yaw value.
Note.pngNote:In most games, this entity is required for $treesway to have any effect, unless $treeswaystatic (only in Team Fortress 2 branchGarry's ModCounter-Strike: Global OffensiveMapbase) is used.
Icon-Bug.pngBug:The wind effect in the client game will not reset when a new map is loaded which does not contain an env_wind entity.  [todo tested in ?]
Tip.pngTip:In Black Mesa Black Mesa this entity can be spawned via point_template and killed with Kill input. This allows you to change the wind globally or turn it off completely by spawning new env_wind and killing via Kill input the previous env_wind.

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

Min normal speed (minwind) <integer>
Minimum speed of the wind while idling.
Max normal speed (maxwind) <integer>
Maximum speed of the wind while idling.
Min gust speed (mingust) <integer>
Minimum speed of wind gusts.
Max gust speed (maxgust) <integer>
Maximum speed of wind gusts.
Min gust delay (mingustdelay) <integer>
Minimum time delay between random gusts.
Max gust delay (maxgustdelay) <integer>
Maximum time delay between random gusts.
Gust Duration (gustduration) <integer>
How long will the wind gust for.
Max gust dir change (degrees) (gustdirchange) <integer>
Maximum amount that the wind's direction changes due to a gust.
Radius (windradius) <float> (only in Left 4 Dead seriesLeft 4 Dead series)
The radius this entity applies wind effects to. -1 for global effect.

Inputs

SetWindDir <integerRedirectInput/integer> (only in Garry's Mod) !FGD
Set the wind's direction to this.
Enable  (only in Portal 2: Community Edition)
Turns the wind on.
Disable  (only in Portal 2: Community Edition)
Turns the wind off.

Outputs

OnGustStart
!activator = !caller = NULL
Fired when a wind gust begins.
Icon-Bug.pngBug:env_wind gusts can seemingly pile up and fire this output multiple times when a player first loads into a multiplayer map.
PlacementTip.pngWorkaround:Use AddOutput to add OnGustStart effects when players are already connected
Todo: Needs more testing, only observed in Team Fortress 2
  [todo tested in ?]
OnGustEnd
!activator = !caller = NULL
Fired when a wind gust ends.

See also

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