Template:I BaseEntity/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(doc page)
 
m (clean up, replaced: See Also → See also, {{Documentation subpage → {{Doc/subpage)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Doc/subpage}}
<!-- Please place categories where indicated at the bottom of this page.) -->
<!-- Please place categories where indicated at the bottom of this page.) -->
Info holder for all [[inputs]] assigned through the {{ent|CBaseEntity}} class. Parameters are vital to display the appropiate info, because new games have added new features throughout the years. See [[Help:Templates]] for more info on named parameters.
Info holder of all relevant [[inputs]] inheriting the{{ent|mode=link|CBaseEntity}} [[File:Cpp.png|link=Wikipedia:C++|alt=C++]] class. Template parameters are vital in displaying the appropiate info, because new games have added new features throughout the years. See [[Help:Templates]] for more info on named parameters.
 
Not all{{ent|mode=link|CBaseEntity}}inputs are not covered here. But you can see them all at the [[:Template:I BaseEntity/doc/Uncovered_Keyvalues|Uncovered Keyvalues]] page.
 
{{note|If you want to edit something on this template, please make sure you edit it in both places. ''Per-game'' keyvalues are duplicated, for technical reasons. Also see [[FGD Template Prototype]].}}
{{note|If you want to edit something on this template, please make sure you edit it in both places. ''Per-game'' keyvalues are duplicated, for technical reasons. Also see [[FGD Template Prototype]].}}
{{note|Some <code>CBaseEntity</code> keyvalues are not covered here. See the talk page.}}
 
