Dod control point: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (note, max 8 cp in map)
(Complete rewrite and update, complied to wiki standards. Added missing informations, removed outdated. Keyvalues and Flags modified.)
Line 2: Line 2:


== Entity description ==
== Entity description ==
This entity is usually represented visually by a flag (but is not required). In turn, it represents a capturable location within the map.{{Note|Maximum is 8 control points in map.}}
This entity is usually represented visually by a flag (but is not required). In turn, it represents a capturable location within the map.
{{Note|This entity works in conjunction with {{ent|Dod_capture_area}}.}}
{{Note|A maximum of 8 control points can be in a single map.}}


== Keyvalues ==
== Keyvalues ==
* {{KV Targetname}}
* {{KV Targetname}}
* {{KV Angles}}
* {{KV EnableDisable}}
* {{KV EnableDisable}}
* {{KV Angles}}
* '''target'''
: <target_destination>
* '''point_name'''
: <string> Control Point Name when referred to
* '''point_printname'''
: <string> Flag name displayed when captured, printed on the hud.
* '''point_pointvalue'''
: <integer> Time based points value
* '''point_points_for_cap'''
: <integer> Points given to capturer
* '''point_team_points'''
: <integer> Points given to team
* '''point_timedpoints_allies'''
: <integer> Points given to allies as they own this flag over time
* '''point_timedpoints_axis'''
: <integer> Points given to axis as they own this flag over time
* '''point_default_owner'''
: <choices> Default owner of the control point
:{| class=standard-table
!| Value || Description
|-
| 0 || Neither/Neutral
|-
| 2 || Allies
|-
| 3 || Axis
|}
* '''point_axis_capsound'''
: <sound> Sound made when axis captures
* '''point_allies_capsound'''
: <sound> Sound made when allies captures
* '''point_resetsound'''
: <sound> Sound made when point resets
* '''point_allies_model'''
: <studio> Model when allies own point


* '''point_allies_model_bodygroup'''
{{KV|LOCALIZED name to print on the hud|intn=point_printname|string|The control point name displayed on the Hud when captured. Should be a localized text.}}
: <integer> Allies model bodygroup (Flag.mdl by default > 0 : Axis (Red), 1 : US (Green), 2 : GB (Blue), 3 : Blank (White))
{{KV|Time based point value for Allies|intn=point_timedpoints_allies|float|Points given to allies as they own this flag over time.}}
{{KV|Time based point value for Axis|intn=point_timedpoints_axis|float|Points given to axis as they own this flag over time.}}


* '''point_axis_model'''
{{KV|Default Owner of the control point|intn=point_default_owner|choices|The default owner of this control point at round start.
: <studio> Model when axis own point
:* Neither (default value)
:* Allies
:* Axis}}


* '''point_axis_model_bodygroup'''
{{KV|Sound Made when Axis captures|intn=point_axis_capsound|sound|Sound made when axis captures. Default value used by Valve is "<code>Voice.German_FlagCapture</code>"}}
: <integer> Axis model bodygroup (Flag.mdl by default > 0 : Axis (Red), 1 : US (Green), 2 : GB (Blue), 3 : Blank (White))
{{KV|Sound Made when Allies captures|intn=point_allies_capsound|sound|Sound made when allies captures. Default value used by Valve is "<code>Voice.US_FlagCapture</code>"}}
{{KV|Sound Made when point resets|intn=point_resetsound|sound|Sound made when point resets.}}


* '''point_reset_model'''
: <studio> Model when point reset


* '''point_reset_model_bodygroup'''
{{KV|Allies Model|intn=point_allies_model|string|Model when allies own point. Avoid change unless you know what you are doing.}}
: <integer> reset model bodygroup (Flag.mdl by default > 0 : Axis (Red), 1 : US (Green), 2 : GB (Blue), 3 : Blank (White))
{{KV|Allies model bodygroup|intn=point_allies_model_bodygroup|float|Allies model bodygroup. Default value used by Valve is "1". Avoid change unless you know what you are doing.}}
{{KV|Axis Model|intn=point_axis_model|string|Model when axis own point. Avoid change unless you know what you are doing.}}
{{KV|Axis model bodygroup|intn=point_axis_model_bodygroup|float|Axis model bodygroup. Default value used by Valve is "0". Avoid change unless you know what you are doing.}}
{{KV|Reset Model|intn=point_reset_model|string|Reset model when point reset or nobody own the point. Avoid change unless you know what you are doing.}}
{{KV|Reset model bodygroup|intn=point_reset_model_bodygroup|float|Reset model bodygroup. Default value used by Valve is "3". Avoid change unless you know what you are doing.}}


* '''point_group'''
: <string> Group Name


* '''point_index'''
{{KV|Group Index|intn=point_group|float|}}
: <integer> Point Index - must be unique over the map (1 to 8)
{{KV|Index of this point (unique)|intn=point_index|float|The unique number of this control point to refer {{ent|Dod_capture_area}}.}}


* '''point_hud_icon_neutral'''
: <material> Hud icon material when noone owns point


