Template:I BaseEntity/doc: Difference between revisions
Jump to navigation
Jump to search
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.
Show info specific to a game
m (→Show information for all games: misleadsing tag) |
m ([CURRENT DEFAULT]; Uncovered KVs page link fix) |
||
| Line 3: | Line 3: | ||
Info holder of all relevant [[inputs]] inheriting the{{ent|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. | Info holder of all relevant [[inputs]] inheriting the{{ent|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|CBaseEntity}}inputs are not covered here. But you can see them all at the [[/Uncovered_Keyvalues|Uncovered Keyvalues]] page. | Not all{{ent|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]].}} | ||
| Line 19: | Line 19: | ||
*<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|VScripts]]) | ||
*<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| | {{ExpandBox| | ||
*<code>portal2</code>- Was used to show {{as}} keyalues for some reason. Using this will redirect to {{as}} keyvalues. | *<code>portal2</code>- Was used to show {{as}} keyalues for some reason. Using this will redirect to {{as}} keyvalues. | ||
Revision as of 16:55, 17 September 2021
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.
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 
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: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:
base- Shows only information relevant to when it was initially added for the first timel4d2- Include info specific to
(VScripts)as- [CURRENT DEFAULT] Include info specific to
(SetLocalOrigin and SetLocalAngles)
Show Deprecated:
portal2- Was used to show keyalues for some reason. Using this will redirect to 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 TeamNum}}insteadwhen it starts to exist...)
Refer to the Examples section for samples.
Examples
Show info specific to a game
This makes information relevant only to be displayed.
{{I BaseEntity|as=1}}
will:
Show info for its base
Information relevant only to base engine are displayed. (
/ 
)
{{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}}