Aurora::NWScript Namespace Reference

Classes
class	EngineType
class	FunctionContext
class	FunctionManager
class	NCSFile
	An NCS, BioWare's NWN Compile Script. More...
class	NCSStack
class	Object
class	ObjectContainer
class	ObjectManager
class	ObjectReference
class	ObjectSearch
struct	ScriptState
class	SearchList
class	SearchRange
class	SearchTagMap
class	Variable
class	VariableContainer

Typedefs
typedef std::vector< Type >	Signature
typedef std::vector< class Variable >	Parameters
typedef boost::function< void(class FunctionContext &ctx)>	Function

Enumerations
enum	Type {   kTypeVoid = 0, kTypeInt, kTypeFloat, kTypeString,   kTypeObject, kTypeVector, kTypeEngineType, kTypeScriptState,   kTypeArray, kTypeReference, kTypeAny }

Functions
Common::UString	formatTag (const Object *object)
	Construct a string with the tag of this object. More...
void	formatVariable (Common::UString &str, const Variable &var)
	Print a description of this variable into that string. More...
Common::UString	formatParams (const FunctionContext &ctx)
	Construct a string describing parameters of this function. More...
Common::UString	formatReturn (const FunctionContext &ctx)
	Construct a string describing the return value of this function. More...
Common::UString	formatType (Type type)
	Construct a string describing this variable type. More...

Variables
static const Common::UString	kStringEmpty

Typedef Documentation

Function

typedef boost::function<void (class FunctionContext &ctx)> Aurora::NWScript::Function

Definition at line 56 of file types.h.

Parameters

typedef std::vector<class Variable> Aurora::NWScript::Parameters

Definition at line 54 of file types.h.

Signature

typedef std::vector<Type> Aurora::NWScript::Signature

Definition at line 52 of file types.h.

Enumeration Type Documentation

Type

enum Aurora::NWScript::Type

Enumerator
kTypeVoid
kTypeInt
kTypeFloat
kTypeString
kTypeObject
kTypeVector
kTypeEngineType	"effect", "event", "location", "talent"...
kTypeScriptState	"action".
kTypeArray
kTypeReference	A reference/pointer to another variable.
kTypeAny	Any other type.

Definition at line 36 of file types.h.

Function Documentation

formatParams()

Common::UString Aurora::NWScript::formatParams

(

const FunctionContext &

ctx

)

Construct a string describing parameters of this function.

Definition at line 109 of file util.cpp.

References formatVariable(), and Aurora::NWScript::FunctionContext::getParams().

Referenced by Aurora::NWScript::FunctionManager::call(), Engines::DragonAge::Functions::unimplementedFunction(), Engines::DragonAge2::Functions::unimplementedFunction(), Engines::NWN::Functions::unimplementedFunction(), Engines::Witcher::Functions::unimplementedFunction(), Engines::NWN2::Functions::unimplementedFunction(), Engines::KotOR2::Functions::unimplementedFunction(), Engines::KotOR::Functions::unimplementedFunction(), and Engines::Jade::Functions::unimplementedFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

formatReturn()

Common::UString Aurora::NWScript::formatReturn

(

const FunctionContext &

ctx

)

Construct a string describing the return value of this function.

Definition at line 121 of file util.cpp.

References formatVariable(), Aurora::NWScript::FunctionContext::getReturn(), Aurora::NWScript::Variable::getType(), and kTypeVoid.

Referenced by Aurora::NWScript::FunctionManager::call().

Here is the call graph for this function:

Here is the caller graph for this function:

formatTag()

Common::UString Aurora::NWScript::formatTag

(

const Object *

object

)

Construct a string with the tag of this object.

Definition at line 34 of file util.cpp.

Referenced by Engines::Witcher::Functions::executeScript(), Engines::Jade::Functions::executeScript(), Engines::NWN::Functions::executeScript(), Engines::NWN2::Functions::executeScript(), formatVariable(), Engines::DragonAge2::Functions::logTrace(), Engines::DragonAge::Functions::logTrace(), Engines::DragonAge::Functions::objectToString(), Engines::DragonAge2::Functions::objectToString(), Engines::NWN2::Functions::objectToString(), Engines::KotOR2::Functions::objectToString(), Engines::NWN::Functions::objectToString(), Engines::Witcher::Functions::objectToString(), Engines::KotOR::Functions::objectToString(), Engines::Jade::Functions::objectToString(), Engines::DragonAge::Functions::printObject(), Engines::DragonAge2::Functions::printObject(), Engines::NWN::Functions::printObject(), Engines::NWN2::Functions::printObject(), Engines::KotOR2::Functions::printObject(), Engines::Witcher::Functions::printObject(), Engines::KotOR::Functions::printObject(), and Engines::Jade::Functions::printObject().

Here is the caller graph for this function:

formatType()

Common::UString Aurora::NWScript::formatType

(

Type

type

)

Construct a string describing this variable type.

Definition at line 130 of file util.cpp.

References kTypeAny, kTypeArray, kTypeEngineType, kTypeFloat, kTypeInt, kTypeObject, kTypeReference, kTypeScriptState, kTypeString, kTypeVector, and kTypeVoid.

Referenced by Aurora::NWScript::FunctionManager::call(), formatVariable(), Engines::DragonAge2::Functions::unimplementedFunction(), Engines::DragonAge::Functions::unimplementedFunction(), Engines::NWN2::Functions::unimplementedFunction(), Engines::NWN::Functions::unimplementedFunction(), Engines::Witcher::Functions::unimplementedFunction(), Engines::KotOR2::Functions::unimplementedFunction(), Engines::KotOR::Functions::unimplementedFunction(), and Engines::Jade::Functions::unimplementedFunction().

Here is the caller graph for this function:

formatVariable()

void Aurora::NWScript::formatVariable	(	Common::UString &	str,
		const Variable &	var
	)

Print a description of this variable into that string.

Definition at line 41 of file util.cpp.

References Common::composeString(), formatTag(), formatType(), Aurora::NWScript::Variable::getArray(), Aurora::NWScript::Variable::getFloat(), Aurora::NWScript::Variable::getInt(), Aurora::NWScript::Variable::getObject(), Aurora::NWScript::Variable::getReference(), Aurora::NWScript::Variable::getString(), Aurora::NWScript::Variable::getType(), Aurora::NWScript::Variable::getVector(), kTypeArray, kTypeFloat, kTypeInt, kTypeObject, kTypeReference, kTypeString, and kTypeVector.

Referenced by formatParams(), formatReturn(), and Aurora::NWScript::NCSStack::print().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

kStringEmpty

const Common::UString Aurora::NWScript::kStringEmpty

static

Definition at line 174 of file functioncontext.cpp.

Referenced by Aurora::NWScript::FunctionContext::getScriptName().