* '''point_hud_icon_axis'''
{{KV|Hud icon material when nobody owns point|intn=point_hud_icon_neutral|material|The [[material]] to show on the Hud when nobody owns the point.}}
: <material> Hud icon material when axis owns point
{{KV|Hud icon material when Axis owns point|intn=point_hud_icon_axis|material|The [[material]] to show on the Hud when Axis owns the point.}}
{{KV|Hud icon material when Allies owns point|intn=point_hud_icon_allies|material|The [[material]] to show on the Hud when Allies owns the point.}}
{{KV|Hud icon - Bomb planted|intn=point_hud_icon_timercap|material|The [[material]] to show on the Hud when nobody owns the point.}}
{{KV|Hud icon - Point destroyed|intn=point_hud_icon_bombed|material|The [[material]] to show on the Hud when nobody owns the point.}}


* '''point_hud_icon_allies'''
: <material> Hud icon material when allies owns point


* '''point_win_string'''
{{KV|Number of Bombs required to destroy|intn=point_num_bombs|choices|The number of bomb required to destroy the point, if used as a bomb objective. Ignore if used as a flag.
: <string> String to show when capped
:* 0 (default value)
:* 1
:* 2
:* 3}}


== Flags ==
== Flags ==
* 1 : Hide Control Point on HUD
* 1 : Hide Control Point on HUD
* 2: Start with model hidden
* 4: Give tick points for bombs remaining


== Inputs ==
== Inputs ==

Revision as of 20:33, 26 September 2022

Template:Dods point

Entity description

This entity is usually represented visually by a flag (but is not required). In turn, it represents a capturable location within the map.

Note.pngNote:This entity works in conjunction with Dod_capture_area.
Note.pngNote:A maximum of 8 control points can be in a single map.

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

Pitch Yaw Roll (Y Z X) (angles) <QAngle>
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.
Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).


LOCALIZED name to print on the hud (point_printname) <string>
The control point name displayed on the Hud when captured. Should be a localized text.
Time based point value for Allies (point_timedpoints_allies) <float>
Points given to allies as they own this flag over time.
Time based point value for Axis (point_timedpoints_axis) <float>
Points given to axis as they own this flag over time.


Default Owner of the control point (point_default_owner) <choices>
The default owner of this control point at round start.
  • Neither (default value)
  • Allies
  • Axis


Sound Made when Axis captures (point_axis_capsound) <sound>
Sound made when axis captures. Default value used by Valve is "Voice.German_FlagCapture"
Sound Made when Allies captures (point_allies_capsound) <sound>
Sound made when allies captures. Default value used by Valve is "Voice.US_FlagCapture"
Sound Made when point resets (point_resetsound) <sound>
Sound made when point resets.


Allies Model (point_allies_model) <string>
Model when allies own point. Avoid change unless you know what you are doing.
Allies model bodygroup (point_allies_model_bodygroup) <float>
Allies model bodygroup. Default value used by Valve is "1". Avoid change unless you know what you are doing.
Axis Model (point_axis_model) <string>
Model when axis own point. Avoid change unless you know what you are doing.
Axis model bodygroup (point_axis_model_bodygroup) <float>
Axis model bodygroup. Default value used by Valve is "0". Avoid change unless you know what you are doing.
Reset Model (point_reset_model) <string>
Reset model when point reset or nobody own the point. Avoid change unless you know what you are doing.
Reset model bodygroup (point_reset_model_bodygroup) <float>
Reset model bodygroup. Default value used by Valve is "3". Avoid change unless you know what you are doing.


Group Index (point_group) <float>
Index of this point (unique) (point_index) <float>
The unique number of this control point to refer Dod_capture_area.


Hud icon material when nobody owns point (point_hud_icon_neutral) <material>
The material to show on the Hud when nobody owns the point.
Hud icon material when Axis owns point (point_hud_icon_axis) <material>
The material to show on the Hud when Axis owns the point.
Hud icon material when Allies owns point (point_hud_icon_allies) <material>
The material to show on the Hud when Allies owns the point.
Hud icon - Bomb planted (point_hud_icon_timercap) <material>
The material to show on the Hud when nobody owns the point.
Hud icon - Point destroyed (point_hud_icon_bombed) <material>
The material to show on the Hud when nobody owns the point.


Number of Bombs required to destroy (point_num_bombs) <choices>
The number of bomb required to destroy the point, if used as a bomb objective. Ignore if used as a flag.
  • 0 (default value)
  • 1
  • 2
  • 3

Flags

  • 1 : Hide Control Point on HUD
  • 2: Start with model hidden
  • 4: Give tick points for bombs remaining

Inputs

  • RoundInit
Re initializes the round
  • RoundStart
Restarts the round
  • SetTeam <integer> (from TeamNum class)
Used for the filtering of this entity (0=none 2=allies 3=axis)

Outputs

  • OnAlliesCap
Trigger when the allies cap...
  • OnAxisCap
Trigger when the axis cap...
  • OnCapReset
Trigger on round reset