Engine:CCMD run

Reference e
Engine
AddOns API Form
Engine UI
AddOns UI API UI Form UI XML UI Event UI Lua UI Macro CVars Changes Guides Snippets Categories

→ UI CCmd

← Console commands

Load and run script file. Run a named script file. Name must include extension.

run startup.cfg

Arguments

• name - The name of the script file to load and run.

Associations

• Is by default placed in the 'global' context.

Details

The word "script" can be a very loose term in general, with lots of meanings. Here it can be even more confusing.

In Engine, the most basic type of script is comprised of a core set of facilities in the Data module, which are composed of vars, cmds, aliases, binds, and contexts, with a very basic syntax.

This very basic syntax structure however lends well to being flexible and extensible, and thus sometimes confusing. A complex base Engine script can interact with many different environments and contexts.

Script statement syntax

1. 'Statements' are text blocks that begin with a command name, and are followed by any other text, and end with line-end or semi-colon. A new statement can begin adjacent to the previous statements ending delimiter.

2. Command names begin or end at white-space, semi-colon, or line-end, and end at comment start.

3. Other text starts after any white-space after command name, until semi-colon, line-end, or comment start.

4. Comment text starts with '//', placed anywhere on a line, and includes all text until line-end.

5. Comment text, empty statements or lines, or statements or lines with only white-space, will be skipped.

6. Command names must be at least 2 and less than 63 characters. Statements with invalid command names will be skipped.

7. Other text may contain quoted text, where ''' or '"' are valid quote begin and end quote characters.

8. If quoted text is found, any semi-colons, line-ends, or comment starts will be ignored, until next matching quote character.

9. No other checking or processing is done on any 'other text' after the command name, and any actual meaning is context-dependent and determined when the actual statement is run.

10. If embedded in text a NULL, or '\0', or any character less than ' ', will be considered as a white-space character. This means that a '\0' delimits a command name, stays included in other-text as is, and is otherwise ignored. This also means that these characters can not be used in command names.

11. Command names in this context can contain any character except white-space and ';', and cannot contain '//'. Command names can also have quote characters in the name and are not checked for closing quotes and treated as is as a part of the name. Valid command names: bob/"bob"/bob, "bob", bob", "bob.

12. 'Executable statements' are composed of both the parsed 'command name' and 'other text' components, excluding comments, and each are the product of this function which gets run.

Examples

Default values

For a script file named 'startup.cfg' and looks like:

echo fred
lua print(1 + 3)
alias bob fred
var fred james
bob

• Try to load a non-existent file.

> run bob.cfg
Run failed: bob.cfg

• Run the example script file.

> run startup.cfg
fred
4
'fred' is 'james'

In this case: echos 'fred' to console, runs a Lua statement that adds '1 + 3' and prints the result, creates an alias 'bob', creates 'fred' variable that the alias 'bob' will show the value of, runs the 'bob' alias that effectively prints the value of 'fred' that is 'james'.