Entity Article Template: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(added more common keys and inputs)
No edit summary
Line 9: Line 9:
The information for the entity Keys, Outputs, and Inputs can be found inside the Hammer entity help, or in the [[FGD]]. Flag names can only be found in the [[FGD]].
The information for the entity Keys, Outputs, and Inputs can be found inside the Hammer entity help, or in the [[FGD]]. Flag names can only be found in the [[FGD]].


==Entity Values==
==Keyvalues==
===Keys===


* '''Key''' ''value <type of value>''
* '''key name'''
: Replace this with a description of what the key is used for.
: <type of value> Replace this with a description of what the key is used for.


* '''Name''' ''targetname <target_source>''
* {{kv targetname}}
: The name that other entities refer to this entity by.


* '''Parent''' ''parentname <target_destination>''
* {{kv parentname}}
: The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.


* '''Pitch Yaw Roll (Y Z X)''' ''angles <angle>''
* {{kv angles}}
: 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.


* '''Color (R G B)''' ''rendercolor <color255>''
* '''rendercolor'''
: The color of the spotlight cone.
: <color255> The color of the spotlight cone.


===Flags===
==Flags==


* '''Flag Name'''
* '''Flag Name'''
Line 35: Line 31:
: Replace this with a description of the flag.
: Replace this with a description of the flag.


===Inputs===
==Inputs==


* '''Intput Name'''
* '''Intput Name'''
: Replace this with a description of the Input.
: Replace this with a description of the Input.


* '''Kill'''
* {{i targetname}}
: Removes this entity from the world.


* '''KillHierarchy''' 
* {{i parentname}}
: Removes this entity and all its children from the world.


* '''AddOutput''' ''<string> <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>''
==Outputs==
: Adds an entity I/O connection to this entity. Very dangerous, use with care.
 
* '''FireUser1'''
: Causes this entity's OnUser1 output to be fired.
 
* '''FireUser2'''
: Causes this entity's OnUser2 output to be fired.
 
* '''FireUser3'''
: Causes this entity's OnUser3 output to be fired.
 
* '''FireUser4'''
: Causes this entity's OnUser4 output to be fired.
 
* '''SetParent''' ''<string>''
: Changes the entity's parent in the movement hierarchy.
 
* '''SetParentAttachment''' ''<string>''
: Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
 
* '''ClearParent'''
: Removes this entity from the the movement hierarchy, leaving it free to move independently.
 
===Outputs===


* '''Output Name'''
* '''Output Name'''
: Replace this with a description of the Output.
: Replace this with a description of the Output.


* '''OnUser1'''
* {{i targetname}}
: Fired in response to FireUser1 input.
 
* '''OnUser2'''
: Fired in response to FireUser2 input.
 
* '''OnUser3'''
: Fired in response to FireUser3 input.
 
* '''OnUser4'''
: Fired in response to FireUser4 input.


==See Also==
==See Also==

Revision as of 22:50, 11 July 2005

Entity Description

Description of the entity goes here. This should be a plainly-worded but accurate description of the basic function of the entity. A basic description for most entities is included in the help built into Hammer.

The quick brown fox jumps over the lazy dog. 1234567890. Description of entity goes here, blah blah. The quick brown fox jumps over the lazy dog. 1234567890. Description of entity goes here, blah blah. The quick brown fox jumps over the lazy dog. 1234567890.

For an NPC's inputs, outputs etc. the npc_sniper article could be handy. Many of the details seem the same for different NPCs, so it could save typing.

The information for the entity Keys, Outputs, and Inputs can be found inside the Hammer entity help, or in the FGD. Flag names can only be found in the FGD.

Keyvalues

  • key name
<type of value> Replace this with a description of what the key is used for.
  • rendercolor
<color255> The color of the spotlight cone.

Flags

  • Flag Name
Replace this with a description of the flag.
  • Flag Name
Replace this with a description of the flag.

Inputs

  • Intput Name
Replace this with a description of the Input.

Outputs

  • Output Name
Replace this with a description of the Output.

See Also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Entity_Article_Template&oldid=4352"