Entity Article Template: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Bullet-point reduction. Got a regexp to do this, so will go through previously formatted entity pages and fix...)
(updated formatting, add flags, more descriptions)
Line 1: Line 1:
==Entity Description==
==Entity Description==
'''Entity Name:''' entity_name_here


Original formatting nicked from [[ai_citizen_response_system]] article - no idea whose it was, but it looked better than mine... ;-)
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]].


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. Description of entity goes here, blah blah. The quick brown fox jumps over the lazy dog. 1234567890.  
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|npc_sniper]] article could be handy. Many of the details seem the same for different NPCs, so it could save typing...
For an NPC's inputs, outputs etc. the [[Npc_sniper|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]].


==Entity Values==
==Entity Values==
Line 14: Line 15:
: The name that other entities refer to this entity by.
: The name that other entities refer to this entity by.


* '''Badger''' ''hamster <gerbil_thingy>''
* '''Key''' ''value <type of value>''
: List continues like this.
: Description of what the key is used for.
 
===Flags===
 
* '''Flag Name'''
: Description of the flag.
 
* '''Flag Name'''
: Description of the flag.


===Inputs===
===Inputs===
* '''Intput Name'''
: Description of the Input.


* '''Kill'''
* '''Kill'''
Line 26: Line 38:


* '''AddOutput''' ''<string> <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>''  
* '''AddOutput''' ''<string> <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>''  
: Adds an entity I/O connection to this entity. Very dangerous, use with care
: Adds an entity I/O connection to this entity. Very dangerous, use with care.


* '''FireUser1'''  
* '''FireUser1'''  
Line 40: Line 52:
: Causes this entity's OnUser4 output to be fired.
: Causes this entity's OnUser4 output to be fired.


* '''ResponseVitalNPC'''
===Outputs===
: Fire the VitalNPC Died response.


===Outputs===
* '''Output Name'''
: Description of the Output.


* '''OnUser1'''  
* '''OnUser1'''  
Line 59: Line 71:
==See Also==
==See Also==


* Add links to related articles, entities, or tutorials here.
* [[Assaults]] - appropriate links to tutorials, related articles and entities etc.
* [[Assaults]] - appropriate links to tutorials, related articles and entities etc.
* [[ambient_generic]]
* [[ambient_generic]]
* [[trigger_auto]]
* [[trigger_auto]]

Revision as of 12:39, 9 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.

Entity Values

Keys

  • Name targetname <target_source>
The name that other entities refer to this entity by.
  • Key value <type of value>
Description of what the key is used for.

Flags

  • Flag Name
Description of the flag.
  • Flag Name
Description of the flag.

Inputs

  • Intput Name
Description of the Input.
  • Kill
Removes this entity from the world.
  • KillHierarchy
Removes this entity and all its children from the world.
  • AddOutput <string> <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>
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.

Outputs

  • Output Name
Description of the Output.
  • OnUser1
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

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