== Usage ==
== Usage ==
These must be used in a specific syntax! - ALL parameters must be given a value of 1, like:<code>as=1</code>. ''Only one'' game parameter can be used at once.
<pre>
{{I BaseEntity|as=1}}
</pre>
== Parameters ==
If you leave the parameter field empty (using no arguments), the template will automatically fallback to displaying keyvalues from the current default game.
All parameters for this template:
All parameters for this template:
*<code>noscroll</code>- Turned on by default. Causes the box to scroll if set to 0.
*<code>base</code>- Shows only information relevant to when it was initially added for the first time
*<code>base</code>- Shows only information relevant to when it was initially added for the first time
*<code>l4d2</code>- Include info specific to {{l4d2}} ([[VScript|VScripts]])
*<code>l4d2</code>- Include info specific to {{l4d2}} ([[VScript]]s)
*<code>as</code>- Include info specific to {{as}} (SetLocalOrigin and SetLocalAngles)
*<code>as</code>- [CURRENT DEFAULT] Include info specific to {{as}} (SetLocalOrigin and SetLocalAngles)
{{ExpandBox|nostarterlinebreak=1|
{{ExpandBox|
*<code>portal2</code>- Was used to show {{as}} keyalues for some reason. Using this will redirect to {{as}} keyvalues.
*<code>prel4d</code> - (DEPRECATED 9/28/18: This parameter existed to hide DispatchEffect for games (ones before l4d) that did not have it. There's many cases of similar inputs and keyvalues that aren't in absolutely everything, and making similar parameters for all of those simply isn't worth the trouble, especially considering having to comb through every existing use of those templates. Parameter is totally removed from code and affects nothing.)
*<code>prel4d</code> - (DEPRECATED 9/28/18: This parameter existed to hide DispatchEffect for games (ones before l4d) that did not have it. There's many cases of similar inputs and keyvalues that aren't in absolutely everything, and making similar parameters for all of those simply isn't worth the trouble, especially considering having to comb through every existing use of those templates. Parameter is totally removed from code and affects nothing.)
*<code>portal2</code>- Was used to show {{as}} keyalues for some reason. Using this will redirect to {{as}} keyvalues.
*<code>tf2</code> - <strike>(DEPRECATED 28/4/2021: Was only used to show<code>SetTeam</code>keyvalue's TF2-specific information. Use {{tl|I TFTeam}} instead.)</strike>
*<code>tf2</code> - <strike>(DEPRECATED 28/4/2021: Was only used to show<code>SetTeam</code>keyvalue's TF2 specific information. Use {{tl|I TeamNum}} instead
{{#ifexist: Template:I_TeamNum ||, when it starts to exist..}}.)</strike>
| Show Deprecated: }}
| Show Deprecated: }}


These must be used in a specific syntax; All the parameters must be given a value of 1, like for example:<code>as=1</code>for {{as}} specific info. Refer to the [[#Examples|Examples]] section.
Refer to the [[#Examples|Examples]] section for samples.
 
== Examples ==
== Examples ==
=== Show info specific to a game {{as}} ===
=== Show info specific to a game {{l4d2}} ===
This makes information relevant only to {{as}} be displayed.
This makes information relevant only to {{l4d2}} be displayed.
<pre>{{I BaseEntity|as=1}}</pre>
<pre>{{I BaseEntity|l4d2=1}}</pre>
{{ExpandBox|nostarterlinebreak=1|
{{ExpandBox|
{{I BaseEntity|as=1}}
{{I BaseEntity|l4d2=1}}
|will:}}
|will:}}
=== Show info for its base ===
=== 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>{{I BaseEntity|base=1}}</pre>
<pre>{{I BaseEntity|base=1}}</pre>
{{ExpandBox|nostarterlinebreak=1|
{{ExpandBox|
{{I BaseEntity|base=1}}
{{I BaseEntity|base=1}}
|will:}}
|will:}}
=== Show information for '''all''' games ===
=== Show information for '''all''' games ===
Shows every game information for this key that this template can display. (Except for brush related)
Shows every game information for this key that this template can display.
<pre>{{I BaseEntity}}</pre>
<pre>{{I BaseEntity}}</pre>
{{ExpandBox|nostarterlinebreak=1|
{{ExpandBox|
{{I BaseEntity}}
{{I BaseEntity}}
|will:}}
|will:}}
==See Also==
==See also==
* {{tl|KV BaseEntity}}
*{{tl|KV BaseEntity}}
* {{tl|KV BaseAnimating}}
*{{tl|KV BaseAnimating}}
* {{tl|I BaseAnimating}}
*{{tl|I BaseAnimating}}
*{{tl|O BaseEntity}}
*{{tl|O BaseAnimating}}
----
----
{{I BaseEntity}}
<includeonly>
<includeonly>{{minititle|Base}}
<!--{{otherlang2
<!--{{otherlang2
|title=
|title=

Latest revision as of 02:23, 12 January 2024

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

Info holder of all relevant inputs inheriting theCBaseEntity C++ class. Template parameters are vital in displaying the appropiate info, because new games have added new features throughout the years. See Help:Templates for more info on named parameters.

Not allCBaseEntityinputs are not covered here. But you can see them all at the Uncovered Keyvalues page.

Note.pngNote:If you want to edit something on this template, please make sure you edit it in both places. Per-game keyvalues are duplicated, for technical reasons. Also see FGD Template Prototype.

Usage

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

{{I BaseEntity|as=1}}

Parameters

If you leave the parameter field empty (using no arguments), the template will automatically fallback to displaying keyvalues from the current default game.

All parameters for this template:

  • noscroll- Turned on by default. Causes the box to scroll if set to 0.
  • base- Shows only information relevant to when it was initially added for the first time
  • l4d2- Include info specific to Left 4 Dead 2 (VScripts)
  • as- [CURRENT DEFAULT] Include info specific to Alien Swarm (SetLocalOrigin and SetLocalAngles)
Show Deprecated:  
  • portal2- Was used to show Alien Swarm keyalues for some reason. Using this will redirect to Alien Swarm keyvalues.
  • prel4d - (DEPRECATED 9/28/18: This parameter existed to hide DispatchEffect for games (ones before l4d) that did not have it. There's many cases of similar inputs and keyvalues that aren't in absolutely everything, and making similar parameters for all of those simply isn't worth the trouble, especially considering having to comb through every existing use of those templates. Parameter is totally removed from code and affects nothing.)
  • tf2 - (DEPRECATED 28/4/2021: Was only used to showSetTeamkeyvalue's TF2-specific information. Use {{I TFTeam}} instead.)

Refer to the Examples section for samples.

Examples

Show info specific to a game Left 4 Dead 2

This makes information relevant only to Left 4 Dead 2 be displayed. 

{{I BaseEntity|l4d2=1}}
will: 

Show info for its base

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

{{I BaseEntity|base=1}}
will: 

Show information for all games

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

{{I BaseEntity}}
will: 

See also

  • {{KV BaseEntity}}
  • {{KV BaseAnimating}}
  • {{I BaseAnimating}}
  • {{O BaseEntity}}
  • {{O BaseAnimating}}
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:I_BaseEntity/doc&oldid=376008"