![]() |
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="") |
bool | stopScript (void) |
void | setScriptRate (double r) |
double | getScriptRate (void) |
void | debug (const QString &msg) |
Signals | |
void | scriptRunning () |
void | scriptStopped () |
void | scriptDebug (const QString &) |
Public Member Functions | |
StelScriptMgr (QObject *parent=0) | |
QStringList | getScriptList (void) |
bool | scriptIsRunning (void) |
QString | runningScriptId (void) |
bool StelScriptMgr::scriptIsRunning | ( | void | ) |
Find out if a script is running.
QString StelScriptMgr::runningScriptId | ( | void | ) |
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). |
bool StelScriptMgr::stopScript | ( | void | ) | [slot] |
Stops any running script.
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.