View source for Pt-br/FGD

{{LanguageBar}}

{{seealso|{{LCategory|FGD}}}}
'''FGD''' ('''Forge Game Data''') é um formato de arquivo de texto simples usado para definir todas as {{L|entities|entidades}} de um jogo para um editor de mapas, permitindo que os mapeadores possam selecionar a partir do editor e configure suas propriedades.

Embora Hammer fosse originalmente chamado de {{worldcraft|4}}, ele foi desenvolvido sob o nome de The Forge (daí o nome ''Forge'' Game Data). Devido a questões de marca registrada, entretanto, o nome Forge não pôde ser usado na versão final do Hammer. Mesmo assim, a extensão do arquivo permaneceu.

Para que os arquivos FGD personalizados funcionem no Hammer ou Jack, eles devem ser adicionados em '''Ferramentas > Opções'''.

{{note|FGDs são carregados em ordem alfabética. Se você não usar <code>@include "base.fgd"</code> na parte superior do seu FGD e ele for carregado antes de <code>base.fgd</code>, você encontrará erros.}}
{{ModernImportant|'''Um FGD nada mais é do que uma referência para o editor de mapas.'''<br>Você não pode criar ou modificar entidades editando um FGD, você apenas fornece ao editor de mapas informações diferentes sobre o que ele espera encontrar no jogo. Às vezes, a edição revela recursos ou até entidades ocultas ou não utilizadas, mas elas sempre estiveram lá e poderiam ser usadas mesmo sem o FGD atualizado.}}

{{todo|Adicione mais coisas para deixar claro como que cada editor de mapa usa
* {{hammer3|4|nt=5}}
* {{hammer4|4}}
* {{hammer5|4}}
* {{jack|4}}
* {{trenchbroom|4}}
Prefer editor-agnostic language when not referring to a specific editor; unless something is specific to Hammer, refer to the program used to create maps as "the map editor". If it is specific to Hammer, specify the major version (3.x, 4.x, 5.x).
}}


== File Format ==
An FGD file consists of keywords that start with an {{mono|@}} character that might be followed by properties or even a body surrounded with square brackets {{mono|[ ]}}. This may be the definition of an entity class or any other information that the map editor will use, depending on the keyword. In the following, all the different types of keywords are covered.

