![]() |
Home · All Namespaces · All Classes · Functions · Coding Style · Scripting · Plugins · File Structure |
#include <StelScriptMgr.hpp>
Public Slots | |
const QString | getName (const QString &s) |
const QString | getAuthor (const QString &s) |
const QString | getLicense (const QString &s) |
const QString | getDescription (const QString &s) |
bool | runScript (const QString &fileName, const QString &includePath="") |
void | stopScript () |
void | setScriptRate (float r) |
double | getScriptRate () |
void | debug (const QString &msg) |
Signals | |
void | scriptRunning () |
void | scriptStopped () |
void | scriptDebug (const QString &) |
Public Member Functions | |
StelScriptMgr (QObject *parent=0) | |
QStringList | getScriptList () |
bool | scriptIsRunning () |
QString | runningScriptId () |
bool StelScriptMgr::scriptIsRunning | ( | ) |
Find out if a script is running.
QString StelScriptMgr::runningScriptId | ( | ) |
Get the ID (filename) of the currently running script.
const QString StelScriptMgr::getName | ( | const QString & | s | ) | [slot] |
Gets a single line name of the script.
s | the file name of the script whose name is to be returned. |
const QString StelScriptMgr::getAuthor | ( | const QString & | s | ) | [slot] |
Gets the name of the script Author.
s | the file name of the script whose name is to be returned. |
const QString StelScriptMgr::getLicense | ( | const QString & | s | ) | [slot] |
Gets the licensing terms for the script.
s | the file name of the script whose name is to be returned. |
const QString StelScriptMgr::getDescription | ( | const QString & | s | ) | [slot] |
Gets a description of the script.
s | the file name of the script whose name is to be returned. |
bool StelScriptMgr::runScript | ( | const QString & | fileName, | |
const QString & | includePath = "" | |||
) | [slot] |
Run the script located at the given location.
fileName | the location of the file containing the script. | |
includePath | the directory to use when searching for include files in the SSC preprocessor. Usually this will be the same as the script file itself, but if you're running a generated script from a temp directory, but want to include a file from elsewhere, it can be usetul to set it to something else (e.g. in ScriptConsole). |
void StelScriptMgr::stopScript | ( | ) | [slot] |
Stops any running script.
void StelScriptMgr::setScriptRate | ( | float | r | ) | [slot] |
Changes the rate at which the script executes as a multiple of real time.
Note that this is not the same as the rate at which simulation time passes because the script running at normal rate might set the simulation time rate to be non-real time.
r | rate, e.g. 2.0 = script runs at twice the normal rate |
double StelScriptMgr::getScriptRate | ( | ) | [slot] |
Get the rate at which the script is running as a multiple of the normal execution rate.
void StelScriptMgr::debug | ( | const QString & | msg | ) | [slot] |
cause the emission of the scriptDebug signal.
This is so that functions in StelMainScriptAPI can explicitly send information to the ScriptConsole
void StelScriptMgr::scriptRunning | ( | ) | [signal] |
Notification when a script starts running.
void StelScriptMgr::scriptStopped | ( | ) | [signal] |
Notification when a script has stopped running.
void StelScriptMgr::scriptDebug | ( | const QString & | ) | [signal] |
Notification of a script event - warnings, current execution line etc.