Env global: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(→‎Keyvalues: misread that)
Line 28: Line 28:
}}
}}
{{KV|Counter|int|An integer counter value associated with this global.|since=EP2}}
{{KV|Counter|int|An integer counter value associated with this global.|since=EP2}}
{{KV Targetname}}
{{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}}  
}}
}}



Revision as of 18:15, 2 December 2012

Env global.png

Template:Base point It controls game-specific global states, such as whether the gravity gun should become the super gravity gun in HL2.

For this entity to take effect from the map's start, the Set Initial State flag must be checked.

Keyvalues

Global State to Set ([todo internal name (i)]) <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.
  • Gordon pre-criminal
  • Antlions are player allies
  • Suit sprint function not yet enabled
  • Super phys gun is enabled
  • Friendly encounter sequence (lower weapons, etc.)
  • Gordon is invulnerable
  • Don't spawn seagulls on the jeep
  • Episode 2: Alyx injured
  • Episodic: Alyx darkness mode
  • Ep2 Counter: Hunters to run over before they dodge
EnvGlobal:
Initial State ([todo internal name (i)]) <choices>
Whether the entity should be active when the map starts.
  • Off
  • On
  • Dead (
    Todo: What does that mean?
    )
Counter ([todo internal name (i)]) <integer> (in all games since Half-Life 2: Episode Two)
An integer counter value associated with this global.
Icon-Bug.pngBug:There is an aliasing problem for this keyvalue. To make it work, simply change its name in the source code DEFINE_OUTPUT declaration.  [todo tested in ?]
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

}}

Flags

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

Inputs

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

Outputs

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