Scripting Shell

Functions

Shell.Execute(script)

Executes a Serious Engine 1 shell script. Equivalent to the engine's CShell::Execute() function.

Arguments:

• script - String with the shell script.

Return value: null

---

Shell.SymbolExists(symbol)

Checks whether the specified symbol exists in the shell.

Arguments:

• symbol - String with the variable symbol.

Return value: bool

---

Shell.GetFloat(symbol)

Returns float value of the specified shell symbol. May return an arbitrary erroneous value if the symbol doesn't exist or is not a float. Equivalent to the engine's CShell::GetFLOAT() function.

Arguments:

• symbol - String with the variable symbol.

Return value: float

---

Shell.SetFloat(symbol, value)

Equivalent to the engine's CShell::SetFLOAT() function.

Arguments:

• symbol - String with the variable symbol.
• value - integer or float with the value to set.

Return value: null

---

Shell.GetIndex(symbol)

Returns integer value of the specified shell symbol. May return an arbitrary erroneous value if the symbol doesn't exist or is not an integer. Equivalent to the engine's CShell::GetINDEX() function.

Arguments:

• symbol - String with the variable symbol.

Return value: integer

---

Shell.SetIndex(symbol, value)

Equivalent to the engine's CShell::SetINDEX() function.

Arguments:

• symbol - String with the variable symbol.
• value - integer or bool with the value to set.

Return value: null

---

Shell.GetString(symbol)

Returns string value of the specified shell symbol. May return an arbitrary erroneous value if the symbol doesn't exist or is not a string. Equivalent to the engine's CShell::GetString() function.

Arguments:

• symbol - String with the variable symbol.

Return value: string

---

Shell.SetString(symbol, value)

Equivalent to the engine's CShell::SetString() function.

Arguments:

• symbol - String with the variable symbol.
• value - String with the value to set.

Return value: null

---

Shell.GetValue(symbol)

Returns current value of the specified shell symbol regardless of type converted to a string. Equivalent to the engine's CShell::GetValue() function.

Arguments:

• symbol - String with the variable symbol.

Return value: string

---

Shell.SetValue(symbol, value)

Equivalent to the engine's CShell::SetValue() function.

Arguments:

• symbol - String with the variable symbol.
• value - String with the value to set, e.g. a number if the variable is of INDEX/FLOAT type.

Return value: null