Generic Keyvalues, Inputs and Outputs/Inputs: Difference between revisions
Jump to navigation
Jump to search
Available doc translations
m (CSGO param - TeamNum input now supports a 'teamnum_dont_put_nofgd' value) |
(doc page migration. SetTeam / TeamNum inputs are yet to be migrated. Template changes: DispatchEffects removed note now is hidden if base is active; Fixed AS keyvalues being represented as Portal2 param (latter not fully removed);resorted some keys) |
||
| Line 1: | Line 1: | ||
<includeonly>{{minititle|Base}} | |||
{{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 this entity and any entities parented to it are killed on the same frame, being marginally faster than <code>Kill</code>.}} | {{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>.}} | ||
| Line 31: | Line 8: | ||
{{IO|[[AddOutput]]|Evaluates a keyvalue/output on this entity. <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. <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|DispatchResponse|Dispatches a response to the entity. See [[Response]] and [[Concept]].|param=string|nofgd=1}} | {{IO|DispatchResponse|Dispatches a response to the entity. See [[Response]] and [[Concept]].|param=string|nofgd=1}} | ||
{{IO|AddContext|Adds to the entity's list of [[Response System|response contexts]]. Format is <code><key>:<value></code>.|param=string}} | {{IO|AddContext|Adds to the entity's list of [[Response System|response contexts]]. Format is <code><key>:<value></code>.|param=string}} | ||
{{IO|RemoveContext|Remove a context from this entity's list. The name should match the key of an existing context.|param=string}} | {{IO|RemoveContext|Remove a context from this entity's list. The name should match the key of an existing context.|param=string}} | ||
{{IO|ClearContext|Removes all contexts from this entity's list.|param=string}}<!-- | {{IO|ClearContext|Removes all contexts from this entity's list.|param=string}} | ||
-->{{#if:{{{ | <!-- IF: BASE -->{{#if:{{{base|}}}| | ||
-->{{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|DispatchEffect|Dispatches a special effect from the entity's origin. |param=string|nofgd=1}} | ||
|{{IO|DispatchEffect|Dispatches a special effect from the entity's origin. Removed and replaced entirely by the [[particle]] system since {{l4d}}.|param=string|removed={{l4d}}|nofgd=1}} | |||
}} | |||
{{IO|Use|Same as a player invoking [[+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}} | |||
<!-- | |||
++ Game Specifics ++ | |||
--> | |||
<!-- IF: L4D2 -->{{#if:{{{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.|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}} | ||
--> | | }}<!-- IF: AS -->{{#if:{{{as|}}}{{{portal2|}}}| | ||
{{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={{as}}|nofgd=1|Set this entity's angles.}}<!-- | {{IO|SetLocalAngles|param=angles|since={{as}}|nofgd=1|Set this entity's angles.}} | ||
--> | | }}<!-- IF: NOT BASE, L4D2 and AS -->{{#if:{{{l4d2|}}}||{{#if:{{{as|}}}{{{portal2|}}}||{{#if:{{{base|}}}|| | ||
{{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.|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}} | ||
| Line 52: | Line 35: | ||
-->}}}}}} | -->}}}}}} | ||
<!-- | <!-- | ||
++ SetTeam | ++ SetTeam related things go here ++ | ||
--> | --> | ||
<!-- IF: TF2 | <!-- IF: TF2 -->{{#if:{{{tf2|}}}| | ||
{{IO|SetTeam|Reassign the team of this entity as the team using this number. | {{IO|SetTeam|Reassign the team of this entity as the team using this number. | ||
:*0: None | :*0: None | ||
| Line 69: | Line 43: | ||
:*2: Red {{tf2}} | :*2: Red {{tf2}} | ||
:*3: Blue {{tf2}} | :*3: Blue {{tf2}} | ||
|param=choices|nofgd=1 }} | |param=choices|nofgd=1}} | ||
| | |<!-- ELSE IF: ANY[CSS, L4D, L4D2] -->{{#if:{{{css|}}}||{{#if:{{{l4d|}}}||{{#if:{{{l4d2|}}}| | ||
{{IO|SetTeam|Doesn't do anything in {{l4ds}} | {{IO|SetTeam|Doesn't do anything in {{l4ds}} or {{css}}.|deprecated=1|nofgd=1}} | ||
{{IO|TeamNum|Doesn't do anything in {{l4ds}} or {{css}}.|deprecated=1|nofgd=1}} | |||
|<!-- ELSE IF: CSGO -->{{#if:{{{csgo|}}}| | |||
{{IO|SetTeam|Only<code>TeamNum</code>works in {{csgo}}.|deprecated=1}} | |||
|deprecated=1|nofgd=1 }} | |||
| | |||
{{IO|SetTeam|Only<code>TeamNum</code>works in {{csgo}}.|deprecated=1}} | |||
{{IO|TeamNum|Reassign the team of this entity as the team using this number. | {{IO|TeamNum|Reassign the team of this entity as the team using this number. | ||
:*0: None | :*0: None | ||
| Line 91: | Line 54: | ||
:*2: Terrorists {{csgo}} | :*2: Terrorists {{csgo}} | ||
:*3: Counter-Terrorists {{csgo}} | :*3: Counter-Terrorists {{csgo}} | ||
param=choices|nofgd=1}} | |||
| }}</includeonly> | | }}}}}}}}}}</includeonly> | ||
<noinclude> | |||
{{documentation}} | |||
<!-- Add categories to the /doc subpage, not here --> | |||
</noinclude> | |||
Revision as of 12:12, 27 April 2021
Available doc translations …
