Dod capture area: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
 
(25 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{dods brush|dod_capture_area}}
{{tabs|dod_capture_area|goldsrc = 1|source = 1|main = source}}
{{CD|CAreaCapture|file1=dod/dod_area_capture.cpp|base=CBaseTrigger}}
{{this is a|brush entity|name=dod_capture_area|game=Day of Defeat: Source}}


==Entity Description==
This brush entity represents the area where the player(s) must stand to start capturing the flag.
Capture area. This entity is the area where the player(s) must stand in order to start capturing the flag.


==Keyvalues==
==Key Values==
* {{KV Targetname}}
{{otherKIO|trigger|append=Functionality of KVs and I/O not mentioned here is not guaranteed.}}
* {{KV EnableDisable}}
{{KV Targetname}}
* '''area_allies_cancap'''
{{KV StartDisabled}}
: {{boolean}} Can Allies Cap?
{{KV|Can Allies Cap?|intn=area_allies_cancap|bool|}}
* '''area_axis_cancap'''
{{KV|Can Axis Cap?|intn=area_axis_cancap|bool|Select if Allied or Axis players can capture the flag, respectively.}}
: {{boolean}} Can Axis Cap?
{{KV|Number of Allies to cap|intn=area_allies_numcap|int|}}
* '''area_allies_numcap'''
{{KV|Number of Axis to cap|intn=area_axis_numcap|int|The number of Allied or Axis players needed to capture the flag, respectively.{{bug|hidetested=1|Client game crash if you set above 5. The limit is supposed to be 9.}}}}
: <integer> Number of Allies to cap
{{KV|Time to cap (sec)|intn=area_time_to_cap|float|Time to capture the flag, in seconds.}}
* '''area_axis_numcap'''
{{KV|Name of the control point this area is linked to|intn=area_cap_point|target_destination|Name of the {{ent|dod_control_point}} entity this area is linked to.}}
: <integer> Number of Axis to cap
* '''area_time_to_cap'''
: <integer> Time to cap (sec)
* '''area_cap_point'''
: <target_destination> Name of the control point this area is linked to


==Inputs==
==Inputs==
*{{I Targetname}}
{{I|RoundInit|nofgd=1|Re-parse the {{mono|area_allies_numcap}}, {{mono|area_allies_numcap}}, and {{mono|area_time_to_cap}} KVs. Use this if they are changed via [[AddOutput]].}}
*{{I EnableDisable}}
{{I EnableDisable}}


==Outputs==
==Outputs==
*{{O Targetname}}
{{note|The [[!activator]] and [[!caller]] for all outputs is this entity.}}
* '''OnAlliesStartCap'''
{{O|OnAlliesStartCap / OnAxisStartCap|Sent when Allies or Axis start capture, respectively.}}
: Sent when Allies start capture
{{O|OnAlliesBreakCap / OnAxisBreakCap|Sent when Allies or Axis break capture, respectively.}}
* '''OnAlliesBreakCap'''
{{O|OnAlliesEndCap / OnAxisEndCap|Sent when Allies or Axis end capture, respectively.}}
: Sent when Allies break capture
{{O|OnStartCap|Sent when either team starts capture.|}}
* '''OnAlliesEndCap'''
{{O|OnBreakCap|Sent when either team break capture.|}}
: Sent when Allies end capture
{{O|OnEndCap|Sent when either team end capture.|}}
* '''OnAxisStartCap'''
: Sent when Axis start capture
* '''OnAxisBreakCap'''
: Sent when Axis break capture
* '''OnAxisEndCap'''
: Sent when Axis end capture
* '''OnStartCap'''
: Sent when either team starts capture
* '''OnBreakCap'''
: Sent when either team break capture
* '''OnEndCap'''
: Sent when either team end capture

Latest revision as of 06:45, 4 June 2025

C++ Class hierarchy
CAreaCapture
CBaseTrigger
CBaseToggle
CBaseEntity
C++ dod/dod_area_capture.cpp

dod_capture_area is a brush entity available in Day of Defeat: Source Day of Defeat: Source.

This brush entity represents the area where the player(s) must stand to start capturing the flag.

Key Values

Note.pngNote:Other Keyvalues / Inputs / Outputs are same as trigger.
Functionality of KVs and I/O not mentioned here is not guaranteed.
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

Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).
Can Allies Cap? (area_allies_cancap) <boolean>
Can Axis Cap? (area_axis_cancap) <boolean>
Select if Allied or Axis players can capture the flag, respectively.
Number of Allies to cap (area_allies_numcap) <integer>
Number of Axis to cap (area_axis_numcap) <integer>
The number of Allied or Axis players needed to capture the flag, respectively.
Icon-Bug.pngBug:Client game crash if you set above 5. The limit is supposed to be 9.
Time to cap (sec) (area_time_to_cap) <float>
Time to capture the flag, in seconds.
Name of the control point this area is linked to (area_cap_point) <targetname>
Name of the dod_control_point entity this area is linked to.

Inputs

RoundInit  !FGD
Re-parse the area_allies_numcap, area_allies_numcap, and area_time_to_cap KVs. Use this if they are changed via AddOutput.

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.

Outputs

Note.pngNote:The !activator and !caller for all outputs is this entity.
OnAlliesStartCap / OnAxisStartCap
Sent when Allies or Axis start capture, respectively.
OnAlliesBreakCap / OnAxisBreakCap
Sent when Allies or Axis break capture, respectively.
OnAlliesEndCap / OnAxisEndCap
Sent when Allies or Axis end capture, respectively.
OnStartCap
Sent when either team starts capture.
OnBreakCap
Sent when either team break capture.
OnEndCap
Sent when either team end capture.