Template:KV TeamNum/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
m (→‎Usage: Substituted IO templates)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Doc/subpage}}
{{Main|teamnumber}}
<!-- Please place categories where indicated at the bottom of this page.) -->
<!-- Please place categories where indicated at the bottom of this page.) -->
Display information for the <code style="color:#E5E5E5; background-color: #202020;">TeamNum</code> or <code style="color:#E5E5E5; background-color: #202020;">teamnumber</code> key in a a consistent and easy to use manner. This key exists for all entities inheriting the {{ent|CBaseEntity}} class, but since quite a considerable amount of entities aren't affected by it at all, or in a meaningful enough manner, the information for this key will be documented with this template.
Display information for the <code style="color:#E5E5E5; background-color: #202020;">TeamNum</code> or <code style="color:#E5E5E5; background-color: #202020;">teamnumber</code> key in a a consistent and easy to use manner. This key exists for all entities inheriting the {{ent|CBaseEntity}} class, but since quite a considerable amount of entities aren't affected by it at all, or in a meaningful enough manner, the information for this key will be documented with this template.
Line 8: Line 9:
{{KV TeamNum|tf2=1}}
{{KV TeamNum|tf2=1}}
</pre>
</pre>
{{note|Entities with this template should generally have the following input added below: {{tlx|IO|<nowiki>SetTeam|Sets which team to be aligned with|param=int</nowiki>}}.}}
{{Note|Entities with this template should generally have the following input added below: {{tlx|I|<nowiki>SetTeam|Sets which team to be aligned with|param=int</nowiki>}}.}}


=== Parameters ===
=== Parameters ===
Line 37: Line 38:
<pre>{{KV TeamNum}}</pre>will:
<pre>{{KV TeamNum}}</pre>will:
{{KV TeamNum}}
{{KV TeamNum}}
==See Also==
==See also==
* {{tl|KV BaseEntity}}
* {{tl|KV BaseEntity}}
* {{tl|I BaseEntity}}
* {{tl|I BaseEntity}}

Latest revision as of 17:59, 21 April 2025

Edit-copy.png
This is a documentation subpage for Template:KV TeamNum.
Don't forget to purge the contents of the base page upon creating or editing this subpage.
Main article:  teamnumber

Display information for the TeamNum or teamnumber key in a a consistent and easy to use manner. This key exists for all entities inheriting the CBaseEntity class, but since quite a considerable amount of entities aren't affected by it at all, or in a meaningful enough manner, the information for this key will be documented with this template.

Usage

These must be used in a specific syntax! - ALL parameters must be given a value of 1, like:tf2=1. Only one game parameter can be used at once.

{{KV TeamNum|tf2=1}}
Note.pngNote:Entities with this template should generally have the following input added below: {{I|SetTeam|Sets which team to be aligned with|param=int}}.

Parameters

If you leave the parameter field empty (using no arguments), the template will automatically fallback to displaying information from ALL games.

All parameters for this template:

  • base- No game specific information are displayed, and base engine features only. (The Source 2013 / Source 2013 Multiplayer iteration engine)
  • tf2 - Set template KVs specific to Team Fortress 2
  • l4d - Set template KVs specific to Left 4 Dead
  • l4d2 - Set template KVs specific to Left 4 Dead 2
  • css - Set template KVs specific to Counter-Strike: Source
  • csgo - Set template KVs specific to Counter-Strike: Global Offensive


Refer to the Examples section for samples.

Examples

Show info specific to a game Left 4 Dead

This makes information specific to Left 4 Dead be displayed.

{{KV TeamNum|l4d=1}}
TeamNum:
Initial Team (TeamNum) <choices>
Which Team the entity belongs / is assigned to on spawn
  • 0: None
  • 1: Spectator
  • 2: Survivors Left 4 Dead
  • 3: Infected Left 4 Dead

Show info for its base

Information relevant only to base engine are displayed. (Source 2013 / Source 2013 Multiplayer)

{{KV TeamNum|base=1}}
TeamNum:
Initial Team (TeamNum) <choices>
Which Team the entity belongs / is assigned to on spawn
  • 0: None
  • 1: Spectator

Show information for all games

Shows every game information for this key that this template can display.

{{KV TeamNum}}

will:

TeamNum:
Initial Team (TeamNum, or teamnumber Counter-Strike: Global Offensive) <choices>
Which Team the entity belongs / is assigned to on spawn
  • 0: None
  • 1: Spectator, Spectator/Halloween Souls Team Fortress 2
  • 2: RED Team Fortress 2, Survivors Left 4 Dead seriesLeft 4 Dead series, Terrorists Counter-Strike: Source Counter-Strike: Global Offensive, Marines (Team-based game modes only) Black Mesa
  • 3: BLU/Robots Team Fortress 2, Infected Left 4 Dead seriesLeft 4 Dead series, Counter-Terrorists Counter-Strike: Source Counter-Strike: Global Offensive, Scientists (Team-based game modes only) Black Mesa
  • 5: Halloween Bosses (only in Team Fortress 2) !FGD

See also

  • {{KV BaseEntity}}
  • {{I BaseEntity}}