Template:BasicCSseriesWeapon: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Used newer KV, I templates. Put Keyvalues and Inputs in a ScrollBox each.)
(Added support to in-/exclude CS:S or CS:GO information.)
Line 1: Line 1:
{{note|This is a template for weapons that exist in both {{css}} and {{csgo}} because [[Template:BasicCSSweapon]] and [[Template:BasicCSGOweapon]] are not accurate for them. This here is literally a mix of both.}}
{{lang|Template:BasicCSseriesWeapon}}
<onlyinclude>
<onlyinclude><includeonly><!--
==Keyvalues==
 
{{ScrollBox|bottom-border=1|color=#222|style=border:solid 1px; border-color:#444; padding:1em; width:85%|
-->== KeyValues ==
{{KV|only={{css}}|ammo|integer|Amount of reserve ammo to be added. Fallback value is 0. {{Not in FGD}}}}
{{ScrollBox
{{KV|only={{csgo}}|Is this weapon allowed to be picked up?|intn=CanBePickedUp|boolean|Determines if players are able to pick up the weapon.}}
|title={{#ifeq: {{{css|1}}} |0| {{#ifeq:{{{csgo|1}}}|0||CS:GO}} | CS:S {{#ifeq:{{{csgo|1}}}|0||/ CS:GO}} }} Weapon
{{KV BaseEntity|noscroll=1}}
|bottom-border=1
{{KV BaseAnimating|noscroll=1}}
|color=#222
|style=border:solid 1px; border-color:#444; padding:1em; width:85%
|
{{#ifeq:{{{css|1}}} |0|| {{KV|only={{css}}|ammo|integer|Amount of reserve ammo to be added. Fallback value is 0. {{Not in FGD}}}} }}
{{#ifeq:{{{csgo|1}}}|0|| {{KV|only={{csgo}}|Is this weapon allowed to be picked up?|intn=CanBePickedUp|boolean|Determines if players are able to pick up the weapon.}} }}
{{KV BaseEntity   |noscroll=1|base={{#ifeq:{{{csgo|1}}}|0|1|}} }}
{{KV BaseAnimating|noscroll=1|base={{#ifeq:{{{csgo|1}}}|0|1|}} }}
}}
}}


==Flags==
== Flags ==
* 1 : Start Constrained
* 1 : Start Constrained
: Prevents the model from moving.
: Prevents the model from moving.


==Inputs==
== Inputs ==
{{ScrollBox
|title={{#ifeq: {{{css|1}}} |0| {{#ifeq:{{{csgo|1}}}|0||CS:GO}} | CS:S {{#ifeq:{{{csgo|1}}}|0||/ CS:GO}} }} Weapon
|bottom-border=1
|color=#222
|style=border:solid 1px; border-color:#444; padding:1em; width:85%
|<!--


{{ScrollBox|bottom-border=1|color=#222|style=border:solid 1px; border-color:#444; padding:1em; width:85%|
-->{{#ifeq:{{{csgo|1}}}|0||<p>
{{IO|only={{csgo}}|SetAmmoAmount|param=integer|Sets the primary ammo which is usually the number of bullets in the active magazine. Every value behaves like its [https://en.wikipedia.org/wiki/Congruence_(integers)#Congruence congruent] value in the range 0-255 in modulus 256 (e.g. -255 and 257 behave like 1 etc.). When set to 0, a player holding this weapon will reload automatically, if possible. Other values congruent to 0 (-256, 256, 512, ...) might cause undefined behavior. Values congruent to -1 (mod 256) make the ammo numbers disappear. If set to a value outside the weapon's clip size, reloading might deliver unexpected results. Grenades use the reserve ammo, not this.}}
{{IO|only={{csgo}}|SetAmmoAmount|param=integer|Sets the primary ammo which is usually the number of bullets in the active magazine. Every value behaves like its [https://en.wikipedia.org/wiki/Congruence_(integers)#Congruence congruent] value in the range 0-255 in modulus 256 (e.g. -255 and 257 behave like 1 etc.). When set to 0, a player holding this weapon will reload automatically, if possible. Other values congruent to 0 (-256, 256, 512, ...) might cause undefined behavior. Values congruent to -1 (mod 256) make the ammo numbers disappear. If set to a value outside the weapon's clip size, reloading might deliver unexpected results. Grenades use the reserve ammo, not this.}}
{{IO|only={{csgo}}|SetReserveAmmoAmount|param=integer|Sets the reserve (secondary) ammo which is usually the number of bullets in reserve for reloading. Values that are greater than the weapon's reserve ammo limit are clamped to it (e.g. 90 for the [[weapon_ak47]]). Negative values make the ammo display disappear and reloading is impossible.}}
{{IO|only={{csgo}}|SetReserveAmmoAmount|param=integer|Sets the reserve (secondary) ammo which is usually the number of bullets in reserve for reloading. Values that are greater than the weapon's reserve ammo limit are clamped to it (e.g. 90 for the [[weapon_ak47]]). Negative values make the ammo display disappear and reloading is impossible.}}
{{IO|only={{csgo}}|ToggleCanBePickedUp|param=boolean|Toggles whether the weapon can be picked up by players. Visually, nothing changes and there is no event if picking up fails. Hover texts like ''"[E] Swap for AK-47"'' remain in both cases.}}
{{IO|only={{csgo}}|ToggleCanBePickedUp|param=boolean|Toggles whether the weapon can be picked up by players. Visually, nothing changes and there is no event if picking up fails. Hover texts like ''"[E] Swap for AK-47"'' remain in both cases.}}
{{I BaseEntity|noscroll=1}}
</p>}}<!--
{{I BaseAnimating|portal2=1|noscroll=1}}
 
-->{{I BaseEntity|noscroll=1|base={{#ifeq:{{{csgo|1}}}|0|1|}} }}
{{I BaseAnimating|noscroll=1|portal2={{{csgo|1}}}}}
}}
}}


==Outputs==
== Outputs ==
{{minititle|Weapon}}
{{ScrollBox
{{IO|OnPlayerUse|Fires when a player [[+use]]s this weapon {{PlAct}}. {{note|{{csgo}} Does not fire if the weapon is picked up successfully.}}}}
|noscroll=1
|title={{#ifeq: {{{css|1}}} |0| {{#ifeq:{{{csgo|1}}}|0||CS:GO}} | CS:S {{#ifeq:{{{csgo|1}}}|0||/ CS:GO}} }} Weapon
|bottom-border=1
|color=#222
|style=border:solid 1px; border-color:#444; padding:1em; width:85%
|
{{IO|OnPlayerUse|Fires when a player [[+use]]s this weapon {{PlAct}}. {{#ifeq:{{{csgo|1}}}|0|| <br>{{csgo}} Does not fire if the weapon is picked up successfully.}} }}
{{IO|OnPlayerPickup|Fires when a player picks this weapon up {{PlAct}}.}}
{{IO|OnPlayerPickup|Fires when a player picks this weapon up {{PlAct}}.}}
{{IO|OnCacheInteraction|Fires on successful [[+use]] pickup and (rapidly) on player touch {{PlAct}}. {{note|{{csgo}} [[Non-FGD_features|Non-FGD]]. Does not fire if <code>CanBePickedUp</code> is false.}}}}
{{IO|OnCacheInteraction|Fires on successful [[+use]] pickup and (rapidly) on player touch {{PlAct}}. {{#ifeq:{{{csgo|1}}}|0|| <br>{{csgo}} [[Non-FGD_features|Non-FGD]]. Does not fire if <code>CanBePickedUp</code> is false.}}}}
{{IO|OnNPCPickup|Fires when an [[NPC]] picks up this weapon {{activator|NPC}}}}. {{note|{{csgo}} [[Non-FGD_features|Non-FGD]]. Bots are considered players, so this output has no functionality.}}
{{IO|OnNPCPickup|Fires when an [[NPC]] picks up this weapon {{activator|NPC}}}}. {{#ifeq:{{{csgo|1}}}|0|| <br>{{csgo}} [[Non-FGD_features|Non-FGD]]. Bots are considered players, so this output has no functionality.}}
{{O BaseEntity}}
{{O BaseEntity}}
{{O BaseAnimating}}
{{O BaseAnimating}}
}}
{{#if: {{NAMESPACE}}||


<includeonly>
[[Category:Weapons]]
[[Category:Weapons]]
[[Category:Counter-Strike: Source Entities]]
{{#ifeq:{{{css|1}}}|0||
[[Category:Counter-Strike: Source Weapons]]
[[Category:Counter-Strike: Source Entities]]
[[Category:Counter-Strike: Global Offensive Entities]]
[[Category:Counter-Strike: Source Weapons]]
[[Category:Counter-Strike: Global Offensive Weapons]]
}}
{{#ifeq:{{{csgo|1}}}|0||
[[Category:Counter-Strike: Global Offensive Entities]]
[[Category:Counter-Strike: Global Offensive Weapons]]
}}
 
}} <!-- END #IF NAMESPACE -->
 
</includeonly></onlyinclude>
</includeonly></onlyinclude>
{{documentation}}

Revision as of 22:48, 26 January 2022


English (en)Deutsch (de)Esperanto (eo)Español (es)Français (fr)Suomi (fi)Hrvatski (hr)Magyar (hu)Italiano (it)日本語 (ja)한국어 (ko)Nederlands (nl)Polski (pl)Português (pt)Português do Brasil (pt-br)Русский (ru)Slovenčina (sk)Svenska (sv)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文(臺灣) (zh-tw)
Curly brackets white.pngTemplate Documentation [view] [edit]
Icon-translate.png Available doc translations
View
Page history

Usage

This is a template used only for Weapon Entities that exist in Counter-Strike: Source Counter-Strike: Source and Counter-Strike: Global Offensive Counter-Strike: Global Offensive.

The templates {{BasicCSSweapon}} and {{BasicCSGOweapon}} rely on this one.

Parameters

{{{1}}} - The name of the weapon (omitting the weapon_ prefix) used for sorting in categories.
{{{nocat|0}}} - Whether or not categories should be added to the entity page.
{{{css|1}}} - Whether or not Counter-Strike: Source specific information should be shown. Default is 1.
{{{csgo|1}}} - Whether or not Counter-Strike: Global Offensive specific information should be shown. Default is 1.

The result when setting {{{css}}} and {{{csgo}}} to 0 is not supposed to be used.

Example

{{BasicCSseriesWeapon}}

KeyValues

CS:S / CS:GO Weapon:
ammo ([todo internal name (i)]) <integer> (only in Counter-Strike: Source)
Amount of reserve ammo to be added. Fallback value is 0. !FGD
Is this weapon allowed to be picked up? (CanBePickedUp) <boolean> (only in Counter-Strike: Global Offensive)
Determines if players are able to pick up the weapon.
Note.pngNote:Content moved to Rendering and studio model related KIO/Keyvalues for continuation of page history

Flags

  • 1 : Start Constrained
Prevents the model from moving.

Inputs

CS:S / CS:GO Weapon:

SetAmmoAmount <integer> (only in Counter-Strike: Global Offensive)
Sets the primary ammo which is usually the number of bullets in the active magazine. Every value behaves like its congruent value in the range 0-255 in modulus 256 (e.g. -255 and 257 behave like 1 etc.). When set to 0, a player holding this weapon will reload automatically, if possible. Other values congruent to 0 (-256, 256, 512, ...) might cause undefined behavior. Values congruent to -1 (mod 256) make the ammo numbers disappear. If set to a value outside the weapon's clip size, reloading might deliver unexpected results. Grenades use the reserve ammo, not this.
SetReserveAmmoAmount <integer> (only in Counter-Strike: Global Offensive)
Sets the reserve (secondary) ammo which is usually the number of bullets in reserve for reloading. Values that are greater than the weapon's reserve ammo limit are clamped to it (e.g. 90 for the weapon_ak47). Negative values make the ammo display disappear and reloading is impossible.
ToggleCanBePickedUp <boolean> (only in Counter-Strike: Global Offensive)
Toggles whether the weapon can be picked up by players. Visually, nothing changes and there is no event if picking up fails. Hover texts like "[E] Swap for AK-47" remain in both cases.

Note.pngNote:Content moved to Rendering and studio model related KIO/Inputs for continuation of page history

Outputs

CS:S / CS:GO Weapon:
OnPlayerUse
Fires when a player +uses this weapon (!activator is the player.).
Counter-Strike: Global Offensive Does not fire if the weapon is picked up successfully.
OnPlayerPickup
Fires when a player picks this weapon up (!activator is the player.).
OnCacheInteraction
Fires on successful +use pickup and (rapidly) on player touch (!activator is the player.).
Counter-Strike: Global Offensive Non-FGD. Does not fire if CanBePickedUp is false.
OnNPCPickup
Fires when an NPC picks up this weapon (!activator is the NPC).
Counter-Strike: Global Offensive Non-FGD. Bots are considered players, so this output has no functionality.
Note.pngNote:Content moved to Rendering and studio model related KIO/Outputs for continuation of page history