Difference between revisions of "Template:KV BaseEntity"

From Valve Developer Community
Jump to: navigation, search
(template code mini cleanup, guess base is obsolete for the moment..)
m (oh my god edits for wrong page)
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<noinclude>{{lang|Template:KV BaseEntity}}
+
<includeonly>
__NOTOC__
 
This template is our holder for all [[keyvalues]] that are assigned through {{ent|CBaseEntity}}. The template has a very specific syntax that you must follow to apply properly, because new games have added new features throughout the years. See [[Help:Templates]] for more info on named parameters.
 
'''No parameters:''' display keyvalues for ALL games.
 
<pre>{{KV BaseEntity}}</pre>
 
'''Base:''' display keyvalues that have only existed since whatever game added the class (most have existed since HL2, the first Source game).
 
<pre>{{KV BaseEntity|base=1}}</pre>
 
'''Game as a parameter:''' display the keyvalues that <code>base</code> displays, AND keyvalues that were added to the class, by the specified game. You can specify as many games as needed. You must specify ALL the games you want to include (e.g. <code>l4d2</code> will not automatically include <code>l4d</code> keyvalues as well). This is because there are situations like in Portal 2, where the output <code>OnKilled</code> is not available through <code>CBaseEntity</code>, despite being a far descendant of the L4D branch which added it.
 
<pre>{{KV BaseEntity|l4d2=1}}</pre>
 
 
 
All parameters for this template:
 
