Template:I Targetname: Difference between revisions
Jump to navigation
Jump to search
Deprecated (talk | contribs) (Unified some text between {{I BaseEntity}} and {{I Targetname}}) |
(Started using new Since, etc. templates, revised documentation) |
||
Line 1: | Line 1: | ||
{{ScrollBox|title=Targetname|noscroll=true| | {{ScrollBox|title=Targetname|noscroll=true| | ||
{{IO|Kill|Removes this entity | {{IO|Kill|Removes this entity from the world.}} | ||
{{IO|KillHierarchy| | {{IO|KillHierarchy|Removes this entity and its children from the world. {{note|Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than <code>Kill</code>.}}}} | ||
{{IO|AddOutput| | {{IO|[[AddOutput]]|Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.<br/>''KV'' Format: <code><key> <value></code><br/>''I/O'' 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 | {{IO|Use|Same as a player invoking [[Use|+use]]; may not do anything depending on the entity. Can also be invoked by firing an output that does not specify an input.|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= | {{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= | {{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.|param=string|since= | {{IO|CallScriptFunction|Execute a VScript function in the scope of the receiving entity.|param=string|since={{l4d2}}|nofgd=1}} | ||
{{IO|SetLocalOrigin|param=coordinates|since= | {{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|param=angles|since= | {{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 14:04, 8 May 2020
Targetname:
- Kill
- Removes this entity from the world.
- KillHierarchy
- Removes this entity and its children from the world.
Note:Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than
Kill
.
- AddOutput <string>
- Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format:<key> <value>
I/O 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 depending on the entity. Can also be invoked by firing an output that does not specify an input.
- RunScriptFile <script> (in all games since
)
- 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
)
- 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
, 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: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
) !FGD
- Execute a VScript function in the scope of the receiving entity.
- SetLocalOrigin <coordinates> (in all games since
) !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.