RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
placeholder_expression

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
placeholder_expression [2017/06/01 08:54] – justinplaceholder_expression [2021/04/11 21:00] – justin
Line 2: Line 2:
 ---- ----
  
-**Placeholder expressions** provide a way to insert dynamic values into [[string|strings]] that will get evaluated at game runtime. Examples of supported values include entity properties, global properties, and arithmetical expressions. Placeholder expressions are currently only supported by the [[Display Message]] function.+**Placeholder expressions** provide a way to insert dynamic values into [[string|strings]] that will get evaluated at game runtime for displaying to the player or printing to the [[developer console]]. Generally, any sort of expression that can be stored into a variable can also be used in a placeholder expression. 
 + 
 +<WRAP center round info 100%> 
 +Since placeholder expressions are parsed during a [[script|script's]] execution, they should be used sparingly to avoid potential slowdowns or hesitations. When possible, it's best to first store the expression into a variable and then use [[string|string concatenation]] to generate the desired [[string]]. 
 +</WRAP>
  
 In regards to usage, the expression must be enclosed using the following syntax consisting of a dollar sign and curly braces: In regards to usage, the expression must be enclosed using the following syntax consisting of a dollar sign and curly braces:
  
-<code lua>+<code bauxite>
 ${expression} ${expression}
 </code> </code>
Line 13: Line 17:
  
 ====Example:==== ====Example:====
-<code lua>+<code bauxite>
 display_message("The value of property ABC is ${global.property[\"ABC\"]}") display_message("The value of property ABC is ${global.property[\"ABC\"]}")
 </code> </code>
  
 ~~NOTOC~~ ~~NOTOC~~
placeholder_expression.txt · Last modified: 2021/04/21 20:23 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki