StelScriptMgr Class Reference

#include <StelScriptMgr.hpp>

List of all members.

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 ()

---

Detailed Description

Manage scripting in Stellarium.

---

Member Function Documentation

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

const QString StelScriptMgr::getAuthor

(

const QString &

s

)

[slot]

Gets the name of the script Author.

Parameters:

s	the file name of the script whose name is to be returned.

Returns:

text following a comment with Author: at the start. If no such comment is found, "" is returned. If the file is not found or cannot be opened for some reason, an Empty string will be returned.

const QString StelScriptMgr::getDescription

(

const QString &

s

)

[slot]

Gets a description of the script.

Parameters:

s	the file name of the script whose name is to be returned.

Returns:

text following a comment with Description: at the start. The description is considered to be over when a line with no comment is found. If no such comment is found, QString("") is returned. If the file is not found or cannot be opened for some reason, an Empty string will be returned.

const QString StelScriptMgr::getLicense

(

const QString &

s

)

[slot]

Gets the licensing terms for the script.

Parameters:

s	the file name of the script whose name is to be returned.

Returns:

text following a comment with License: at the start. If no such comment is found, "" is returned. If the file is not found or cannot be opened for some reason, an Empty string will be returned.

const QString StelScriptMgr::getName

(

const QString &

s

)

[slot]

Gets a single line name of the script.

Parameters:

s	the file name of the script whose name is to be returned.

Returns:

text following a comment with Name: at the start. If no such comment is found, the file name will be returned. If the file is not found or cannot be opened for some reason, an Empty string will be returned.

double StelScriptMgr::getScriptRate

(

)

[slot]

Get the rate at which the script is running as a multiple of the normal execution rate.

QString StelScriptMgr::runningScriptId

(

)

Get the ID (filename) of the currently running script.

Returns:

Empty string if no script is running, else the ID of the script which is running.

bool StelScriptMgr::runScript	(	const QString &	fileName,
		const QString &	includePath = ""
	)		[slot]

Run the script located at the given location.

Parameters:

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).

Returns:

false if the named script could not be run, true otherwise

bool StelScriptMgr::scriptIsRunning

(

)

Find out if a script is running.

Returns:

true if a script is running, else false

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.

Parameters:

r	rate, e.g. 2.0 = script runs at twice the normal rate

void StelScriptMgr::stopScript

(

)

[slot]

Stops any running script.

Returns:

false if no script was running, true otherwise.