Template:KV TeamNum/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Changed the method of showing Examples, along with the parameters document method)
m (→‎Usage: Substituted IO templates)
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<!--{{otherlang2
{{Doc/subpage}}
|title=
{{Main|teamnumber}}
}}-->
{{Documentation subpage}}
<!-- 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>TeamNum</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.
 
==Usage==
==Usage==
Parameters of this must be used for all pages to display information properly. They are as follow:
These must be used in a specific syntax! - ALL parameters must be given a value of 1, like:{{code|1=tf2=1|style=background-color:#202020; color:#E5E5E5;}}. ''Only one'' game parameter can be used at once.
*<code>base</code> - Shows only information relevant to when it was initially added for the first time
<pre>
*<code>tf2</code> - Include info specific to {{tf2}}
{{KV TeamNum|tf2=1}}
*<code>l4d</code> - Include info specific to {{l4d}}
</pre>
*<code>l4d2</code> - Include info specific to {{l4d2}}
{{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>}}.}}
*<code>css</code> - Include info specific to {{css}}
*<code>csgo</code> - Include info specific to {{csgo}}


These must be used in a specific syntax; All the parameters must be given a value of 1, like for example:<code>tf2=1</code>for {{tf2}} specific info. Refer to the [[#Examples|Examples]] section.
=== 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:
*<code>base</code>- No game specific information are displayed, and base engine features only. (The {{src13}} / {{src13mp}} iteration engine)
*<code>tf2</code> - Set template KVs specific to {{tf2}}
*<code>l4d</code> - Set template KVs specific to {{l4d}}
*<code>l4d2</code> - Set template KVs specific to {{l4d2}}
*<code>css</code> - Set template KVs specific to {{css}}
*<code>csgo</code> - Set template KVs specific to {{csgo}}
 
 
Refer to the [[#Examples|Examples]] section for samples.


==Examples==
==Examples==
<h3>Show info specific to a game {{l4d}}</h3>
===Show info specific to a game {{l4d}}===
This makes information specific to {{l4d}} be displayed.
This makes information specific to {{l4d}} be displayed.
<pre>{{KV TeamNum|l4d=1}}</pre>
<pre>{{KV TeamNum|l4d=1}}</pre>
{{KV TeamNum|l4d=1}}
{{KV TeamNum|l4d=1}}
<h3>Show info for its base</h3>
===Show info for its base===
Information relevant only to this key at / before {{EP2}} is displayed.
Information relevant only to base engine are displayed. ({{src13}} / {{src13mp}})
<pre>{{KV TeamNum|base=1}}</pre>
<pre>{{KV TeamNum|base=1}}</pre>
{{KV TeamNum|base=1}}
{{KV TeamNum|base=1}}
<h3>Show information for '''all''' games</h3>
===Show information for '''all''' games===
Shows every game information for this key that this template can display.
Shows every game information for this key that this template can display.
<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}}
Line 36: Line 44:


<includeonly>
<includeonly>
<!--{{otherlang2
|title=
}}-->
{{sandbox other||
{{sandbox other||
<!-- Categories below this line, please -->
<!-- Categories below this line, please -->
[[Category:Keyvalue Templates|TeamNum]]
[[Category:Keyvalue Templates|TeamNum]]
}}</includeonly>
}}</includeonly>

Latest revision as of 16: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) <integer 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) <integer 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) <integer 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}}


Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:KV_TeamNum/doc&oldid=472807"