There are 332 commands. Click at a category to see its commands or use the search.
• PLEASE READ: Info for using this reference
abs, freevar, freevars, getlocal, loadvars, local, rename, savevars, setlocal, temp, tempall, varexists
Categories: variables, returnReturns the absolute value of a variable - meaning: the number turns positive
Categories: variables, freeDeletes all variables. The parameter Locals allows you to choose wether the local variables shall be deleted too (standard value: 1)
getlocal "Class", ID, "Variable"
Categories: variables, returnGets the value of a certain local variable at a certain object. This allows to access local variables from other objects.
Categories: variables, returnLoads all variables from a file that has been saved before per savevars command (standard destination: "varcache" in the mod folder).
Afterwards, the variables are available again as normal global variables - just like before
local "Variable" ... [,"Variable"]
Categories: variablesMakes one or more variables local. You can only access local variables from the object where the script is executed.
The variables will be created and set to 0 if they don't exist already.
savevars ["File"] [, "Variables"]
Categories: variables, returnSaves all global variables in a file (standard destination: "varcache" in the mod folder). If File is filled in, the values will be saved to the particular name instead.
By standard, ALL global variables will be saved. Alternatively, you can name variables by the parameter Variables (seperated by commas). In this case, only the desired variables will be saved.
Depending on wether the process was successful, the parameter will return 1 or 0. Per loadvars command the variables can be loaded again
setlocal "Class", ID, "Variable" [,Value]
Categories: variablesSets or changes the value of a certain local variable at a certain object. This allows to access local variables from other objects. Value is 0 by default.
temp "Variable" ... [,"Variable"]
Categories: variablesMarks one or more variables as temporary. Temporary variables will not be saved with savegames.
Categories: variablesMarks all variables as temporary. Temporary variables will not be saved with savegames.
Categories: variables, returnChecks wether the specified variable does exist or not, and accordingly returns either 1 or 0