'''Comments''' can only be added as line comments, starting with {{mono|//}}. Block comments or multiline comments are not supported.
{{pre|
//<nowiki>====== Copyright © 1996-2005, Valve Corporation, All rights reserved. =======</nowiki>
//
// Purpose: Half-Life 2 game definition file (.fgd) 
//
//<nowiki>=============================================================================</nowiki>
}}

== Entities ==
The syntactic components of an entity structure as defined in the FGD include:
# the '''class type''' of the entity (<code>@PointClass</code>),
# ''(optional)'' whitespace delimited '''class properties''' (<code>base(...) studio(...)</code>),
# an '''equals sign''' and the '''classname''' of the entity (<code>example_entity_name</code>),
# ''(optional)'' '''a colon''' followed by a '''description''' for it (<code>"..."</code>) and
# a body surrounded by square brackets <code>[ ]</code> containing the entity's keyvalues, flags and {{L|Inputs and Outputs}}.
Explanations of what each of these parameters do will be explained on this page, in order.
{{ModernExample|{{pre|<nowiki>
@PointClass base(Targetname, Angles, Origin) studio("path/model.mdl") = example_entity_name : "example entity description, visible in Hammers 'help' Box. 
[

	Property_name_1(string) 	: "Example String Name"		: "Example"	: "Keyvalue Description"
	Property_name_2(integer) 	: "Example Interger Name"	: 15		: "Keyvalue Description"
	Property_name_3(float)		: "Example Float Name" 		: "1.5"		: "Keyvalue Description"
	Property_name_4(boolean)	: "Example Boolean Name"	: 1 		: "Keyvalue Description"
	
	Property_name_5(choices) : "second number" : 0 : "Your choice of numbers!" =
	[
		0 : "Default"
		1 : "Something"
		2 : "Another Thing"
	]

	spawnflags(flags) =
	[
		1 : "A flag"       : 0 // 0 means the flag isn't ticked by default
		2 : "Another flag" : 1 // 1 means the flag is ticked by default
	]
	
	// Inputs
	input DoSomething(void) : "Do something"	
	// Outputs
	output OnSomethingHappened(void) : "Fires when something happens"
	output OnSomethingElse(void) : "Fires when something else happens"

]
</nowiki>}}}}

=== Class Types and Properties ===
The class type of an entity tells Hammer how this entity can be placed.
{| class="wikitable"
! Class Name
! Supported Editors
! Description
|-
| {{mono|@BaseClass}}
| {{hammer3|4}}<br>{{hammer4|4}}<br>{{jack|4}}<br>{{trenchbroom|4}}
| A set of properties that can be inherited, reducing clutter. See [[#@BaseClass|@BaseClass]].
|-
| {{mono|@PointClass}}
| {{hammer3|4}}<br>{{hammer4|4}}<br>{{jack|4}}<br>{{trenchbroom|4}}
| {{L|point entity|Point Entity}}: This entity exists at a certain non-arbitrary point. These entities are placed within Hammer by using the {{L|Hammer Entity Tool}}, {{key|Shift|E}}.
|-
| {{mono|@NPCClass}}
| {{hammer4|4}}
| This is a special form of point entity tailored for {{L|NPC}} ('''N'''on-'''P'''layer '''C'''haracter) entities. It is useful in conjunction with the <code>npcclass</code> property type (see below).
|-
| {{mono|@SolidClass}}
| {{hammer3|4}}<br>{{hammer4|4}}<br>{{jack|4}}<br>{{trenchbroom|4}}
| {{L|brush entity|Brush Entity}}: This entity has a volume that is defined by the solid (also referred to as a brush) that it is attached to. A solid is tied to an entity by selecting it and pressing {{key|Ctrl|T}}. Other solids are {{L|world brush}}es.
|-
| {{mono|@KeyFrameClass}}
| {{hammer4|4}}
| Used for {{Ent|move_rope}} and {{Ent|keyframe_rope}}. This causes the <code>NextKeysprite</code> property to be linked up when the entity is copied.
|-
| {{mono|@MoveClass}}
| {{hammer4|4}}
| Used for {{Ent|path_track}} and similar entities. This causes the <code>targetsprite</code> property to be linked up when the entity is copied.
|-
| {{mono|@FilterClass}}
| {{hammer4|4}}
| One of the special {{L|Filter|filter}} classes used to define what entities will be able to interact with each other in some way. This mainly causes the entity to be shown in properties with the <code>filterclass</code> type.
|}


Things between the class type declaration and the "{{mono|1== <entity_name_here>}}" help to define properties of the entity, how it will act and be displayed in Hammer.<br>
There are a number of different keywords that can used here. Multiple of these can be used, each separated by a space.
{| class="wikitable mw-collapsible" style="background:transparent" width=100%
! Property
! Supported Editors
! Description
|-
| {{mono|axis( ''property'' )}}
| {{hammer4|4}}
| Allows positioning two points joined by a line in the map. The property value is set to "x1 y1 z1, x2 y2 z2" by default.
|-
| {{mono|base( ''BaseClass1, BaseClass2, …'' )}}
| {{hammer4|4}}
| This lets you attach previously defined {{mono|BaseClass}}es (see [[#@BaseClass|below]]) to an entity. You can specify multiple <code>BaseClass</code>es, each separated by a comma.
|-
| {{mono|bbox( ''min,max'' )}}
| {{hammer4|4}}
| Sets the size of the entity's bounding box.
|-
| {{mono|color( ''red green blue'' )}}
| {{hammer4|4}}
| This setting will change the color of the wireframe box in the Hammer 2D views, as well as the 3D view if no model is present. If this isn't present, the color will default to magenta. The values specified here are the RGB values of a color, and each number has a range from 0 to 255.
|-
| {{mono|cylinder( ''color, start_key, start_name, start_radius, end_key, end_value, end_radius'' )}}
| {{hammer4|4}}
| Draw a cylinder between two entities. This is similar to <code>line()</code>, but with the addition of two ''<code>radius</code>'' properties that are looked up on the target entities. These define the size of the start and end of the cylinder.
|-
| {{mono|flags(''flagname(s)'')}}
| {{jack|4}}
| Allows for multiple different editor flags, separated by commas:
* {{code|Angle}} - Shows an arrow in the 3D view indicating which direction point entity is angled.
* {{code|Light}} - If no model is present, shows the entity as a {{w|octahedron}} instead of a cube or rectangular prism.
|-
| {{mono|frustum( ''fov,near,far,color, pitch_scale'' )}}
| {{hammer4|4}}
| Creates a rectangular cone extending from the entity. FOV defines the spread angle (0-180). Near and far define at what distances will be highlighted. The color value defines what color the cone will be shown with. Pitch_scale allows inverting the pitch angle when rendering the cone. The first four values must be property names, the last is a literal. If not specified, values are taken from <code>_fov</code>, <code>_nearplane</code>, <code>_farplane</code>, and <code>_light</code>, respectively. ''<code>pitch_scale</code>'' is set to -1.
|-
| {{mono|halfgridsnap}}
| {{hammer4|4}}
| When moving this entity, it will snap to half the current grid size. This is somewhat special as it takes no arguments or parentheses.
|-
| {{mono|iconsprite( "''path/sprite.ext''" )}}
| {{hammer3|4}}<br>{{hammer4|4}}<br>{{jack|4}}<br>{{trenchbroom|4}}
| If this is used, the specified sprite will be shown in the editor's 3D view instead of a flat-shaded colored box. This will work along-side the <code>studio()</code> or <code>studioprop()</code> commands. If no sprite name is set, it uses the <code>model</code> property.

<code>scale</code>, <code>rendermode</code>, <code>_light</code> and <code>angles</code> properties affect the sprite.

Uses {{L|VMT}} in {{hammer4|2}}, {{L|VMAT}} in {{hammer5|2}}, and {{L|SPR}} (QSPR and/or HLSPR) in all other editors.
|-
| {{mono|lightcone( ''inner_fov, outer_fov, color, pitch_scale'' )}}
| {{hammer4|4}}
| Renders the cone used on {{Ent|light_spot}} entities. ''<code>inner_fov</code>'' is the key for the innermost cone section, ''<code>outer_fov</code>'' is the outermost. ''<code>pitch_scale</code>'' allows inverting the pitch angle when rendering the cone. Values are taken from <code>_inner_cone</code>, <code>_cone</code>, and <code>_light</code>, respectively, if they aren't specified. This reads many other values corresponding to light_spot properties.
|-
| {{mono|lightprop( "''path/model.mdl''" )}}
| {{hammer4|4}}
| Identical to <code>studioprop()</code>, except that the pitch of the model is inverted.
|-
| {{mono|line( ''color, start_key, start_value, end_key, end_value'' )}}
| {{hammer4|4}}
| Draws a line between two entities. The ''<code>value</code>'' properties in this entity give the names to look for in the ''<code>key</code>'' property on other entities. ''<code>key</code>'' is usually set to <code>targetname</code>. The color sets the color of the line when the entity is not selected. The second entity defaults to this one if not set.
|-
| {{mono|model({ "path": ''"path/file.ext"'', "frame": ''#'', "skin": #, "scale": ''#'' })}}
| {{trenchbroom|4}}
| A more verbose alternative to {{code|studio()}} for displaying in-editor models, which supports rescaling the displayed model, displaying a specific {{L|skin}}, and display a specific frame of a {{quake}} {{L|Quake MDL}}, an {{quake2}} {{L|MD2}}, or an {{quake3}} {{L|MD3}}. {{gldsrc}} {{L|Half-Life MDL}} animation {{L|sequence}}s are not yet supported, but [https://github.com/TrenchBroom/TrenchBroom/pull/4284 are being worked on].

Can also be used instead of {{code|iconsprite()}} for editor sprites, to select a specific frame of an {{L|SPR}} to display. Sprites can also be scaled this way, although editor sprites are usually already designed to be displayed 1 pixel per unit.
{{tip|All parameters except {{code|"path"}} are optional.}}
{{note|Can do a lot, including conditional values, more verbose documentation can be found in the [https://trenchbroom.github.io/manual/latest/#display-models-for-entities Trenchbroom manual].}}
{{warning|{{code|model()}} is ''only'' supported by Trenchbroom! If it is not necessary to use the extra features available, then {{code|studio()}} or {{code|iconsprite()}} should be used instead, to retain compatibility with other editors.}}
|-
| {{mono|obb( ''min,max'' )}}
| {{hammer4|4}}
| Identical to <code>bbox</code> but oriented to the entity's angles.
|-
| {{mono|origin( ''property'' )}}
| {{hammer4|4}}
| Allows positioning a vector property in the map. 
|-
| {{mono|sidelist( ''sides'' )}}
| {{hammer4|4}}
| Highlight brush faces listed in the given property (as a space-seperated ID list). If not specified, the property used is <code>sides</code>.
|-
| {{mono|size( ''-x,-y,-z,+x,+y,+z'' )}}
| {{hammer4|4}}
| Defines the size of the default cube used when no model or sprite is specified. 
|-
| {{mono|sphere( ''propertyname'' )}}
| {{hammer4|4}}
| If an entity has a radius of effect, like a sound for example, a sphere will be displayed in Hammer's 2D and 3D views. You need to specify the property that will control the sphere size. If no property is specified, it will look for a <code>radius</code> property. 
|-
| {{mono|studio( "''path/model.mdl''" )}}
| {{hammer3|4|nt=5}}<br>{{hammer4|4}}<br>{{jack|4}}<br>{{trenchbroom|4}}
| Identical to <code>studioprop()</code>, but the bounding box around the entity will ignore this model. This is useful for entities that don't render the model ingame.

In {{jack|4}}, and {{trenchbroom|4}}, this parameter also supports other model formats besides {{L|MDL}}, such as {{L|BSP}}, {{L|MD2}}, {{L|MD3}}, ASE, and LWO.
|-
| {{mono|studioprop( "''path/model.mdl''" )}}
| {{hammer4|4}}
| If this is used, the entity will be displayed in the 3D view as the specified model. If no model is specified, the value of the entity's <code>model</code> property will be used, if available (Unless hardcoded). Multiple models can be defined.{{note|If you have an entity with the "angles" property that you want to be able to rotate in Hammer using the mouse (as opposed to only through property editing), you may need to add this modifier.}}{{note|The appearance is affected by the <code>skin</code> and <code>rendercolor</code> properties, similar to {{Ent|prop_dynamic}}.}}
|-
| {{mono|vecline( ''property'' )}}
| {{hammer4|4}}
| Allows positioning a vector property in the map. This also draws a line from the entity to the position.
|-
| {{mono|wirebox( ''min,max'' )}}
| {{hammer4|4}}
| Draws a bounding box for two properties. <code>origin()</code> helpers should be defined as well to allow moving the points.
|}


The following helpers take no arguments and are special-cased for specific entity types:
{| class="wikitable"
|-
! Property
! Description
|-
| {{mono|decal()}}
| Renders decals on nearby surfaces. This uses the '''texture''' property to set the material to use.
|-
| {{mono|overlay()}}
| Renders overlays on a surface. (For {{Ent|info_overlay}})
|-
| {{mono|overlay_transition()}}
| Renders overlays on the intersections between water and the shore. (For {{Ent|info_overlay_transition}})
|-
| {{mono|light()}}
| Present on {{Ent|light}}; its use is unknown. {{todo|Figure out what this does.}}
|-
| {{mono|sprite()}}
| Renders the sprite material specified in the <code>model</code> keyvalue ({{Ent|env_sprite}} and variants). For entity icons, use <code>iconsprite</code>.
|-
| {{mono|sweptplayerhull()}}
| Draws 32x32x72-sized rectangular prisms at two points ('''point0''' and '''point1'''), then links corners to show the space needed for one rectangle to move to the other's position. This also adds <code>origin()</code> helpers for those properties.
|-
| {{mono|instance()}}
| Renders the {{L|func_instance|instance}} in the map. It also generates additional properties dynamically corresponding to the instance parameters.
|-
| {{mono|quadbounds()}}
| Used for {{Ent|func_breakable_surf}}. Automatically sets the 4 corners of the textured face on save. {{todo|Does this also control the "error" keyvalue?}}
|-
| {{mono|worldtext()}} {{only|{{csgobranch}}{{strata}}}}
| Displays the contents of the <code>message</code> keyvalue in the 3D viewport.
|}

=== Entity Description ===
[[File:Hammer entity help.jpg|300px|thumb|right|The entity help box containing the message written on the left.]]
The entity description is a very important thing, as it the one single piece of help you can see in Hammer without consulting any website or developer, by pressing the "Help" button.<br>
Each line of a description may not exceed 125 letters, in which case you must terminate the line and append a + at the end to start a new line in the FGD.<br>
You may write '''\n''' To insert a line break, where hammer will start writing on a new line. You may also enter '''\n \n''' to skip one line entirely.<br>
{{warning|Quotation marks <code>" "</code> are not allowed inside the description, as this will terminate the string. Use Apostrophes <code>' '</code> instead.}}
<syntaxhighlight lang=text highlight=2-5>
@PointClass = example_entity :
    "This is an example description for this example entity. It will appear in the help dialog for this entity.\n " +
    "Sometimes a description string gets very long, which cause errors. In which case we need to terminate the line and " +
    "append a + to the end, telling Hammer the next line is a continuation of the current line. Like in this example.\n " +
    "Note how the Quotation mark appears after a space at the end of the line. Without it, the words between lines get merged"
[
    // (entity properties go here)
]
</syntaxhighlight>

=== Entity Properties ===
Everything between the main set of square brackets {{mono|[ ]}} is used to define the entity's properties, including their keyvalues, inputs and outputs.


==== Keyvalues ====
Individual keyvalues consist of
# a name of at most 31 characters,
# a value type declaration in round brackets,
# ''(optional)'' a colon followed by a string as the display name,
# ''(optional)'' a colon followed by either a default value or no value and
# ''(optional)'' a colon followed by a string as the description.

{{ModernExample|{{pre|
health(integer)
health(integer) : "Strength"
health(integer) : "Strength" : 1
health(integer) : "Strength" : 1 : "Number of points of damage to take before breaking. 0 means don't break."
health(integer) : "Strength" :   : "Number of points of damage to take before breaking. 0 means don't break."
}}}}

The most common value types are:
{| class="wikitable"
|-
! Property Type !! Description
|-
| {{mono|{{L|string}}}}
| A character sequence. The default value must have quotation marks {{mono|" "}} around it.
|-
| {{mono|{{L|integer}}}}
| A whole number. The default value may '''not''' be quoted.
|-
| {{mono|{{L|float}}}}
| A decimal number. The default value must be quoted unless it is a whole number with no decimal point. {{ModernConfirm|Appears to accept scientific notation such as {{mono|1.2e-3}}?}}
|-
| {{mono|{{L|boolean}}}}
:{{as|since}}{{Gmod|also}}
| A value that is either {{mono|true}} (= 0) or {{mono|false}} (not 0). This type needs a default value and it must be either 0 or 1. This creates a dropdown menu for the values Yes/No. For older versions of Hammer, use {{mono|choices}} instead.
{{modernConfusion|For keyvalues it is {{mono|boolean}} but for I/O it is {{mono|bool}}.}}
{{modernImportant|1=This is ''inverse'' of how booleans are usually coded (true = 1)! Use {{mono|choices}} instead.}}
|-
| {{mono|flags}}
| An integer value that is (supposed to be) read bitwise, making it ideal for multiple boolean values. See [[#Flags|below]].
|-
| {{mono|choices}}
| A value that must be one of a pre-defined set of values. This keyvalue type lets you setup a dropdown menu with a number of distinct choices.
{{pre|
Property_name_5(choices) : "Display name" : 1 {{=}}
[
    // <value> : "Display Value"
    0 : "something"
    1 : "something else (default)"
    2 : "something completely different"
]
}}
You can also use strings (or floats) as values, instead of integers, like this:
{{pre|
Property_name_5(choices) : "Model used" : "models/something02.mdl" {{=}}
[
    "models/something01.mdl" : "something"
    "models/something02.mdl" : "something else (default)"
    "models/something03.mdl" : "something completely different"
]
}}
|}
<code>Flags</code> and <code>Choices</code> do not function as input/output types.<br>

{{ModernExample|{{pre|
Property_name_1(string) 	: "Example String Name"		: "Example"	: "Keyvalue Description"
Property_name_2(integer) 	: "Example Interger Name"	: 15		: "Keyvalue Description"
Property_name_3(float)		: "Example Float Name" 		: "1.5"		: "Keyvalue Description"
Property_name_4(boolean)	: "Example Boolean Name"	: 1 		: "Keyvalue Description"
}}}}

{{note|The third value, depicted here as "Example", 15, 1.5 and 1 are the default values. Those will always be there when the entity is being placed. Some string values can also be left empty by using "". in which case there is no default value at all.}}
{{note|Unlike entity descriptions, keyvalue descriptions can not make use of '''\n'''. Only workaround is to manually find out how many spaces you need to fill up a line in the description window.}}


There is also a number of special purpose property types that modify the entity properties dialog UI, for example to allow for easy browsing for files or easier manipulation of complex properties like colors or angles.
{| class="wikitable mw-collapsible" style="background:transparent" width=100%
|-
! Property
! Description
|-
| {{mono|angle}}
| Adds an angle widget for this property to the entity dialog UI.
|-
| {{mono|angle_negative_pitch}}
| Identical to <code>angle</code>, except the pitch is inverted.
|-
| {{mono|axis}}
| Adds a relative 2-point axis helper.
|-
| {{L|color255}}
| Adds a button that brings up the color choosing UI, which takes the color you select and translated it into the three-number RGB value. Allows extra parameters (e.g., brightness).
|-
| {{mono|color1}}
| Adds a color button, but uses a float [0,1] instead of an integer (0,255). Allows extra parameters (e.g., brightness).
|-
| {{mono|decal}}
| Identical to <code>material</code>, except it will automatically replace your search filter with <code>decals/</code> when opening the material browser.{{note|Sometimes, the material you want will be in <code>overlays/</code> or in another folder entirely.}}
|-
| {{mono|filterclass}}
| Marks property as being the name of the filter to use.
|-
| {{mono|instance_file}}
| Adds a button that brings up the file browser, letting you browse for instance files.
|-
| {{mono|instance_parm}}
| Used in {{Ent|func_instance_parms}} to define fixup variables.
|-
| {{mono|instance_variable}}
| Used in {{Ent|func_instance}} to set fixup variables.
|-
| {{mono|material}}
| Adds a button that brings up the material browser.
|-
| {{mono|node_dest}}
| adds an eyedropper to select a node in the 3d view
|-
| {{mono|node_id}}
:{{as|since}}
| On {{L|node}}s, this is used for the Node ID keyvalue to automatically increment it with each consecutive node placed. Does not appear to function when used on other entities.
|-
| {{mono|npcclass}}
| Adds a drop-down selection list populated by entities of the NPCClass type.
|-
| {{mono|origin}}
| origin
|-
| {{mono|particlesystem}}
:{{as|since}}
| Adds a button that brings up the particle browser, letting you browse for particle systems.{{bug|The particle browser cannot read files from {{L|VPK}}s!{{ModernFix|You will need to extract the game's {{L|PCF}} files for anything to appear.}}}}
|-
| {{mono|pointentityclass}}
| Adds a drop-down selection list populated by entities of the <code>PointClass</code> type.
|-
| {{mono|scene}}
| Adds a button that brings up the sound browser, letting you browse for scene files.
|-
| {{mono|script}}
:{{l4d2|since}}
| Adds a button that brings up the file browser, letting you browse for {{L|VScript}}s.
|-
| {{mono|scriptlist}}
:{{l4d2|since}}
| Adds a button that brings up a list of VScripts with buttons to add/remove scripts and open each file.{{note|Vscript browser is most of the time empty. Instead a Vscript name without extension will work just fine.}}
|-
| {{mono|sidelist}}
| Adds a side selection eyedropper that allows you to choose sides (multiple with {{key|Ctrl}}).
|-
| {{mono|sound}}
| Adds a button that brings up the sound browser, letting you browse for soundscripts or raw sounds.
|-
| {{mono|{{L|sprite}}}}
| Identical to <code>material</code>, except it will automatically replace your search filter with <code>sprites/</code> when opening the material browser, and it will add <code>.vmt</code> to the end of the material name.
|-
| {{mono|studio}}
| Adds a button that brings up the model browser.
|-
| {{mono|target_destination}}
| Marks property as another entity's <code>targetname</code>.
|-
| {{mono|target_name_or_class}}
| Marks property as another entity's <code>targetname</code> or <code>classname</code>.
|-
| {{mono|target_source}}
| Marks property as being the name that other entities may target.
|-
| {{mono|vecline}}
| Adds an absolute 1-point axis helper, similar to the origin marker.
|-
| {{mono|vector}}
| 3D vector property. A string consisting of three space delimited numbers.
|}

==== Inputs and Outputs ====
Individual inputs and outputs consist of
# the keyword {{mono|input}} or {{mono|output}},
# a name,
# a value type declaration in round brackets and
# ''(optional)'' a colon followed by a string as the description.
{{ModernExample|{{pre|
input Enable(void)
input Enable(void)  : "Enable this entity."

output OnTakeDamage(void)
output OnTakeDamage(void) : "Fired each time this breakable takes any damage."
}}}}
The possible types include {{mono|void, integer, float, string, bool}} where {{mono|void}} means no value.
{{note|For keyvalues it is {{mono|boolean}} but for I/O it is {{mono|bool}}.}}


==== Flags ====
{{pre|style=float:right; margin:0 1em|
	spawnflags(flags) {{=}}
	[
		         1 : "Flag 01" : 0
		         2 : "Flag 02" : 0
		         4 : "Flag 03" : 0
		         8 : "Flag 04" : 0
		        16 : "Flag 05" : 0
		        32 : "Flag 06" : 0
		        64 : "Flag 07" : 0
		       128 : "Flag 08" : 0
		       256 : "Flag 09" : 0
		       512 : "Flag 10" : 0
		      1024 : "Flag 11" : 0
		      2048 : "Flag 12" : 0
		      4096 : "Flag 13" : 0
		      8192 : "Flag 14" : 0
		     16384 : "Flag 15" : 0
		     32768 : "Flag 16" : 0
		     65536 : "Flag 17" : 0
		    131072 : "Flag 18" : 0
		    262144 : "Flag 19" : 0
		    524288 : "Flag 20" : 0
		   1048576 : "Flag 21" : 0
		   2097152 : "Flag 22" : 0
		   4194304 : "Flag 23" : 0
		   8388608 : "Flag 24" : 0
		  16777216 : "Flag 25" : 0
		  33554432 : "Flag 26" : 0
		  67108864 : "Flag 27" : 0
		 134217728 : "Flag 28" : 0
		 268435456 : "Flag 29" : 0
		 536870912 : "Flag 30" : 0
		1073741824 : "Flag 31" : 0
		2147483648 : "Flag 32" : 0
	]
}}
The flags tab of an entity is configured through its keyvalue named "spawnflags" using the value type "flags". This keyvalue type has a different syntax as seen in the following example:
* After {{mono|spawnflags(flags)}} follows an equals sign and a body surrounded by square brackets {{mono|[ ]}} containing a number of flags.
* Each flag consists of an integer as flag value, a colon, a display string and optionally another colon followed by a default value of 0 or 1.

The flag value should be a power of 2 (2<sup>0</sup>=1, 2<sup>1</sup>=2, 2<sup>2</sup>=4, etc.).<br>
Their default values are either 0 (off) or 1 (on), indicating that the flag's checkbox is either not ticked or ticked. If no default is specified, it is considered off.
{{ModernExample|{{pre|
spawnflags(flags) {{=}}
[
    // <flag value 2^i> : "Checkbox Display Text" : <is ticked by default?>

    1 : "something clever"   : 1
    2 : "something else"     : 0
    4 : "you said what now?" : 0
    8 : "nothing"            : 1
]
}}}}
Due to an integer size of 4 bytes, there can be at most 32 disjoint flags. On the right is a template for all possible flag values, namely 2<sup>0</sup>, ..., 2<sup>31</sup>.
{{clr}}

== Other File Sections ==

=== @mapsize ===
This value defines the maximum usable area in {{L|Hammer}}. This '''visually''' changes the area in Hammer, but unless the game has been coded to allow this size, using anything beyond default values causes {{L|vbsp}} to crash.
{{pre|
@mapsize(-16384, 16384)
}}

=== @include ===
If the game you are writing your FGD for has a lot in common with another game ({{hl2|2}} and {{hl2dm|2}}, for example), you can <code>@include</code> a file that has all of the common structures defined in it. This allows your FGD to read all the data of that FGD.<br>
@Include can be nested. Meaning a game can include another game's FGD, which already includes the <code>base.fgd</code>. For example {{hl2dm|2}} has a FGD which @include's <code>halflife2.fgd</code>, which in turn @include's the <code>base.fgd</code>.<br>
The game or mod you are creating must ship with all FGD's that your own mod is including.
{{pre|
@include "base.fgd"
}}
{{warning|This will include '''all''' entities of the included FGD, making them all appear in your Hammer map editor even if your game does not even have these entities coded.<br>
If you only need a few base classes and entities, it would be recommended to only copy those few into your own FGD.}}

=== @BaseClass ===
A <code>BaseClass</code> is used to setup structures that are used by several different entities via the <code>base(BaseClassName)</code> to the main definition line of the structure.<br>
The <code>BaseClass</code> structure is defined just like a normal entity in all respects. The only difference is that it doesn't appear in the entity lists in Hammer.
{{pre|
@BaseClass {{=}} Angles
[ 
	angles(angle) : "Pitch Yaw Roll (Y Z X)" : "0 0 0" : "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."
]

@BaseClass {{=}} Origin
[ 
	origin(origin) : "Origin (X Y Z)" : : "The position of this entity's center in the world. Rotating entities typically rotate around their origin."
]
}}

=== @MaterialExclusion ===
These lists define paths that Hammer's Material Browser will not use when presenting you with a palette of textures to choose from. It should have no effect on what files are actually available to a custom map.
{{note|Any folder called <code>models/</code> will always be excluded, regardless of what is set here.}}
{{pre|
@MaterialExclusion
[
    // Names of the sub-directories we don't want to load materials from
    "debug"
    "engine"
    "hud"
    "vgui"
]
}}

=== @AutoVisGroup ===
This permits customizing the automatic Visgroups tab of the {{L|Hammer_Filter_Control_Toolbar|Filter Control}} toolbar. The first title is the name of the "parent," and the next is the "children." Finally comes a list of entity classes that will be placed in the visgroup.<br>
If the parent already exists, the new entry will be merged with the previous ones (including the default list of groups). This permits creating trees with multiple levels of grouping. If a visgroup becomes entirely empty, it will not appear in the list.<br>
You may add entities to existing groups if the "Parent" of the autovisgroup is the name of an existing group, like "World Details". For example, you could add {{Ent|func_brush}} to the list "World Details".<br>
{{warning|Having too many AutoVisGroups can cause hammer to lag on startup and during runtime.}}
{{pre|<nowiki>
@AutoVisGroup = "Brushes"
[
    "Triggers"
    [
        "trigger_once"
        "trigger_multiple"
    ]
    "Tool Brushes"
    [
        "func_areaportal"
        "func_viscluster"
    ] 
]

@AutoVisGroup = "Tool Brushes"
[
    "Vis Clusters"
    [
        "func_viscluster"
    ]
]
</nowiki>}}

== Source 2 Additions ==
The following things have been found in {{Source2|2}} FGD files. These will not work in Source 1.<br>
{{todo|Find more things that are not listed here. Explain what these do. So far only occurrences of {{hla}} FGD's have been pasted here for documenting them.}}

=== Classes ===
{| class="wikitable"
|-
! Class Name
! Description
|-
| {{mono|@OverrideClass}}
| This can be used to quite literally overwrite data of existing entities, as well as adding new keyvalues and inputs/outputs.
|-
| {{mono|@CableClass}}
| {{todo|Explain what this does.}}<br>{{hla}} Seen in models_gamedata.fgd
|-
| {{mono|@PathClass}}
| {{todo|Explain what this does.}}<br>{{hla}} Seen in base.fgd
|}

;Examples of these Classes
{{ExpandBox|title=@OverrideClass|{{pre|<nowiki>
// Add an override of player start in order to add it to the ui.
@OverrideClass 
	metadata
	{
		entity_tool_name = "Player Start" 
		entity_tool_group = "Player"
		entity_tool_tip = "Entity which specifies where the player will start."
	}
= info_player_start :
[
]

@OverrideClass = npc_cscanner
[
	//Adds one single input to the npc_cscanner entity, which already existed in HL2 and is in halflife2.fgd
	//Doing this is easier than completely redefining the entire entity.
	input SpawnAsAltScanner(void): "Spawns the Russell skin/bodygroup scanner"
]
</nowiki>}}}}

{{ExpandBox|title=@CableClass|{{pre|<nowiki>
@CableClass = cable_static
[
]
@CableClass base( Targetname, Parentname, Global, RenderFields, Glow, EnableDisable) sphere(fademindist) sphere(fademaxdist) = cable_dynamic
[
	secondary_material(material) : "Secondary Material" : "" : "Optional secondary material, can be selected using Skin(1)"
	lightingorigin(target_destination) : "Lighting Origin" : "" : "Select an entity to specify a location to sample lighting from, instead of using this entity's origin."
	disableshadows(boolean) [ group="Misc" ] : "Disable Shadows" : 0 : "Used to disable dynamic shadows on this entity."

	// Inputs
	input TurnOn(void) : "Make the prop visible."
	input TurnOff(void) : "Make the prop invisible."
	input Skin(integer) : "Changes the model skin to the specified number."
	input EnableCollision(void) : "Enable collision on the prop."
	input DisableCollision(void) : "Disable collision on the prop."
	input SetNavIgnore(boolean) : "Enable and disable NAVIgnore on the prop."
	input DisableShadow(void) : "Turn shadow off."
	input EnableShadow(void) : "Turn shadow on."
	input AlternativeSorting(bool) : "Used to attempt to fix sorting problems when rendering. True activates, false deactivates"
	input SetRenderAttribute(string) : "Set the value of a render attribute used in material dynamic expressions. Examples: $myfloat=0.25 $myfloat4=1.0,0.0,1.0,1.0"
]
</nowiki>}}}}

{{ExpandBox|title=@PathClass|{{pre|<nowiki>
@PathClass base(Targetname) tags( Particles ) particle_rope() 
	metadata
	{
		default_interpolation = "linear"
	}
= path_particle_rope
[
	effect_name(particlesystem) [report] : "Particle System Name" : "particles/entity/path_particle_cable_default.vpcf"
	start_active(boolean) : "Start Active" : 1 : "Will the particle system be visible on spawn"
	max_simulation_time(float) : "Max Time To Simulate" : 0 : "Max number of seconds to run the particle simulation for. A value of 0 means run the simulation indefinitely."
	particle_spacing(float) : "Spacing" : 32 : "Units between the individual partcles in the rope simulation."
	slack(float) : "Slack" : "0.5" : "Controls the amount the rope will drop between path nodes. Generally between 0.0 and 1.0, the value is a multiplier on the distance that particles on path can seperate relative to their initial distance."
	radius(float) : "Radius" : "4.0" : "Radius of the rope."
	static_collision( bool ) : "Create Static Collision" : "0" : "Create a static physics representation of the path. Note the collision is generated based on the path, movement applied by the particle system will not be included."
	surface_properties(surface_properties) : "Surface Properties" : "" : "Surface properties to apply to the static collision if generated"
	color_tint(color255) : "Color Tint" : "255 255 255"
			
	// Inputs
	input Start(void) : "Tell the particle system to start emitting."
	input Stop(void) : "Tell the particle system to stop emitting."
	input StopPlayEndCap(void) : "Tell the particle system to stop emitting and play its End Cap Effect."
	input DestroyImmediately(void) : "Destroy the particle system and remove all particles immediately."
	input SetRadius( float ) : "Set the radius parameter provided the particle system"
	input SetSlack( float ) : "Set the slack parameter which may be used by the particle system to determine how much the rope droops."
	input DisablePin( string ) : "Disable the contraint which pins a particle to the specified path node."
]
</nowiki>}}}}
=== Other commands ===
{| class="wikitable"
|-
! Class Name
! Description
|-
| {{mono|@Exclude}}
| This can exclude individual entities that are in @include'd FGD's. One entity per line
|-
| {{mono|@EntityGroup}}
| {{todo|Explain what this does.}}<br>{{hla}} Seen in hlvr.fgd
|-
| {{mono|@struct}}
| {{todo|Explain what this does.}}<br>{{hla}} Seen in workshop_addoninfo.fgd
|-
| {{mono|@ModelGameData}}
| {{todo|Explain what this does.}}<br>{{hla}} Seen in models_gamedata.fgd<br>Seems to work simillar to {{L|$keyvalues}}.
|-
| {{mono|@ModelBreakCommand}}
| {{todo|Explain what this does.}}<br>{{hla}} Seen in models_gamedata.fgd<br>Seems to work simillar to {{L|$collisiontext}}
|-
| {{mono|@ModelAnimEvent}}
| {{todo|Explain what this does.}}<br>{{hla}} Seen in models_base.fgd<br>Seems to work simillar to {{L|Animation_Events}} in {{L|$sequence|Sequences}}.
|-
| {{mono|Metadata<br> {<br> entity_tool_name = <string><br> entity_tool_tip = <string><br> entity_tool_group = <string><br> }}}
| {{todo|Explain what this does.}}<br>{{hla}} Seen in hlvr.fgd
|-
| {{mono|Deprecated()}}
| Marks a property as depracated and no longer in use.
|}

;Examples of these commands
Below are expandable examples of the above listed commands.<br>
We currently do not have any more good information on what these commands do, but at least we have examples of how to use them.

{{ExpandBox|title=@exclude|{{pre|
// Excluded entities. These are entities that are included from lower level fgd files that aren't 
// functional or useful in this mod. Excluding them removes them from the list of entities aviable 
// in Hammer or any other tool that loads the fgd. If support is added for any of the entities the 
// exclude can simply be removed.

// These entities have been excluded because are deprecated light entities which are
// explictly not supported, don't add these back unless you are working on lighting.
@exclude color_correction_volume
@exclude env_fog_controller
@exclude env_time_of_day
@exclude env_lightglow
@exclude env_particlelight
@exclude env_sun
@exclude fog_volume
@exclude info_lighting
@exclude light_dynamic
@exclude light_irradvolume
@exclude point_spotlight
@exclude postprocess_controller
@exclude shadow_control
}}}}

{{ExpandBox|title=@EntityGroup|{{pre|<nowiki>
// Entity groups. This list specifies which entity groups will show up in the entity tool and in what
// order. If an entity specifies a group that is not in this list it will not be displayed in the tool.
// This allows the mod specific fgd to control the ui.
@EntityGroup "Player" {	start_expanded = true }
@EntityGroup "Lighting" { start_expanded = true }
@EntityGroup "Fog & Sky" { start_expanded = true }
@EntityGroup "NPCs" { start_expanded = true }
@EntityGroup "Items"
@EntityGroup "Ammo"
@EntityGroup "Logic"
</nowiki>}}

{{ExpandBox|title=@Struct|<nowiki>
@struct = map_extension :
[
	parent_map(string) : "Parent Map" : "" : "This is the map that you are extending (eg. <font color='cyan'>{{mono|a1_intro_world}}</font>) - when it loads, your extension map will also be loaded."
	extension_map(string) : "Extension Map" : "" : "Name of a map to overlay on top of the parent map."
]
</nowiki>}}}}

{{ExpandBox|title=@ModelGameData|{{pre|<nowiki>
@ModelGameData = prop_data
[
	base(propdataname) 		: "Base Prop" : : "Base keys (entry from propdata.txt)"
	allowstatic(boolean) 	: "Allow As Static Prop" : 0
	bakelighting(boolean)	: "Bake Lighting As Static Prop" : 1
	damage_table(choices) 	: "Damage Table" : "" : "" =
	[
		""						:	"Inherit Default"
		"player"				:	"Player"
		"player_vehicle"		:	"Player Vehicle"
		"npc"					:	"NPC"
		"glass"					:	"Glass"
		"props"					:	"Props"
		"prevent_impact_damage"	:	"Prevent All Impact Damage"
	]
	dmg.bullets(float) 		: "Damage Bullets" : -1
	dmg.club(float) 		: "Damage Club" : -1
	dmg.explosive(float) 	: "Damage Explosive" : -1
	dmg.fire(float) 		: "Damage Fire" : -1
	health(float) 			: "Health" : -1
	spawn_motion_disabled(boolean) : "Spawn as Motion-Disabled" : 0
]
</nowiki>}}}}

{{ExpandBox|title=@ModelBreakCommand|{{pre|<nowiki>
@ModelBreakCommand base(base_break_force)
= break_uniform_burst : "Applies a radial burst to breakpieces outwards from the influence point (default is the origin of the model)"
[
	burst_scale(float) [ min="0", max="500" ]		: "Burst Scale"					: 0		: "Velocity added to each piece (radially away from the influence point)"
	burst_randomize(float) [ min="0", max="500" ]	: "Burst Randomize"				: 0		: "Magnitude of random vector that will be added to the burst velocity"
]

@ModelBreakCommand base(base_break_force)
= break_flip_pieces : "Applies an angular 'flip' to breakpieces (like objects tipping over from an explosion or flower petals opening) causing them to tip outwards from the influence point (default is the origin of the model)"
[
	burst_scale(float) [ min="-500", max="500" ]	: "Flip Scale"					: 0		: "Angular velocity added to each piece (Positive value will cause pieces to flip 'head-first' away from the influence point, negative is 'feet-first')"
	burst_randomize(float) [ min="0", max="500" ]	: "Flip Randomize"				: 0		: "Largest possible value that will be randomly added/removed to Flip Scale for each piece"
]

@ModelBreakCommand base(base_break_force)
= break_twist_pieces : "Applies an angular 'twist' to breakpieces, causing them to roll around the radial axis outward from the influence point (default is the origin of the model)"
[
	burst_scale(float) [ min="-500", max="500" ]	: "Twist Scale"					: 0		: "Angular velocity added to each piece"
	burst_randomize(float) [ min="0", max="500" ]	: "Twist Randomize"				: 0		: "Largest possible value that will be randomly added/removed to Twist Scale for each piece"
]
</nowiki>}}}}

{{ExpandBox|title=@ModelAnimEvent|{{pre|<nowiki>
@ModelAnimEvent = AE_CL_PLAYSOUND_ATTACHMENT
[
	name(sound) [report] : "Sound"
	attachment(model_attachment) : "Attachment"
	stop_on_seq_change(bool) : "Auto-stop on sequence change or death" : "0"
	use_layer_sequence(bool) : "Use Layer Sequence" : "0"
	tags(string)				: "Tags"
]
@ModelAnimEvent = AE_COMPANION_PRODUCE_FLARE 
[
	attachment(model_attachment) : "Attachment"
]

@ModelAnimEvent = AE_STRIDER_SHOOTMINIGUN 
[
	target(string) : "Target"
]
</nowiki>}}}}

{{ExpandBox|title=Metadata|<syntaxhighlight lang=text highlight=2-7>
@PointClass base(BasePropPhysics, Targetname, Parentname ) model( "models/props_combine/health_charger/health_vial.vmdl" )
	metadata
	{
		entity_tool_name = "Health Station Vial"
		entity_tool_tip = "Vial used to power a health station"
		entity_tool_group = "Items"
	}
= item_hlvr_health_station_vial : "Health Vial"
[
	vial_level(float) : "Health Vial Level (0-1)" : "1" : "Amount of health the vial starts with."
]</syntaxhighlight>}}

{{ExpandBox|title=deprecated()|{{pre|<nowiki>
@ModelAnimEvent deprecated() = AE_STRIDER_FOOTSTEP_LEFT [ ]
@ModelAnimEvent deprecated() = AE_STRIDER_FOOTSTEP_RIGHT [ ]
@ModelAnimEvent deprecated() = AE_STRIDER_FOOTSTEP_BACK [ ]
@ModelAnimEvent deprecated() = AE_MARINE_FOOTSTEP [ ]
@ModelAnimEvent deprecated() = AE_FOOTSTEP_LEFT [ ]
@ModelAnimEvent deprecated() = AE_FOOTSTEP_RIGHT [ ]
@ModelAnimEvent deprecated() = AE_SV_FOOTSTEP_LEFT [ ]
@ModelAnimEvent deprecated() = AE_SV_FOOTSTEP_RIGHT [ ]
@ModelAnimEvent deprecated() = AE_ANTLION_FOOTSTEP_HEAVY [ ]
@ModelAnimEvent deprecated() = AE_ANTLION_FOOTSTEP_SOFT [ ]
</nowiki>}}}}

== Files ==
The FGD files of a game can be found under <code><steam directory>/steamapps/common/<full game name>/bin/*.fgd</code>, for example <code>.../common/Half-Life 2/bin/halflife2.fgd</code>.

== See also ==
* {{LCategory|FGD}}

== External links ==
* [https://github.com/Pinsplash/SEFGD SE FGD's] Updated FGD's for some Valve games, made by Pinsplash.
* [https://github.com/Crowbar-Sledgehammer/forge-game-data-language Forge Game Data Language] <code>.fgd</code> syntax highlighting available in textmate format (SublimeText Compatible)

{{ACategory|File formats|fgd}}
{{ACategory|Files|fgd}}
{{ACategory|Hammer|fgd}}