View source for Env global

{{lang|title=env_global}}
{{EntityTabs|env_global|goldsrc=1|source=1|main=source}}

{{infotable
|env_global
|img=[[File:Env global.png]]
|type=e0
|engine={{gldsrc|4}} {{source|4}}
|in=0
}}

{{CD|CEnvGlobal|file1=logicentities.cpp}}
{{entity|type=e0|env_global}} It controls game-specific global states, such as whether the [[weapon_physcannon|gravity gun]] should become the super gravity gun in {{game link|Half-Life 2}}.

Global states persist across level transitions, regardless of their status. Global states are not stored until an <code>env_global</code> receives any commands that modify the state, such as turning it on or off or changing the counter. Use the <code>Set Initial State</code> [[flag]] for the global to be added on spawn.

To remove a global from the table entirely, set the global's state to "Dead" using the <code>Remove</code> input. This will cause the global to remove itself on the next level transition.

Globals and their current state (in integer form) are added to all entities' response data for use in the [[Response System]].

{{tip|[[logic_auto]] can read a global state and fire outputs if the state is turned <code>on</code>.}}

{{note|{{css}}{{csgo}}{{l4d2}} This entity is {{not in FGD}}.}}

{{warning|Using <code>env_global</code> in {{src13mp|4}} is not recommended as it is prone to randomly break and fire all outputs.}}

==ConVars/Commands==
{{varcom|start}}
{{varcom|dump_globals|||Dumps data for all set global states.}}
{{varcom|global_set|globalname state||Set the status of a global state. First parameter is the name of it, second is a number.
*0 {{=}} off
*1 {{=}} on
*2 {{=}} dead
A global can also be created instantly with this command.}}
{{varcom|end}}

==Flags==
{{Fl|1|Set Initial State|Whether this entity defines the global state when the map starts.}}

