This article's documentation is for the "GoldSrc" engine. Click here for more information.
This article's documentation is for anything that uses the Source engine. Click here for more information.
This article's documentation is for Source 2. Click here for more information.

Template:This is a

From Valve Developer Community
Jump to: navigation, search

This is a {{{1}}} available in all Source Source games.

Blank image.pngTodo: Add shaders to Category:Shaders.
Blank image.pngTodo: Add multiple shaders parameters (shader1, shader2, etc...), like {{Shaderparam}}.
Curly brackets white.pngTemplate Documentation
Icon-translate.png
View
Edit
Page history
Icon-translate.png
This template uses a strings subpage
Please follow the format on this subpage(s) to add translations.
Shortcut
{{Thisis}}

This template is the master format page for all Entity, Console command/variable, and Shader pages. Each page should have this at the beginning to describe the basic info about each one, such as what they are and their availability.

Parameters and Examples

*: Necessary parameters.

Parameter Description Example Preview
*{{{1}}} The type of the object need to describe. The following types are available:

Entities:

Console Variables, Commands, QC Commands:

Miscellaneous:

  • Custom (You can specify the type yourself. See examples)
Note.pngNote:Template will not add entity categories and change titles when using non-entity type (such as console variable).
{{this is a|''incredible entity''}}
{{this is a|brush entity|engine=GoldSrc}}
{{this is a|console variable|name=sv_cheats}}
{{this is a|pixel shader|name=LightmappedGeneric}}
This is a incredible entity available in all Source Source games.
This is a brush entity available in all GoldSrc GoldSrc games.
sv_cheats is a console variable available in all Source Source games.
LightmappedGeneric is a pixel shader available in all Source Source games.
{{{shader}}} The shader that a parameter is in (only works if {{{1}}} is equal to shader parameter).
{{this is a|shader parameter|name=$lightmap|shader=VertexLitGeneric|game=Source 2013 MP|game1=Garry's Mod}}
$lightmap is a material shader parameter for the VertexLitGeneric shader available in Source 2013 Multiplayer Source 2013 Multiplayer and Garry's Mod Garry's Mod.
{{{dx}}} Add DirectX levels inline text.

Available versions:

  • DirectX 8 - dx8
  • DirectX 9 (SM 2.0)- dx9
  • DirectX 9.0c (SM 3.0) - dx95 or dx90c
{{this is a|shader parameter|dx=dx8|name=$lightwarptexture|shader=VertexLitGeneric|since=Source 2006}}

{{this is a|shader parameter|dx=dx9|name=$lightwarptexture|shader=VertexLitGeneric|since=Source 2006}}

{{this is a|shader parameter|dx=dx95|name=$lightwarptexture|shader=VertexLitGeneric|since=Source 2006}}
$lightwarptexture (DX8) is a material shader parameter for the VertexLitGeneric shader available in all Source Source games since Source 2006 Source 2006.

$lightwarptexture (DX9+) is a material shader parameter for the VertexLitGeneric shader available in all Source Source games since Source 2006 Source 2006.

$lightwarptexture (DX9.0c+) is a material shader parameter for the VertexLitGeneric shader available in all Source Source games since Source 2006 Source 2006.
{{{engine}}}
{{{engine1}}}
{{{engine2}}}
Which engine the subject belongs to.
Icon-Important.pngImportant:To add multiple engines, please use parameter {{{engine1}}} (secondary engine) and {{{engine2}}} (tertiary engine) with {{{engine}}} (primary engine) at the same time.
{{this is a|point entity|engine=GoldSrc|engine1=Source}}
{{this is a|point entity|engine=GoldSrc|engine1=Source|engine2=Source 2}}
This is a point entity available in all GoldSrc GoldSrc and Source Source games.
This is a point entity available in all GoldSrc GoldSrc, Source Source, and Source 2 Source 2 games.
{{{except}}} This is available in all other games except this one.
Note.pngNote:Works without {{{game}}}.
{{this is a|brush entity|name=func_monitor|except=Left 4 Dead series}}
func_monitor is a brush entity available in all Source Source games except Left 4 Dead series Left 4 Dead series.
{{{since}}} This is available since this game.
Note.pngNote:Works without {{{game}}}.
{{this is a|point entity|name=info_player_start|engine=GoldSrc|since=Half-Life}}
info_player_start is a point entity available in all GoldSrc GoldSrc games since Half-Life Half-Life.
{{{name}}} The name of the subject. It will change the title of a page. The default value is "This". You can specify it to 0 to remove the entity name.
{{this is a|point entity|name=info_player_start}}
info_player_start is a point entity available in all Source Source games.
{{{series}}} The series that the subject is available in.
{{this is a|brush entity|series=Counter-Strike}}
This is a brush entity available in Counter-Strike: SourceCounter-Strike: Global Offensive.
{{{game}}} The game that the subject is available in.
Note.pngNote:Works without {{{series}}}.
{{this is a|path entity|game=Team Fortress 2}}
This is a path entity available in Team Fortress 2 Team Fortress 2.
{{{notitlechange}}} You can prevent title-changing from the template by using this parameter. Used in the /doc page.
{{this is a|point entity|notitlechange=1|name=info_player_start|engine=GoldSrc|since=Half-Life}}
info_player_start is a point entity available in all GoldSrc GoldSrc games since Half-Life Half-Life.
{{{internal}}} If enabled, "cut" will be displayed before "entity" and a category will be added to the page.
{{this is a|entity|internal=1}}
This is a internal entity available in all Source Source games.
{{{cut}}} If enabled, "cut" will be displayed before "(internal) ... entity" and a category will be added to the page.
{{this is a|cut=1|internal=1|entity}}
This is a cut internal entity available in all Source Source games.
{{{sprite}}} The icon of the entity:
  • If 1 is specified, the template will find the entity icon file based on the entity name (parameter {{{1}}}). (Follow the format of [[File:<entity name>.png]] to find)
  • If it is a custom value, the template will find the entity icon file according to the specified value.
    Note.pngNote:File suffix name is required!
{{this is a|point entity|name=logic_script|sprite=1}}
Logic script.png
logic_script is a point entity available in all Source Source games.
{{{icon}}} Make the game icon appear left-aligned.
  • If 1 is specified, the template will use {{{game}}} instead.
  • If it is a custom value, you need to enter the full name of the game. (Case sensitive)
  • If 0 is specified or the parameter is unused, the icon will appears in the text. (See the examples above.)
{{this is a|point entity|name=info_survivor_position|icon=Left 4 Dead series|type=point entity|series=Left 4 Dead}}
Left 4 Dead series info_survivor_position is a point entity available in Left 4 Dead series Left 4 Dead series.
{{{game1}}} ~ {{{game5}}} If this is available in multiple games, use these parameters to describe.
Note.pngNote:Once you have used the {{{game1}}}, the style of the template will be changed. The {{{game}}} is necessary for displaying the first game.
Note.pngNote:Works without {{{series}}}.
{{this is a|point entity|game=Left 4 Dead|game1=Left 4 Dead 2|game2=Portal 2 |game3=Team Fortress 2|game4=Portal 2|game5=Counter-Strike: Global Offensive}}
{{this is a|point entity|name=info_survivor_position|game=Left 4 Dead|game1=Left 4 Dead 2}}
info_survivor_position is a point entity available in Left 4 Dead Left 4 Dead and Left 4 Dead 2 Left 4 Dead 2.
{{{nocat}}} Don't place any categories.
{{this is a|point entity|name=info_player_start|nocat=1}}
N/A
{{{except-multi}}} Similar to {{{except}}}, but can specify multiple games simultaneously.
Note.pngNote:Unsupport placing categories.
{{this is a|point entity|name=1|except-multi={{l4d}}{{hl2}}{{csgo}}}}
1 is a point entity available in all Source Source games except Left 4 DeadHalf-Life 2Counter-Strike: Global Offensive.

See also

Note.pngNote:All the entity templates listed below are deprecated.