env_wind
env_wind is a point entity available in all Source games. It creates wind throughout an entire map.
Note: In some/all multiplayer games, this is a preserved entity.
- On a new round, it will intentionally not reset itself to its default properties (including position).
Workaround: If this is an issue, you can use logic_auto to emulate resetting it. Killing it removes it forever, as it is not respawned on a new round.- It cannot be spawned with a point_template.
Note: Wind direction is determined by env_wind's yaw value. Note: In most games that have $treeSway, this entity is required in order for the materials to simulate wind blowing on them. $treesway does not require env_wind if $treeswaystatic (
only) is used.
Bug: The wind effect in the client game will not change when a new map is loaded which does not contain an env_wind entity.
In code, it is represented by theCEnvWindclass, defined in theeffects.cppfile.Contents
Keyvalues
- 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
) - The radius this entity applies wind effects to. -1 for global effect.
Base:
- Name
(targetname)<string> - The name that other entities use to refer to this entity.
- Parent
(parentname)<targetname> - Maintain the same initial offset to this entity. An attachment point can also be used if separated by a comma at the end. (
parentname [targetname],[attachment])
Tip: Entities transition to the next map with their parents Tip: phys_constraintcan be used as a workaround if parenting fails. - Origin (X Y Z)
(origin)<coordinates> - The position of this entity's center in the world. Rotating entities typically rotate around their origin. Note: Hammer does not move the entities accordingly only in the editor.
- Pitch Yaw Roll (X Y Z)
(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. Note: This works on brush entities, although Hammer doesn't show the new angles.
- Classname
(classname)<string>!FGD - Determines the characteristics of the entity before it spawns. Tip: Changing this on runtime still has use, like making matching an entry in S_PreserveEnts will persist the entity on new rounds!
- Flags
(spawnflags)<integer>!FGD - Toggles exclusive features of an entity, its specific number is determined by the combination of flags added.
- Effects
(effects)<integer>!FGD - Combination of effect flags to use.
- Entity Scripts
(vscripts)<scriptlist>(in all games since
) - 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.
- Thinker function
(thinkfunction)<string>(in all games since) - Name of the function within this entity's script that'll be called automatically every 100 milliseconds, or a user-defined interval if the function returns a number. Avoid expensive operations in this function, as it may cause performance problems.
- Lag Compensation
(LagCompensate)<boolean>(in all games since) !FGD - Set to Yes to lag compensate this entity. Should be used very sparingly!
- Is Automatic-Aim Target
(is_autoaim_target)<boolean>(in all games since
) !FGD - If set to 1, this entity will slow down aiming movement for consoles and joystick controllers when the entity is under the crosshairs.
Inputs
Enable(only in
)- Turns the wind on
Disable(only in)- Turns the wind off
Base:
AddContext<string>- Adds to the entity's list of response contexts. Format is
<key>:<value>.
AddOutput<string>- Assigns a new keyvalue/output on this entity. For keyvalues, some rely on extra necessary code to be ran and won't work if its simply just changed through this input. There is a strict format that must be followed:
Syntax:
// Format of changing KeyValues: "AddOutput [key] [value]"
//// Raw text:
"OnUser1" "!self,AddOutput,targetname new_name"
// Format of adding an Output: "AddOutput {targetname}:{inputname}:{parameter}:{delay}:{max times to fire, -1 means infinite}"
//// Raw text:
"OnUser1" "!self:SetParent:!activator:0.0:-1"
// Arguments can be left blank, but the empty blank should still be contained.
//// Raw text:
"OnUser1" "!self:ClearParent::0.0:-1"
ClearContext- Removes all contexts from this entity's list.
ClearParent- Removes this entity from the the movement hierarchy, leaving it free to move independently.
FireUser1toFireUser4- Fires the respective
OnUseroutputs; see User Inputs and Outputs.
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 thanKillinput.
RemoveContext<string>- Remove a context from this entity's list. The name should match the key of an existing context.
SetParent<string>- Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment<string>- Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset<string>- As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
DispatchEffect<string>(removed since
) !FGD- Dispatches a special effect from the entity's origin; see also List of Client Effects. Replaced by the particle system since .
RunScriptFile<script>(in all games since)- Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode<string>(in all games since)- 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 Hammer, using string arguments will corrupt the VMF file's structure, making the file unviewable for the next Hammer session.
- Fix: Remove the string argument manually with a text editor.
CallScriptFunction<string>(in all games since) !FGD- Calls a VScript function defined in the scope of the receiving entity.
SetLocalOrigin<coordinates>(in all games since
) !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.
Outputs
OnGustStart- Fired when a wind gust begins.
OnGustEnd- Fired when a wind gust ends.
Base:
OnUser1toOnUser4- These outputs each fire in response to the firing of the like-numbered
FireUser1toFireUser4Input; see User Inputs and Outputs. OnKilled(only in)- This output fires when the entity is killed and removed from the game.
