Lua run: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m ({{lang}} -> {{Language subpage}})
Line 4: Line 4:
{{clr}}
{{clr}}
== Keyvalues ==
== Keyvalues ==
{{KV|Code|intn=Code|string|Lua code to run when triggered.}}
{{KV|Code|intn=Code|string|Lua code to run when triggered.</br>The lua variables {{Code|ACTIVATOR}} and {{Code|CALLER}} may be used in the code, as well as {{Code|TRIGGER_PLAYER}} if '''!activator''' resolves to a player.}}
{{ModernBugfix|In Hammer, using string arguments will corrupt the [[VMF]] file's structure, making the file unviewable for the next Hammer session.|Remove the string argument manually with a text editor.}}
{{Bug|In Hammer, using double quotes {{Code|"}} as string arguments will corrupt the [[VMF]] file's structure, making the file unviewable for the next Hammer session.{{Workaround|You should instead use either an apostrophe (single quote) {{Code|'}} or brackets {{Code|[[]]}} to contain your strings.}}{{Fix|To fix an unreadable .vmf broken in this way, remove the double quote manually with a text editor.}}}}
{{KV Targetname}}
{{KV Targetname}}
== Flags ==
== Flags ==
*1: Run code on spawn
*1: Run code on spawn

Revision as of 14:11, 5 July 2023

English (en)Русский (ru)Translate (Translate)

Template:Entity It runs raw Lua code given to it in its keyvalues.

Keyvalues

Code (Code) <string>
Lua code to run when triggered.
The lua variables ACTIVATOR and CALLER may be used in the code, as well as TRIGGER_PLAYER if !activator resolves to a player.
Icon-Bug.pngBug:In Hammer, using double quotes " as string arguments will corrupt the VMF file's structure, making the file unviewable for the next Hammer session.
PlacementTip.pngWorkaround:You should instead use either an apostrophe (single quote) ' or brackets [[]] to contain your strings.
Note.pngFix:To fix an unreadable .vmf broken in this way, remove the double quote manually with a text editor.
  [todo tested in ?]
Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Flags

  • 1: Run code on spawn

Inputs

RunCode
Run Code that was defined in the entity.
RunPassedCode <stringRedirectInput/string>
Run code that was passed as a variable.

Outputs