Entity Article Template: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Link to snipar as C&P donor...)
(Bullet-point reduction. Got a regexp to do this, so will go through previously formatted entity pages and fix...)
Line 12: Line 12:


* '''Name''' ''targetname <target_source>''   
* '''Name''' ''targetname <target_source>''   
** The name that other entities refer to this entity by.
: The name that other entities refer to this entity by.
 
* '''Badger''' ''hamster <gerbil_thingy>''
* '''Badger''' ''hamster <gerbil_thingy>''
** List continues like this.
: List continues like this.


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


* '''Kill'''
* '''Kill'''
** Removes this entity from the world.
: Removes this entity from the world.
 
* '''KillHierarchy'''   
* '''KillHierarchy'''   
** Removes this entity and all its children from the world.
: Removes this entity and all its children from the world.
 
* '''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'''  
** Causes this entity's OnUser1 output to be fired.
: Causes this entity's OnUser1 output to be fired.
 
* '''FireUser2'''  
* '''FireUser2'''  
** Causes this entity's OnUser2 output to be fired.
: Causes this entity's OnUser2 output to be fired.
 
* '''FireUser3'''  
* '''FireUser3'''  
** Causes this entity's OnUser3 output to be fired.
: Causes this entity's OnUser3 output to be fired.
 
* '''FireUser4'''  
* '''FireUser4'''  
** Causes this entity's OnUser4 output to be fired.
: Causes this entity's OnUser4 output to be fired.
 
* '''ResponseVitalNPC'''  
* '''ResponseVitalNPC'''  
** Fire the VitalNPC Died response.
: Fire the VitalNPC Died response.


===Outputs===
===Outputs===


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


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

Revision as of 08:04, 9 July 2005

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 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.

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...

Entity Values

Keys

  • Name targetname <target_source>
The name that other entities refer to this entity by.
  • Badger hamster <gerbil_thingy>
List continues like this.

Inputs

  • 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.
  • ResponseVitalNPC
Fire the VitalNPC Died response.

Outputs

  • 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