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

Game zone player: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
m (Fix partial rewrite of partial rewrite (i messed up a lil))
 
(24 intermediate revisions by 17 users not shown)
Line 1: Line 1:
{{wrongtitle|title=game_zone_player}}
<!-- When this page is updated to {{langsp}} or {{langsp}} instead of {{lang}}, please move {{this is a}} to the base page, as it is automatically translated. -->{{LanguageBar}}{{CD2|CGamePlayerZone|file1=maprules.cpp}}
{{base_brush}}
{{this is a|brush entity|name=game_zone_player}} It is used to count the number of players, dead or alive, within the volume of the brush.  
 
{{tip|This entity fires per client, making it useful for multiplayer maps which wants to globally fire per client outputs to each individual player all on the same tick.}}
==Entity Description==
__NOTOC__
A [[brush entity]] used to count the number of players, dead or alive, within the volume of the brush.  
 
{{sensor_brush}}
 
{{in code|class=class_c_game_player_zone.html CGamePlayerZone|file=maprules_8cpp-source.html maprules.cpp}}
 
==Keyvalues==
==Keyvalues==
*{{kv targetname}}
{{KV Targetname}}
*{{kv parentname}}


<!--no flags-->
==Inputs==
==Inputs==
*{{i targetname}}
{{I|CountPlayersInZone|Count the number of players in the zone, and fire the corresponding outputs.}}
*{{i parentname}}
*'''CountPlayersInZone'''
:Count the number of players in the zone, and fire the corresponding outputs.


==Outputs==
==Outputs==
*{{o targetname}}
{{O|OnPlayerInZone|Fired whenever a count finds a player inside the zone. {{PlAct}}|param=void}}
*'''OnPlayerInZone'''
{{O|OnPlayerOutZone|Fired whenever a count finds a player outside the zone. {{PlAct}}|param=void}}
:Fired whenever a count finds a player inside the zone. {{plact}}
{{O|PlayersInCount|Fired after a count, and contains the number of players found inside the zone.|param=integer}}
*'''OnPlayerOutZone'''
{{O|PlayersOutCount|Fired after a count, and contains the number of players found outside the zone.|param=integer}}
:Fired whenever a count finds a player outside the zone. {{plact}}
 
*'''PlayersInCount <integer>'''
== See Also ==
:Fired after a count, and contains the number of players found inside the zone.
* {{ent|trigger_multiple}}
*'''PlayersOutCount <integer>'''
 
:Fired after a count, and contains the number of players found outside the zone.
{{sensor brush}}

Latest revision as of 16:15, 18 July 2025

English (en)Translate (Translate)
C++ class hierarchy
CGamePlayerZone defined in C++ maprules.cpp
↳CRuleBrushEntity
↳CRuleEntity
↳CBaseEntity

game_zone_player is a brush entity available in all Source Source games. It is used to count the number of players, dead or alive, within the volume of the brush.

Tip.pngTip:This entity fires per client, making it useful for multiplayer maps which wants to globally fire per client outputs to each individual player all on the same tick.

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

Inputs

CountPlayersInZone
Count the number of players in the zone, and fire the corresponding outputs.

Outputs

OnPlayerInZone <void>
Fired whenever a count finds a player inside the zone. (!activator is the player.)
OnPlayerOutZone <void>
Fired whenever a count finds a player outside the zone. (!activator is the player.)
PlayersInCount <integerRedirectOutput/integer>
Fired after a count, and contains the number of players found inside the zone.
PlayersOutCount <integerRedirectOutput/integer>
Fired after a count, and contains the number of players found outside the zone.

See Also

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