==Keyvalues==
{{KV|Global State to Set|choices|intn=globalstate|The global state this entity is linked to. Valve's [[FGD]]s always include the HL2 states, but the actual functional ones vary by game. Global states are not exclusive to these choices and any text can be used, though they will not have any special behavior.}}

=== {{hl2}} [[Half-Life 2]] ===
{| class="wikitable"
|-
! Internal Name || Editor Name || Description
|-
| gordon_precriminal || Gordon pre-criminal || Creates the pre-criminal behavior seen in [[Point Insertion]].
|-
| antlion_allied || Antlions are player allies || Makes antlions friendly to the player and allows them to listen to [[weapon_bugbait|bugbait]], as seen in the [[Nova Prospekt]] chapters.
|-
| suit_no_sprint || Suit sprint function not yet enabled || Disables the HEV suit's sprint function.<br/>(not required if the HEV suit is not equipped)
|-
| super_phys_gun || Super phys gun is enabled || Enables the supercharged gravity gun seen in the Citadel levels of [[Half-Life 2]] and [[Episode One]].<br/>{{note|The super gravity gun isn't available in [[Half-Life 2: Deathmatch]] or [[Portal]].}}
|-
| friendly_encounter || Friendly encounter sequence (lower weapons, etc.) || Indicates a friendly encounter sequence.<br/>(This appears to just keep the player's weapons lowered.)
|-
| citizens_passive {{not in FGD}} || Citizens are *not* player allies (cannot be commanded) || Makes citizens neutral to the Combine and the player.<br/>(also done by <code>gordon_precriminal</code>)
|-
| gordon_invulnerable || Gordon is invulnerable || Makes the player invulnerable to damage.<br/>(Retains knockback, view punches, etc. unlike [[god]] mode)
|-
| no_seagulls_on_jeep || Don't spawn seagulls on the jeep || Prevents [[npc_seagull|seagulls]] from spawning on the jeep.
|-
| ep2_alyx_injured || Episode 2: Alyx injured || {{EP2 add}} Episodic only. Invokes Alyx's "injured" behavior:
*Triples bullet spread for {{ent|weapon_alyxgun}}
*Increases time between shots
{{note|This applies to all NPCs with a <code>weapon_alyxgun</code>, not just Alyx.}}
|-
| ep_alyx_darknessmode || Episodic: Alyx darkness mode || {{EP1 add}} Episodic only. Enables "darkness mode", as seen during the "Lowlife" chapter of [[Episode One]].<br/>Despite the name, this also affects the player, zombies, and even fires in various ways to make them more suitable for darkness.
|-
| hunters_to_run_over || Ep2 Counter: Hunters to run over before they dodge || {{EP2 add}} Episodic only. The number of hunters that should be ran over before they start dodging vehicles.<br/>By default, hunters will try to dodge incoming vehicles.<br/>If this global is declared and its counter is greater than 0, hunters will not try to dodge incoming vehicles.<br/>Instead, this global's counter will decrement by 1 each time a hunter is killed by a vehicle.<br/>When it reaches 0, hunters will return to dodging vehicles.
|}

=== {{css}} [[Counter-Strike: Source]],<br>{{csgo}} [[Counter-Strike: Global Offensive]] ===
{| class="wikitable"
! Internal Name || Editor Name || Description
|-
| is_pc || Game is running on a PC || Whether the game is running on a PC.
|-
| is_console || Game is running on a console || Whether the game is running on a console.{{clarify}}
|}

=== {{portal2}} [[Portal 2]] {{not in FGD}} ===
{| class="wikitable"
|-
! Internal Name || Editor Name || Description
|-
| portalgun_nospawn || Spawn without Portalgun || Disables the player recieving the [[weapon_portalgun|Portal Gun]] on spawn.
{{note|Used in <code>mp_coop_start</code>, but doesn't seem to do anything. See [[weapon_portalgun#Spawning with a portal gun|here]] for how to prevent the player from spawning with a portal gun.}}
|-
| no_pinging_blue || Prevent Pinging ATLAS || In Co-op, prevents ATLAS (blue ballbot) from using their Ping Tool.
|-
| no_pinging_orange || Prevent Pinging P-Body || In Co-op, prevents P-Body (orange eggbot) from using their Ping Tool.
|-
| no_taunting_blue || Prevent Taunting ATLAS || In Co-op, prevents ATLAS (blue ballbot) from performing gestures.
|-
| no_taunting_orange || Prevent Taunting P-Body || In Co-op, prevents P-Body (orange eggbot) from performing gestures.
|}
{{Note|{{p2ce}} has support for both {{p2}} and {{hl2}} global states, but only {{p2}} are in the FGD}}

=== {{bms}} [[Black Mesa (Source)|Black Mesa]] ===
{| class="wikitable"
|-
! Internal Name || Editor Name || Description
|-
| predisaster || Pre-Disaster || {{todo|Probably used for pre-disaster NPC behavior, figure out exactly what it does.}}
|-
| friendly_encounter || Friendly encounter sequence (lower weapons, etc.) || Indicates a friendly encounter sequence.<br/>(This appears to just keep the player's weapons lowered.)
|-
| gordon_invulnerable || Gordon is invulnerable || Makes the player invulnerable to damage.<br/>(Retains knockback, view punches, etc. unlike [[god]] mode)
|}

{{todo|There may be more of these in other games.}}

{{KV Targetname}}
{{KV|Initial State|choices|intn=initialstate|Used by <code>Set Initial State</code> to determine what the global state should be set to when the map starts.
:*0: Off
:*1: On
:*2: Dead
}}
{{KV|Counter|since=EP2|int|intn=counter|An integer counter value associated with this global.
{{bug|There is an aliasing problem for this keyvalue (keyvalue and output have the same name). To make it work, simply change its name in the source code DEFINE_OUTPUT declaration.}}}}

==Inputs==
{{IO|TurnOn|Sets the global's state to ON.}}
{{IO|TurnOff|Sets the global's state to OFF.}}
{{IO|Toggle|Switches state of the global between ON and OFF.}}
{{IO|Remove|Set state of global to DEAD.}}
{{IO|AddToCounter|param=int|Adds the specified amount to the counter.|since=EP2}}
{{IO|SetCounter|param=int|Sets the value of the counter.|since=EP2}}
{{IO|GetCounter|Fires this entity's <code>Counter</code> output.|since=EP2}}

==Outputs==
{{IO|Counter|param=int|Outputs the integer value of this entity. May depend on global state.|since=EP2}}