Difference between revisions of "Env global"

From Valve Developer Community
Jump to: navigation, search
(Keyvalues)
({{hl2}} Half-Life 2: The super gravity gun code was stripped out of HL2DM)
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{toc-right}}
+
{{lang|Env global}}
 +
{{Entity also in GoldSrc}}
 +
[[File:Env global.png|left]]
 +
{{base point|env_global}} It controls game-specific global states, such as whether the [[weapon_physcannon|gravity gun]] should become the super gravity gun in HL2.
  
[[File:Env global.png|left]]
+
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]].
 +
 
 +
{{code class|CEnvGlobal|logicentities.cpp}}
  
{{base point|env_global}} It controls game-specific global states, such as whether the [[weapon_physcannon|gravity gun]] should become the super gravity gun in HL2.
+
==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}}
  
For this entity to take effect from the map's start, the '''Set Initial State''' [[flag]] must be checked.
+
==Flags==
 +
*1: Set Initial State - Whether this entity defines the global state when the map starts.
  
 
==Keyvalues==
 
==Keyvalues==
 +
{{KV|Global State to Set (globalstate)|choices|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|Doesn't work in [[Half-Life 2: Deathmatch]] due to the supercharged gravity gun being removed.}}
 +
|-
 +
| 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.
 +
|}
 +
 +
=== {{portal2}} [[Portal 2]] ===
 +
{| class="wikitable"
 +
|-
 +
! Internal Name || Editor Name || Description
 +
|-
 +
| portalgun_nospawn || Spawn without Portalgun || Disables the player recieving the [[weapon_portalgun|Portal Gun]] on spawn. {{todo|Does this actually work?}}
 +
|-
 +
| 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.
 +
|}
 +
 +
=== {{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)
 +
|}
  
{{KV|Global State to Set|choices|Game-specific global state that this entity sets. In practice all of Valve's FGDs include the HL2 states regardless of whether the game understands them.
+
{{todo|There may be more of these in other games.}}
:* Gordon pre-criminal
 
:* Antlions are player allies
 
:* Suit sprint function not yet enabled
 
:* Super phys gun is enabled {{note|Doesn't work in HL2:DM.}}
 
  
:* Friendly encounter sequence (lower weapons, etc.)
+
{{KV|Initial State (initialstate)|choices|Used by <code>Set Initial State</code> to determine what the global state should be set to when the map starts.
:* Gordon is invulnerable
+
:*0: Off
:* Don't spawn seagulls on the jeep
+
:*1: On
:* Episode 2: Alyx injured
+
:*2: Dead
:* Episodic: Alyx darkness mode
 
:* Ep2 Counter: Hunters to run over before they dodge
 
}}
 
{{ScrollBox|title=EnvGlobal|
 
{{KV|Initial State|choices|Whether the entity should be active when the map starts.
 
:* Off
 
:* On
 
:* Dead ({{todo|What does that mean?}})
 
}}
 
{{KV|Counter|int|An integer counter value associated with this global.|since=EP2}}
 
{{bug|There is an aliasing problem for this keyvalue. To make it work, simply change its name in the source code DEFINE_OUTPUT declaration.}}
 
{{KV Targetname}}
 
 
}}
 
}}
 +
{{KV|Counter (counter)|since=EP2|int|An integer counter value associated with this global.
  
== Flags ==
+
{{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.}}}}
 
+
{{KV BaseEntity|css=1}}
* Set Initial State: Whether this entity defines the global state when the map starts.
 
  
 
==Inputs==
 
==Inputs==
 
+
{{IO|TurnOn|Sets the global's state to ON.}}
{{ScrollBox|title=EnvGlobal|noscroll=true|
+
{{IO|TurnOff|Sets the global's state to OFF.}}
{{IO|TurnOn / TurnOff|Sets the global's state.}}
+
{{IO|Toggle|Switches state of the global between ON and OFF.}}
{{IO|Toggle|Toggles state of global between ON and OFF.}}
 
 
{{IO|Remove|Set state of global to DEAD.}}
 
{{IO|Remove|Set state of global to DEAD.}}
 
{{IO|AddToCounter|param=int|Adds the specified amount to the counter.|since=EP2}}
 
{{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|SetCounter|param=int|Sets the value of the counter.|since=EP2}}
{{IO|GetCounter|: Fires this entity's Counter output.|since=EP2}}
+
{{IO|GetCounter|Fires this entity's <code>Counter</code> output.|since=EP2}}
{{I Targetname}}
+
{{I BaseEntity|prel4d=1}}
}}
 
  
 
==Outputs==
 
==Outputs==
 
+
{{IO|Counter|param=int|Outputs the integer value of this entity. May depend on global state.|since=EP2}}
{{ScrollBox|title=EnvGlobal|
+
{{O Targetname|l4d=1}}
{{IO|counter|param=int|Outputs the integer value of this entity. May depend on global state.|since=EP2}}
 
{{O Targetname}}
 
}}
 
 
 
[[Category:Entities]]
 

Latest revision as of 12:24, 19 December 2020

 English 
Env global.png

env_global is a point entity available in all Source games. It controls game-specific global states, such as whether the gravity gun should become the super gravity gun in HL2.

Global states persist across level transitions, regardless of their status. Global states are not stored until an env_global receives any commands that modify the state, such as turning it on or off or changing the counter. Use the Set Initial State 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 Remove 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.

In code, it is represented by theCEnvGlobalclass, defined in thelogicentities.cppfile.

ConVars/Commands

ConVar/CommandParameters or default valueDescriptorEffect
dump_globalsDumps data for all set global states.
global_setglobalname stateSet 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.

Flags

  • 1: Set Initial State - Whether this entity defines the global state when the map starts.

Keyvalues

Global State to Set (globalstate) <choices>
The global state this entity is linked to. Valve's FGDs 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.

<Half-Life 2> Half-Life 2

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 bugbait, as seen in the Nova Prospekt chapters.
suit_no_sprint Suit sprint function not yet enabled Disables the HEV suit's sprint function.
(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.
Note.png Note: Doesn't work in Half-Life 2: Deathmatch due to the supercharged gravity gun being removed.
friendly_encounter Friendly encounter sequence (lower weapons, etc.) Indicates a friendly encounter sequence.
(This appears to just keep the player's weapons lowered.)
citizens_passive !FGD Citizens are *not* player allies (cannot be commanded) Makes citizens neutral to the Combine and the player.
(also done by gordon_precriminal)
gordon_invulnerable Gordon is invulnerable Makes the player invulnerable to damage.
(Retains knockback, view punches, etc. unlike god mode)
no_seagulls_on_jeep Don't spawn seagulls on the jeep Prevents seagulls from spawning on the jeep.
ep2_alyx_injured Episode 2: Alyx injured (in all games since <Half-Life 2: Episode Two><Half-Life 2: Episode Two>) Episodic only. Invokes Alyx's "injured" behavior:
Note.png Note: This applies to all NPCs with a weapon_alyxgun, not just Alyx.
ep_alyx_darknessmode Episodic: Alyx darkness mode (in all games since <Half-Life 2: Episode One><Half-Life 2: Episode One>) Episodic only. Enables "darkness mode", as seen during the "Lowlife" chapter of Episode One.
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 (in all games since <Half-Life 2: Episode Two><Half-Life 2: Episode Two>) Episodic only. The number of hunters that should be ran over before they start dodging vehicles.
By default, hunters will try to dodge incoming vehicles.
If this global is declared and its counter is greater than 0, hunters will not try to dodge incoming vehicles.
Instead, this global's counter will decrement by 1 each time a hunter is killed by a vehicle.
When it reaches 0, hunters will return to dodging vehicles.

[Portal 2] Portal 2

Internal Name Editor Name Description
portalgun_nospawn Spawn without Portalgun Disables the player recieving the Portal Gun on spawn. To do: Does this actually work?
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.

<Black Mesa (Source)> Black Mesa

Internal Name Editor Name Description
predisaster Pre-Disaster To do: 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.
(This appears to just keep the player's weapons lowered.)
gordon_invulnerable Gordon is invulnerable Makes the player invulnerable to damage.
(Retains knockback, view punches, etc. unlike god mode)

To do: There may be more of these in other games.


Initial State (initialstate) <choices>
Used by Set Initial State to determine what the global state should be set to when the map starts.
  • 0: Off
  • 1: On
  • 2: Dead
Counter (counter) <integer> (in all games since <Half-Life 2: Episode Two><Half-Life 2: Episode Two>)
An integer counter value associated with this global.
Bug.png 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.


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.png Tip: Entities transition to the next map with their parents
Tip.png Tip: phys_constraintcan be used as a workaround if parenting fails.
Global Entity Name (globalname) <string>
When the player transitions to a new map, entities in the new map with matching globalnames will have their previous map's states copied over to it.
Origin (X Y Z) (origin) <coordinates>
The position of this entity's center in the world. Rotating entities typically rotate around their origin.
Note.png 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.png Note: This works on brush entities, although Hammer doesn't show the new angles.
Response Contexts (ResponseContext) <string>
Pre-defined response system contexts; Format is [key]:[value],[key]:[value],...and so on.
Tip.png Tip: Can also be filtered for or against!
Classname (classname) <string> !FGD
Determines the characteristics of the entity before it spawns.
Tip.png Tip: Changing classnames using theAddOutputinput can still influence the game's code, like making the classname match one element in the S_PreserveEnts list will make the entity persists 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.
Hammer ID (hammerid) <integer> !FGD
The entity's unique Hammer ID that's auto-generated on map compiles. Mainly used by plugins or debugging commands (like theent_keyvaluecommand). Run-time spawned entities don't have a Hammer ID.
Entity Scripts (vscripts) <scriptlist> (in all games since <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> (in all games since <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. Try to avoid expensive operations in this function, as it may cause performance problems.
Lag Compensation (LagCompensate) <boolean> (in all games since <Left 4 Dead 2>) !FGD
Set to Yes to lag compensate this entity. Should be used very sparingly!
Disable for Xbox 360 (disableX360) <boolean> (in all games since <Left 4 Dead 2>) !FGD
If this entity should automatically be given the 'Disable' input on the Xbox 360 version of Source.
Is Automatic-Aim Target (is_autoaim_target) <boolean> (in all games since Counter-Strike: Global Offensive) !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

TurnOn
Sets the global's state to ON.
TurnOff
Sets the global's state to OFF.
Toggle
Switches state of the global between ON and OFF.
Remove
Set state of global to DEAD.
AddToCounter <integer> (in all games since <Half-Life 2: Episode Two><Half-Life 2: Episode Two>)
Adds the specified amount to the counter.
SetCounter <integer> (in all games since <Half-Life 2: Episode Two><Half-Life 2: Episode Two>)
Sets the value of the counter.
GetCounter  (in all games since <Half-Life 2: Episode Two><Half-Life 2: Episode Two>)
Fires this entity's Counter output.

Base:

AddOutput <string>
Evaluates a keyvalue/output on this entity.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
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.
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.
ClearParent
Removes this entity from the the movement hierarchy, leaving it free to move independently.
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
AddContext <string>
Adds to the entity's list of response contexts. Format is <key>:<value>.
RemoveContext <string>
Remove a context from this entity's list. The name should match the key of an existing context.
ClearContext <string>
Removes all contexts from this entity's list.
DispatchEffect <string> (removed since <Left 4 Dead>) !FGD
Dispatches a special effect from the entity's origin. Removed and replaced entirely by the particle system since <Left 4 Dead>.
DispatchResponse <string> !FGD
Dispatches a response to the entity. See Response and Concept.
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> (in all games since <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> (in all games since <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.png 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.png 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> (in all games since <Left 4 Dead 2>) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (in all games since <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> (in all games since <Alien Swarm>) !FGD
Set this entity's angles.


Outputs

Counter <integer> (in all games since <Half-Life 2: Episode Two><Half-Life 2: Episode Two>)
Outputs the integer value of this entity. May depend on global state.

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 <Left 4 Dead> <Left 4 Dead 2>)
This output fires when the entity is killed and removed from the game.