Team control point: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(Updated with data from tf-abs.fgd)
Line 1: Line 1:
{{wrongtitle|title=team_control_point}}
[[File:Cappoint.JPG|thumb|Team_Control_Point is an entity used to make capture points]]
{{Tf2 point}}
{{TOC|left}}
[[Image:Cappoint.JPG|thumb|Team_Control_Point is an entity used to make capture points]]{{clr}}


== Entity description ==
{{tf2 point|team_control_point}}
 
==Entity description==
Designates the location of a [[Creating a Capture Point|capture point]]; use in conjunction with [[trigger_capture_area]].
Designates the location of a [[Creating a Capture Point|capture point]]; use in conjunction with [[trigger_capture_area]].


== Keyvalues ==
==Keyvalues==
* {{KV Targetname}}
{{KV Targetname}}
* {{KV Angles}}
{{KV Parentname}}
* {{KV EnableDisable}}
{{KV Angles}}
* '''point_printname'''
{{KV EnableDisable}}
: <string> Localized name to print on the HUD.
{{KV|Start locked|boolean|Locked means the point will not be available for capture until it is unlocked via its input.}}
* '''point_group'''
{{KV|Print Name|string|LOCALIZED name to print on the HUD.}}
: <integer> Used for grouping points together under a [[team_control_point_master]] (not using control point rounds).
{{KV|Group Index|integer|Used for grouping points together under a team_control_point_master (not using control point rounds).}}
* '''point_default_owner'''
{{KV|Default Owner|choices|Default Owner of the control point.}}
: <integer> Default Owner of the control point. 0 = neutral, 2 = red, 3 = blu
:* 0 : Neither
* '''point_index'''
:* 2 : Red
: <integer> Index of this point (must be unique).
:* 3 : Blue
* '''point_warn_on_cap'''
{{KV|Index|integer|Index of this point (must be unique).}}
: <integer> Warn the team that owns the control point when the opposing team starts to capture it. 0 = no, 1 = yes.
{{KV|Warning Type|choices|Type of warning to issue to the team that owns the control point when the opposing team starts to capture it.}}
* '''point_warn_sound'''
:* 0 : Normal Announcements
: <sound> Sound to be played when this point is being captured (if warn on capture is set).
:* 1 : Final Capture Point Warning
* '''random_owner_on_restart'''
:* 2 : No Announcements
: <integer> Randomly set the owner of this point during a full restart of the map. The ratio of default owners among the points with this flag will be kept when selecting random owners. 0 = no, 1 = yes.
{{KV|Warning sound|string|Sound to be played when this point is being captured (if warn on capture is set).}}
* '''team_timedpoints_2'''
{{KV|Randomly set the owner on restart|boolean|Randomly set the owner of this point during a full restart of the map. The ratio of default owners among the points with this flag will be kept when selecting random owners.}}
: <integer> Time-based point value for RED.
{{KV|Time-based point value for RED.|integer}}
* '''team_timedpoints_3'''
{{KV|Time-based point value for BLUE.|integer}}
: <integer> Time-based point value for BLU.
{{KV|Reset Model|studio|Model when point is unowned.}}
* '''team_capsound_0'''
{{KV|RED Model|studio|Model when RED owns the point.}}
: <sound> Sound made when point resets.
{{KV|BLUE Model|studio|Model when BLUE owns the point.}}
* '''team_capsound_2'''
{{KV|Reset model bodygroup|integer}}
: <sound> Sound made when RED captures.
{{KV|RED model bodygroup|integer}}
* '''team_capsound_3'''
{{KV|BLUE model bodygroup|integer}}
: <sound> Sound made when BLU captures.
{{KV|HUD icon neutral|material|HUD icon material when no one owns the point.}}
* '''team_model_0'''
{{KV|HUD icon RED|material|HUD icon material when RED owns the point.}}
: <model> Model when point reset.
{{KV|HUD icon BLUE|material|HUD icon material when BLUE owns the point.}}
* '''team_model_2'''
: <model> Model when RED owns the point.
* '''team_model_3'''
: <model> Model when BLU owns the point.
* '''team_bodygroup_0'''
: <integer> Reset model bodygroup.
* '''team_bodygroup_2'''
: <integer> RED model bodygroup.
* '''team_bodygroup_3'''
: <integer> BLU model bodygroup.
* '''team_icon_0'''
: <material> HUD icon material when no one owns the point.
* '''team_icon_2'''
: <material> HUD icon material when RED owns the point.
* '''team_icon_3'''
: <material> HUD icon material when BLU owns the point.
* '''team_overlay_0'''
: <material> HUD material that will overlay the icon when no one owns the point.
* '''team_overlay_2'''
: <material> HUD material that will overlay the icon when RED owns the point.
* '''team_overlay_3'''
: <material> HUD material that will overlay the icon when BLU owns the point.
* '''team_previouspoint_2_0'''
: <target_destination> The name of a previous capture point that RED must own to be able to capture this point. If empty, the team must own all points preceding this one.
* '''team_previouspoint_2_1'''
: <target_destination> The name of a second previous capture point that RED must own to be able to capture this point.
* '''team_previouspoint_2_2'''
: <target_destination> The name of a third previous capture point that RED must own to be able to capture this point.
* '''team_previouspoint_3_0'''
: <target_destination> The name of a previous capture point that BLU must own to be able to capture this point. If empty, the team must own all points preceding this one.
* '''team_previouspoint_3_1'''
: <target_destination> The name of a second previous capture point that BLU must own to be able to capture this point.
* '''team_previouspoint_3_2'''
: <target_destination> The name of a third previous capture point that BLU must own to be able to capture this point.