*<code>base</code> - (Use if the entity was available before L4D2.) (OBSOLETE 16/4/21: At the current moment, the script code for this template has been improved that, base does nothing notable as of the moment; It only prevents L4D2 and CSGO keys from appearing when this is used alongside both games's parameters.)
 
*<code>l4d</code> - (DEPRECATED 9/21/18: Found out these keyvalues only work with renderable things. They have been migrated to visiblebrush and BaseAnimating KV templates. This is completely removed from the template and won't affect anything.)
 
*<code>l4d2</code>
 
*<code>csgo</code> - When using this, Use<code>csgo=teamnum_dont_put_nofgd</code>to remove the {{Not in FGD}} tag.
 
*<code>css</code> - <strike>(DEPRECATED 10/1/18: Previously used for a notice that was ''thought'' to apply to all entities in CS:S. The purpose of this now exists in [[Template:PreservedEnt]]. This is completely removed from the template and won't affect anything.) (24/3/2021 brought back for the<code>teamnum</code> key)</strike>
 
*<code>brush</code> - (This adds things common for all brush entities, visible or not. For keys applicable only to visible brushes, use [[:Template:KV visiblebrush]] in conjunction.)
 
*<code>tf2</code> - Alter<code>TeamNum</code>keyvalue to show TF2 specific information. Use<code>tf2=teamnum_dont_put_nofgd</code>to remove the {{Not in FGD}} tag.
 
{{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.}}
 
See [[FGD Template Prototype]].
 
{{note|Some <code>CBaseEntity</code> keyvalues are not covered here. See the talk page.}}
 
----
 
[[Category:Keyvalue Templates|Global]]
 
{{KV BaseEntity}}
 
</noinclude><includeonly>
 
 
<!--
 
<!--
 
   ++ BRUSH ++
 
   ++ BRUSH ++
Line 56: Line 32:
 
{{KV|[[ResponseContext|Response Contexts]]|intn=ResponseContext|string|Pre-defined response system contexts for this entity. Format is <code>key:value,key:value,...</code>. Contexts may be [[filter_activator_context|filtered]].}}
 
{{KV|[[ResponseContext|Response Contexts]]|intn=ResponseContext|string|Pre-defined response system contexts for this entity. Format is <code>key:value,key:value,...</code>. Contexts may be [[filter_activator_context|filtered]].}}
 
{{KV|[[Effect flags|Effects]]|intn=effects|int|Combination of effect flags to use.|nofgd=1}}
 
{{KV|[[Effect flags|Effects]]|intn=effects|int|Combination of effect flags to use.|nofgd=1}}
 +
<!-- I'm not sure what the use cases of these 2 are, so ill hide them for now. Not too much of a harm to show "hammerid" for the plugin / sourcepawn peeps
 
{{KV|Local Time|intn=ltime|float|The local time of the entity, independent of the global clock. Used mainly for physics calculations.|nofgd=1}}
 
{{KV|Local Time|intn=ltime|float|The local time of the entity, independent of the global clock. Used mainly for physics calculations.|nofgd=1}}
 
{{KV|Next Think|intn=nextthink|float|Amount of time before the entity [[Thinking|thinks]] again.|nofgd=1}}
 
{{KV|Next Think|intn=nextthink|float|Amount of time before the entity [[Thinking|thinks]] again.|nofgd=1}}
 +
-->
 
{{KV|Hammer ID|intn=hammerid|int|The entity's [[Hammer]] ID. Mainly used by plugins and debugging commands, such as '''<code>ent_keyvalue</code>'''. Can be manually assigned with the "hammerid" or "id" keyvalue. Entities spawned at run-time are not assigned any Hammer ID.|nofgd=1}}
 
{{KV|Hammer ID|intn=hammerid|int|The entity's [[Hammer]] ID. Mainly used by plugins and debugging commands, such as '''<code>ent_keyvalue</code>'''. Can be manually assigned with the "hammerid" or "id" keyvalue. Entities spawned at run-time are not assigned any Hammer ID.|nofgd=1}}
 
<!--
 
<!--
   ++ Game Specifics - L4D2 ++
+
   ++ Game Specifics ++
 
-->
 
-->
<!-- IF NOT: BASE -->
+
<!-- IF NOT: BASE, L4D2 AND CSGO -->
{{#if:{{{base|}}}||{{#if:{{{l4d2|}}}| <!-- ...THEN IF: L4D2 -->
+
{{#if:{{{base|}}}||{{#if:{{{l4d2|}}}|
 +
{{KV|Disable for Xbox 360|intn=disableX360|bool|If this entity should automatically be given the 'Disable' input on the Xbox 360 version of Source.|nofgd=1|since=L4D2}}
 +
{{KV|Entity Scripts|intn=vscripts|scriptlist|Space delimited list of [[VScript]] files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.|since=L4D2}}
 +
{{KV|Script think function|intn=thinkfunction|string|Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call. Try to avoid [[expensive]] operations in this function, as it may cause performance problems.|since=L4D2}}
 +
{{KV|[[Lag Compensation]]|intn=LagCompensate|boolean|Set to '''Yes''' to lag compensate this entity. Should be used very sparingly!|nofgd=1|since=L4D2}}
 +
| <!-- ELSE IF: CSGO -->{{#if:{{{csgo|}}}|
 +
{{KV|Is Automatic-Aim Target|intn=is_autoaim_target|bool|If set to 1, this entity will slow down aiming movement for consoles and joystick controllers when the entity is under the crosshairs.|nofgd=1|since=CSGO}}
 +
|<!-- ELSE: -->
 
{{KV|Disable for Xbox 360|intn=disableX360|bool|If this entity should automatically be given the 'Disable' input on the Xbox 360 version of Source.|nofgd=1|since=L4D2}}
 
{{KV|Disable for Xbox 360|intn=disableX360|bool|If this entity should automatically be given the 'Disable' input on the Xbox 360 version of Source.|nofgd=1|since=L4D2}}
 
{{KV|Entity Scripts|intn=vscripts|scriptlist|Space delimited list of [[VScript]] files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.|since=L4D2}}
 
{{KV|Entity Scripts|intn=vscripts|scriptlist|Space delimited list of [[VScript]] files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.|since=L4D2}}
 
{{KV|Script think function|intn=thinkfunction|string|Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call. Try to avoid [[expensive]] operations in this function, as it may cause performance problems.|since=L4D2}}
 
{{KV|Script think function|intn=thinkfunction|string|Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call. Try to avoid [[expensive]] operations in this function, as it may cause performance problems.|since=L4D2}}
 
{{KV|[[Lag Compensation]]|intn=LagCompensate|boolean|Set to '''Yes''' to lag compensate this entity. Should be used very sparingly!|nofgd=1|since=L4D2}}
 
{{KV|[[Lag Compensation]]|intn=LagCompensate|boolean|Set to '''Yes''' to lag compensate this entity. Should be used very sparingly!|nofgd=1|since=L4D2}}
| }}<!-- ...THEN IF: CSGO --> {{#if:{{{csgo|}}}|
 
 
{{KV|Is Automatic-Aim Target|intn=is_autoaim_target|bool|If set to 1, this entity will slow down aiming movement for consoles and joystick controllers when the entity is under the crosshairs.|nofgd=1|since=CSGO}}
 
{{KV|Is Automatic-Aim Target|intn=is_autoaim_target|bool|If set to 1, this entity will slow down aiming movement for consoles and joystick controllers when the entity is under the crosshairs.|nofgd=1|since=CSGO}}
| }}}}
+
}}}}}}</includeonly>
<!--
+
<noinclude>
  ++ TeamNum related things go here ++
+
{{documentation}}
-->
+
<!-- Add categories to the /doc subpage, not here -->
<!-- IF: TF2 == 'teamnum_dont_put_nofgd' -->
+
</noinclude>
{{#switch: {{{tf2|}}} | teamnum_dont_put_nofgd =
 
{{KV|Initial |choices|intn=teamnum|Which Team the entity belongs / is assigned to on spawn.
 
:*0: None
 
:*1: Spectator
 
:*2: Red {{tf2}}
 
:*3: Blue {{tf2}}
 
}} | <!-- ELSE IF : TF2 > 1 -->  1 =
 
{{KV|Initial Team|choices|intn=teamnum|Which Team the entity belongs / is assigned to on spawn.
 
:*0: None
 
:*1: Spectator
 
:*2: Red {{tf2}}
 
:*3: Blue {{tf2}}
 
|nofgd=1}}
 
| }} <!-- IF: CSS OR L4D OR L4D2 --> {{#if:{{{css|}}}{{{l4d|}}}{{{l4d2|}}}|
 
{{KV|Initial Team|choices|intn=teamnum|Which Team the entity belongs / is assigned to on spawn. Doesn't do anything in {{l4ds}}.
 
{{confirm|Does this work in {{css}}?}}
 
<!-- :*2: Survivors {{l4ds}}, Counter-Terrorist {{css}}:*3: Infected {{l4ds}} Terrorist {{css}} -->
 
|nofgd=1|deprecated=1}}
 
| }} <!-- IF: CSGO == 'teamnum_dont_put_nofgd' -->
 
{{#ifeq: {{{csgo|}}} | teamnum_dont_put_nofgd |
 
{{KV|Initial Team|choices|intn=TeamNum|Which Team the entity belongs / is assigned to on spawn.
 
:*0: None
 
:*1: Spectator
 
:*2: Terrorists {{csgo}}
 
:*3: Counter-Terrorists {{csgo}}
 
}} | <!-- ELSE IF : CSGO == 1 --> {{#ifeq: {{{csgo|}}} | 1 |
 
{{KV|Initial Team|choices|intn=TeamNum|Which Team the entity belongs / is assigned to on spawn.
 
:*0: None
 
:*1: Spectator
 
:*2: Terrorists {{csgo}}
 
:*3: Counter-Terrorists {{csgo}}
 
|nofgd=1 }}
 
| }}}}</includeonly>
 

Revision as of 22:23, 19 April 2021


Template icon Template documentation[view] [edit] [history] [purge]

Info holder for all keyvalues that inherit theCBaseEntity 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.

Note.png 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.png Note: Some CBaseEntity keyvalues are not covered here. See the talk page.

Usage

All parameters for this template:

  • 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)
  • csgo- Include info specific to <Counter-Strike: Global Offensive> (Auto-aim targets)
  • brush- Include info specific to all sorts of brushes. For extra keys applicable only to visible brushes, use Template:KV visiblebrush in conjunction.
Show Deprecated:


These must be used in a specific syntax; All the parameters must be given a value of 1, like for example:l4d2=1for <Left 4 Dead 2> specific info. Refer to the Examples section.

Examples

Show info specific to a game <Counter-Strike: Global Offensive>

This makes information relevant only to <Counter-Strike: Global Offensive> be displayed.

{{KV BaseEntity|csgo=1}}
will:

Show info for its base

Information relevant only to this key at / before <Half-Life 2: Episode Two><Half-Life 2: Episode Two> is displayed.

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

Show info related to brushes

Extra brush related keyvalues are displayed with this.

{{KV BaseEntity|brush=1}}
will:

Show information for all games

Shows every game information for this key that this template can display. (Except for brush related)

{{KV BaseEntity}}
will:

See Also



Base:

Classname (classname) <string>
The classname defines the type of entity. Classnames can be changed using AddOutput, which will influence how the engine deals with the entity in certain circumstances.
Name (targetname) <string>
The name that other entities refer to this entity by.
Global Entity Name (globalname) <string>
Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state.
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. Every entity can be parented, even point entities. Entities which are parented will be forced to transition to the next map, such as from a trigger_transition. Some entities which aren't intended to be parented may not function correctly. phys_constraint can be used as a workaround to parenting.
Origin (X Y Z) (origin) <coordinates>
The position of this entity's center in the world. Rotating entities typically rotate around their origin.
Pitch Yaw Roll (X Y Z) (angles) <angle>
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.
Note.png Note: This works on brush entities, although Hammer doesn't show the new angles.
Flags (spawnflags) <integer>
Toggles features of an entity, its specific number is determined by the combination of flags added.
Response Contexts (ResponseContext) <string>
Pre-defined response system contexts for this entity. Format is key:value,key:value,.... Contexts may be filtered.
Effects (effects) <integer> !FGD
Combination of effect flags to use.
Hammer ID (hammerid) <integer> !FGD
The entity's Hammer ID. Mainly used by plugins and debugging commands, such as ent_keyvalue. Entities spawned at run-time are not assigned any Hammer ID.
Entity Scripts (vscripts) <scriptlist> (in all games since <Left 4 Dead 2>)
Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
Script think function (thinkfunction) <string> (in all games since <Left 4 Dead 2>)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call. Try to avoid expensive operations in this function, as it may cause performance problems.
Lag Compensation (LagCompensate) <boolean> (in all games since <Left 4 Dead 2>) !FGD
Set to Yes to lag compensate this entity. Should be used very sparingly!
Disable for Xbox 360 (disableX360) <boolean> (in all games since <Left 4 Dead 2>) !FGD
If this entity should automatically be given the 'Disable' input on the Xbox 360 version of Source.
Is Automatic-Aim Target (is_autoaim_target) <boolean> (in all games since <Counter-Strike: Global Offensive>) !FGD
If set to 1, this entity will slow down aiming movement for consoles and joystick controllers when the entity is under the crosshairs.