Skip to content

ScriptVariables.md

Latest commit

 

History

History
55 lines (36 loc) · 1.5 KB

ScriptVariables.md

File metadata and controls

55 lines (36 loc) · 1.5 KB

Script [Variables] Section

This section contains any predefined variables and macros the script needs to reference. The variables are loaded into memory when the script is processed during a build, a section within the script is called using the Exec command, or when another script loads them with the AddVariables command.

This documentation refers to the Variables section located within the .script files. For documentation relating to the Variables section for script.project refer to Project Variables.

Syntax

Script variables and macros are defined using the .INI style Key=Value format. Variables must be enclosed in % percent signs.

Variables

%myProgramName%="My Program"

Macros

myMacro=Run,%PluginFile%,DoSomething

Note that the macro name is not enclosed in % signs.

Remarks

None.

Related

AddVariables, Exec, Project Main, Project Process, Project Variables, Script Interface, Script Main, Script Process, Macros

Examples

Example 1

[Main]
Title=Variables Section
Description=Variables Section Example
Author=Homes32
Level=5
Version=1

[Variables]
%myProgramName%="My Program"
myMacro=Run,%ScriptFile%,EchoMessage

[Process]
myMacro,%myProgramName%

[EchoMessage]
Echo,#1
Message,#1