== Flags ==
==Flags==
* 1 : Hide control point on [[HUD]]
* 1 : Hide Control Point on HUD
* 2 : Start with model hidden
* 2 : Start with model hidden
* 4 : Disable shadow
* 4 : Disable shadow
* 8 : Disable sounds


== Inputs ==
==Inputs==
* {{I Targetname}}
{{I Targetname}}
* {{I EnableDisable}}
{{I Parentname}}
* '''SetOwner'''
{{I Angles}}
: <integer> Sets the owner of the entity. (0 = none, 2 = red, 3 = blu)
{{I EnableDisable}}
* '''HideModel'''
{{IO|SetOwner|Set the owner of the point.|param=integer}}
: Hide the model of the capture point.
{{IO|HideModel|Hide the control point model.}}
* '''ShowModel'''
{{IO|ShowModel|Show the control point model again.}}
: Shows the model of the capture point again.
{{IO|SetLocked|Lock the control point. 0 {{=}} unlocked, 1 {{=}} locked|param=integer}}
{{IO|SetUnlockTime|This will automatically unlock the control point in the specified amound of time (seconds).|param=integer}}


== Outputs ==
==Outputs==
* {{O Targetname}}
{{O Targetname}}
* '''OnOwnerChangedToTeam1'''
{{IO|OnOwnerChangedToTeam1|Sent when owner is changed to RED.}}
: Sent when owner is changed to RED.
{{IO|OnOwnerChangedToTeam2|Sent when owner is changed to BLUE.}}
* '''OnOwnerChangedToTeam2'''
{{IO|OnCapReset|Sent when owner is changed to neutral.}}
: Sent when owner is changed to BLU.
{{IO|OnRoundStartOwnedByTeam1|Sent when a round is starting and the point is owned by RED.}}
* '''OnCapTeam1'''
{{IO|OnRoundStartOwnedByTeam2|Sent when a round is starting and the point is owned by BLUE.}}
: Sent when RED capture this point.
{{IO|OnCapTeam1|Sent when RED capture this point.}}
* '''OnCapTeam2'''
{{IO|OnCapTeam2|Sent when BLUE capture this point.}}
: Sent when BLU capture this point.
{{IO|OnUnlocked|Sent when point unlocks.}}


== See also ==
== See also ==
Line 102: Line 69:
* [[team_control_point_master]]
* [[team_control_point_master]]
* [[Creating a Capture Point]]
* [[Creating a Capture Point]]
[[Category:Team Fortress 2 Entities]]

Revision as of 22:12, 9 May 2011

Team_Control_Point is an entity used to make capture points

Team Fortress 2 team_control_point is a point entity available in Team Fortress 2 Team Fortress 2.

Entity description

Designates the location of a capture point; use in conjunction with trigger_capture_area.

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

Parentname:
Parent (parentname) <targetname>
Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.
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).
Start locked ([todo internal name (i)]) <boolean>
Locked means the point will not be available for capture until it is unlocked via its input.
Print Name ([todo internal name (i)]) <string>
LOCALIZED name to print on the HUD.
Group Index ([todo internal name (i)]) <integer>
Used for grouping points together under a team_control_point_master (not using control point rounds).
Default Owner ([todo internal name (i)]) <choices>
Default Owner of the control point.
  • 0 : Neither
  • 2 : Red
  • 3 : Blue
Index ([todo internal name (i)]) <integer>
Index of this point (must be unique).
Warning Type ([todo internal name (i)]) <choices>
Type of warning to issue to the team that owns the control point when the opposing team starts to capture it.
  • 0 : Normal Announcements
  • 1 : Final Capture Point Warning
  • 2 : No Announcements
Warning sound ([todo internal name (i)]) <string>
Sound to be played when this point is being captured (if warn on capture is set).
Randomly set the owner on restart ([todo internal name (i)]) <boolean>
Randomly set the owner of this point during a full restart of the map. The ratio of default owners among the points with this flag will be kept when selecting random owners.
Time-based point value for RED. ([todo internal name (i)]) <integer>
Time-based point value for BLUE. ([todo internal name (i)]) <integer>
Reset Model ([todo internal name (i)]) <model path>
Model when point is unowned.
RED Model ([todo internal name (i)]) <model path>
Model when RED owns the point.
BLUE Model ([todo internal name (i)]) <model path>
Model when BLUE owns the point.
Reset model bodygroup ([todo internal name (i)]) <integer>
RED model bodygroup ([todo internal name (i)]) <integer>
BLUE model bodygroup ([todo internal name (i)]) <integer>
HUD icon neutral ([todo internal name (i)]) <material>
HUD icon material when no one owns the point.
HUD icon RED ([todo internal name (i)]) <material>
HUD icon material when RED owns the point.
HUD icon BLUE ([todo internal name (i)]) <material>
HUD icon material when BLUE owns the point.

Flags

  • 1 : Hide Control Point on HUD
  • 2 : Start with model hidden
  • 4 : Disable shadow
  • 8 : Disable sounds

Inputs

Parentname:
SetParent <stringRedirectInput/string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <stringRedirectInput/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 <stringRedirectInput/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.

Template:I Angles EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.
SetOwner <integerRedirectInput/integer>
Set the owner of the point.
HideModel
Hide the control point model.
ShowModel
Show the control point model again.
SetLocked <integerRedirectInput/integer>
Lock the control point. 0 = unlocked, 1 = locked
SetUnlockTime <integerRedirectInput/integer>
This will automatically unlock the control point in the specified amound of time (seconds).

Outputs

OnOwnerChangedToTeam1
Sent when owner is changed to RED.
OnOwnerChangedToTeam2
Sent when owner is changed to BLUE.
OnCapReset
Sent when owner is changed to neutral.
OnRoundStartOwnedByTeam1
Sent when a round is starting and the point is owned by RED.
OnRoundStartOwnedByTeam2
Sent when a round is starting and the point is owned by BLUE.
OnCapTeam1
Sent when RED capture this point.
OnCapTeam2
Sent when BLUE capture this point.
OnUnlocked
Sent when point unlocks.

See also