Template:I Targetname: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(KillHierarchy kills children faster than Kill, tested with 32 objects parented to each other and timing them, with host_timescale 1 and host_timescale 0.1. Only useful if you need very precise Kill I/O to happen)
(Unified some text between {{I BaseEntity}} and {{I Targetname}})
Line 1: Line 1:
{{ScrollBox|title=Targetname|noscroll=true|
{{ScrollBox|title=Targetname|noscroll=true|
{{IO|Kill|Removes this entity and any entities parented to it from the world.}}
{{IO|Kill|Removes this entity and any entities parented to it from the world.}}
{{IO|KillHierarchy|Functions the same as <code>Kill</code>, although entities with a large number of children are killed marginally faster.}}
{{IO|KillHierarchy|Functions the same as <code>Kill</code>, although this entity and any entities parented to it are killed on the same frame, being marginally faster than <code>Kill</code>.}}
{{IO|AddOutput|Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.<br/>Format: <code><key> <value></code><br/>Format: <code><output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite></code>|param=string}}
{{IO|AddOutput|Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.<br/>Format: <code><key> <value></code><br/>Format: <code><output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite></code>|param=string}}
{{IO|FireUser1|to=FireUser4|Fire the <code>OnUser</code> outputs; see [[User Inputs and Outputs]].}}
{{IO|FireUser1|to=FireUser4|Fire the <code>OnUser</code> outputs; see [[User Inputs and Outputs]].}}
{{IO|Use|Same as a player invoking [[Use|+use]]; may not do anything. Can also be invoked by creating an output that does not specify an input.<br /> This input is not included in Valve's [[FGD]]s.|nofgd=1}}
{{IO|Use|Same as a player invoking [[Use|+use]]; may not do anything. Can also be invoked by creating an output that does not specify an input.<br /> This input is not included in Valve's [[FGD]]s.|nofgd=1}}
{{IO|RunScriptFile|Execute a [[VScript]] file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.|param=script|since=L4D2}}
{{IO|RunScriptFile|Execute a [[VScript]] file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.|param=script|since=L4D2}}
{{IO|RunScriptCode|Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console. {{bug| In {{l4d2}}, the code is executed in the script scope of the entity that fires the output, ''not'' the one receiving the input.}} {{warning|Never try to pass string parameters to a script function with this input. It will corrupt the [[VMF]] structure because of the nested quotation marks, which then must be removed manually with a text editor.}}|param=string|since=L4D2}}
{{IO|RunScriptCode|Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console. {{bug|In {{l4d2}}, the code is executed in the script scope of the entity that fires the output, ''not'' the one receiving the input.}} {{warning|Never try to pass string parameters to a script function with this input. It will corrupt the [[VMF]] structure because of the nested quotation marks, which then must be removed manually with a text editor.}}|param=string|since=L4D2}}
{{IO|CallScriptFunction|Execute a VScript function in the scope of the receiving entity. {{note|This input is missing from some games FGD files.}} |param=string|since=L4D2|nofgd=1}}
{{IO|CallScriptFunction|Execute a VScript function in the scope of the receiving entity.|param=string|since=L4D2|nofgd=1}}
{{IO|SetLocalOrigin|Set this entity's origin in the map. {{note|This input is missing from some games FGD files.}} |param=origin|since=AS|nofgd=1}}
{{IO|SetLocalOrigin|param=coordinates|since=AS|nofgd=1|Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.}}
{{IO|SetLocalAngles|Set this entity's angles in the map. {{note|This input is missing from some games FGD files.}} |param=angles|since=AS|nofgd=1}}
{{IO|SetLocalAngles|param=angles|since=AS|nofgd=1|Set this entity's angles.}}
}}<noinclude>
}}<noinclude>
[[Category:Input Templates|Targetname]]
[[Category:Input Templates|Targetname]]
</noinclude>
</noinclude>

Revision as of 10:05, 24 May 2019

Targetname:
Kill
Removes this entity and any entities parented to it from the world.
KillHierarchy
Functions the same as Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster than Kill.
AddOutput <string>
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Use  !FGD
Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile <script> (in all games since Left 4 Dead 2)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode <string> (in all games since Left 4 Dead 2)
Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.
Icon-Bug.pngBug:In Left 4 Dead 2, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.  [todo tested in ?]
Warning.pngWarning:Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction <string> (in all games since Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (in all games since Alien Swarm) !FGD
Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
SetLocalAngles <angles> (in all games since Alien Swarm) !FGD
Set this entity's angles.