QSDK 1.1 Documentation
Main Page | Modules | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members | Related Pages

Q::ScriptConsole Struct Reference
[Script Toolkit]

#include <gamelib.h>

Inheritance diagram for Q::ScriptConsole:

Q::KeyboardListener Com::Unknown List of all members.

Public Types

typedef Com::Ptr< ScriptConsole > PTR

Public Member Functions

virtual TextLayer textLayer () const=0
virtual Utils::Result setTextLayer (const TextLayer &)=0
virtual Utils::Result addVariable (const char *name, Variant *value)=0
virtual Utils::Result getVariable (const char *name, Variant **)=0
virtual Utils::Result toString (ScriptExecutionListener::ErrorType, Utils::String &) const=0

Static Public Member Functions

PTR create ()

Static Public Attributes

Com::UUID IID
Com::UUID CLSID

Detailed Description

A ScriptConsole is a QScript interpreter that executes scripts and displays feedback on a TextLayer.

Member Typedef Documentation

typedef Com::Ptr<ScriptConsole> Q::ScriptConsole::PTR
 

A COM pointer to an object of this class

Member Function Documentation

virtual Utils::Result Q::ScriptConsole::addVariable (  const char *  name,
Variant *  value
)  [pure virtual]
 

Add a variable with the specified name and the specified value.

ScriptConsole::PTR Q::ScriptConsole::create (   )  [inline, static]
 

Convenience function to create a ScriptConsole

virtual Utils::Result Q::ScriptConsole::getVariable (  const char *  name,
Variant ** 
)  [pure virtual]
 

Get the variable with the specified name if it exists.

virtual Utils::Result Q::ScriptConsole::setTextLayer (  const TextLayer &   )  [pure virtual]
 

Set the TextLayer that renders the console.

virtual TextLayer Q::ScriptConsole::textLayer (   )  const [pure virtual]
 

Return the TextLayer that renders the console.

virtual Utils::Result Q::ScriptConsole::toString (  ScriptExecutionListener::ErrorType  ,
Utils::String & 
)  const [pure virtual]
 

Convert script errors into strings.

Member Data Documentation

Com::UUID Q::ScriptConsole::CLSID [static]
 

COM CLSID d694756b-1d5f-4bd3-94de-7c355bdac532

Com::UUID Q::ScriptConsole::IID [static]
 

COM IID 2b4e96da-7d52-4d75-9311-b6dad339b647

Reimplemented from Com::Unknown.

Return to QSDK documentation Contents page. Contact details for support, information and fault-reporting.
Qube Software Limited © 2000-2004