#include <module.h>

Inheritance diagram for Engines::Witcher::Module:

[legend]

Collaboration diagram for Engines::Witcher::Module:

[legend]

Classes
struct	Action

Public Member Functions
	Module (::Engines::Console &console)

	~Module ()

bool	isLoaded () const
	Is a module currently loaded and ready to run? More...

bool	isRunning () const
	Is a module currently running? More...

const Aurora::IFOFile &	getIFO () const
	Return the IFO of the currently loaded module. More...

const Aurora::LocString &	getName () const
	Return the module's name. More...

const Aurora::LocString &	getDescription () const
	Return the module's description. More...

Area *	getCurrentArea ()
	Return the area the PC is currently in. More...

Creature *	getPC ()
	Return the currently playing PC. More...

void	refreshLocalized ()
	Refresh all localized strings. More...

void	delayScript (const Common::UString &script, const Aurora::NWScript::ScriptState &state, Aurora::NWScript::Object owner, Aurora::NWScript::Object triggerer, uint32 delay)

void	movePC (const Common::UString &area)
	Move the player character to this area. More...

void	movePC (float x, float y, float z)
	Move the player character to this position within the current area. More...

void	movePC (const Common::UString &area, float x, float y, float z)
	Move the player character to this position within this area. More...

void	movePC (Area *area, float x, float y, float z)
	Move the player character to this position within this area. More...

void	movePC (const Common::UString &module, const Common::UString &object)
	Move the player character to this object within this area. More...

void	movedPC ()
	Notify the module that the PC was moved. More...

void	clear ()
	Clear the whole context. More...

void	load (const Common::UString &module, const Common::UString &entryLocation="")
	Load a module. More...

void	exit ()
	Exit the currently running module. More...

void	enter (Creature &pc)
	Enter the loaded module, starting it. More...

void	leave ()
	Leave the running module, quitting it. More...

void	addEvent (const Events::Event &event)
	Add a single event for consideration into the event queue. More...

void	processEventQueue ()
	Process the current event queue. More...

Public Member Functions inherited from Engines::Witcher::Object
	Object (ObjectType type=kObjectTypeInvalid)

virtual	~Object ()

ObjectType	getType () const
	Return the exact type of the object. More...

virtual void	loadModel ()
	Load the object's model(s). More...

virtual void	unloadModel ()
	Unload the object's model(s). More...

virtual void	show ()
	Show the object's model(s). More...

virtual void	hide ()
	Hide the object's model(s). More...

const std::list< uint32 > &	getIDs () const
	Return the object's model IDs. More...

const Common::UString &	getUniqueID () const
	Return the object's globally unique ID. More...

const Aurora::LocString &	getName () const
	Return the object's name. More...

const Aurora::LocString &	getDescription () const
	Return the object's description. More...

const Common::UString &	getConversation () const
	Return the object's default conversation (DLG). More...

bool	isStatic () const
	Is the object static (not manipulable at all)? More...

bool	isUsable () const
	Can the object be used by the PC? More...

bool	isClickable () const
	Can the player click the object? More...

Area *	getArea () const
	Return the area this object is currently in. More...

void	setArea (Area *)
	Set the area this object is currently in. More...

virtual void	getPosition (float &x, float &y, float &z) const
	Return the object's position within its area. More...

virtual void	getOrientation (float &x, float &y, float &z, float &angle) const
	Return the object's orientation. More...

virtual void	setPosition (float x, float y, float z)
	Set the object's position within its area. More...

virtual void	setOrientation (float x, float y, float z, float angle)
	Set the object's orientation. More...

Location	getLocation () const
	Create a Location out of the object's area, position and orientation. More...

virtual void	enter ()
	The cursor entered the object. More...

virtual void	highlight (bool enabled)
	(Un)Highlight the object. More...

virtual bool	click (Object *triggerer=0)
	The object was clicked. More...

void	speakString (const Common::UString &string, uint32 volume)
	Speak the specified string. More...

void	speakOneLiner (Common::UString conv, Object *tokenTarget=0)
	Speak an one-liner from the specified conversation file. More...

void	stopSound ()
	Stop the current object sound. More...

void	playSound (const Common::UString &sound, bool pitchVariance=false)
	Play an object sound. More...

Public Member Functions inherited from Aurora::NWScript::Object
	Object ()

uint32	getID () const

const Common::UString &	getTag () const

Public Member Functions inherited from Aurora::NWScript::VariableContainer
	VariableContainer ()

virtual	~VariableContainer ()

bool	hasVariable (const Common::UString &var) const

Variable &	getVariable (const Common::UString &var, Type type=kTypeVoid)

const Variable &	getVariable (const Common::UString &var) const

void	setVariable (const Common::UString &var, const Variable &value)

void	removeVariable (const Common::UString &var)

void	clearVariables ()

Public Member Functions inherited from Engines::Witcher::ScriptContainer
	ScriptContainer ()

	~ScriptContainer ()

const Common::UString &	getScript (Script script) const

bool	hasScript (Script script) const

bool	runScript (Script script, const Aurora::NWScript::ObjectReference owner=Aurora::NWScript::ObjectReference(), const Aurora::NWScript::ObjectReference triggerer=Aurora::NWScript::ObjectReference())

Public Member Functions inherited from Engines::Witcher::ObjectContainer
	ObjectContainer ()

	~ObjectContainer ()

void	clearObjects ()

void	addObject (Witcher::Object &object)
	Add an object to this container. More...

void	removeObject (Witcher::Object &object)
	Remove an object from this container. More...

::Aurora::NWScript::Object *	getFirstObjectByType (ObjectType type) const
	Return the first object of this type. More...

::Aurora::NWScript::ObjectSearch *	findObjectsByType (ObjectType type) const
	Return a search context to iterate over all objects of this type. More...

Public Member Functions inherited from Aurora::NWScript::ObjectContainer
	ObjectContainer ()

	~ObjectContainer ()

void	clearObjects ()

void	addObject (Object &object)
	Add an object to this container. More...

void	removeObject (Object &object)
	Remove an object from this container. More...

Object *	getObjectByID (uint32 id) const
	Find a specific object by ID. More...

Object *	getFirstObject () const
	Return the first object. More...

Object *	getFirstObjectByTag (const Common::UString &tag) const
	Return the first object with this tag. More...

ObjectSearch *	findObjects () const
	Return a search context to iterate over all objects. More...

ObjectSearch *	findObjectsByTag (const Common::UString &tag) const
	Return a search context to iterate over all objects with this tag. More...

Static Public Member Functions
static Common::UString	getName (const Common::UString &module)

static Common::UString	getDescription (const Common::UString &module)

static Common::UString	findModule (const Common::UString &module, bool relative)

Static Public Member Functions inherited from Engines::Witcher::ScriptContainer
static bool	runScript (const Common::UString &script, const Aurora::NWScript::ObjectReference owner=Aurora::NWScript::ObjectReference(), const Aurora::NWScript::ObjectReference triggerer=Aurora::NWScript::ObjectReference())

static bool	runScript (const Common::UString &script, const Aurora::NWScript::ScriptState &state, const Aurora::NWScript::ObjectReference owner=Aurora::NWScript::ObjectReference(), const Aurora::NWScript::ObjectReference triggerer=Aurora::NWScript::ObjectReference())

Static Public Member Functions inherited from Engines::Witcher::ObjectContainer
static Witcher::Object *	toObject (::Aurora::NWScript::Object *object)

static Module *	toModule (Aurora::NWScript::Object *object)

static Area *	toArea (Aurora::NWScript::Object *object)

static Waypoint *	toWaypoint (Aurora::NWScript::Object *object)

static Situated *	toSituated (Aurora::NWScript::Object *object)

static Placeable *	toPlaceable (Aurora::NWScript::Object *object)

static Door *	toDoor (Aurora::NWScript::Object *object)

static Creature *	toCreature (Aurora::NWScript::Object *object)

static Creature *	toPC (Aurora::NWScript::Object *object)

static Location *	toLocation (Aurora::NWScript::EngineType *engineType)

Private Types
enum	ActionType { kActionNone = 0, kActionScript = 1 }

typedef Common::PtrMap< Common::UString, Area >	AreaMap

typedef std::list< Events::Event >	EventQueue

typedef std::multiset< Action >	ActionQueue

Private Member Functions
void	unload ()
	Unload the whole shebang. More...

void	unloadModule ()
	Unload the module. More...

void	unloadPC ()
	Unload the PC. More...

void	unloadAreas ()
	Unload the areas. More...

void	loadAreas ()
	Load the areas. More...

void	enterArea ()
	Enter a new area. More...

void	loadModule (const Common::UString &module, const Common::UString &entryLocation)
	Load the actual module. More...

void	changeModule (const Common::UString &module, const Common::UString &entryLocation)
	Schedule a change to a new module. More...

void	replaceModule ()
	Actually replace the currently running module. More...

bool	getObjectLocation (const Common::UString &object, Common::UString &area, float &x, float &y, float &z, float &angle)

bool	getEntryObjectLocation (Common::UString &area, float &entryX, float &entryY, float &entryZ, float &entryAngle)

void	getEntryIFOLocation (Common::UString &area, float &entryX, float &entryY, float &entryZ, float &entryAngle)

void	handleEvents ()

void	handleActions ()

Private Attributes
::Engines::Console *	_console

bool	_hasModule
	Do we have a module? More...

bool	_running
	Are we currently running a module? More...

bool	_exit
	Should we exit the module? More...

Common::ChangeID	_resModule
	Resources added by the module. More...

Aurora::IFOFile	_ifo
	The module's IFO. More...

Creature *	_pc
	The player character we use. More...

AreaMap	_areas
	The areas in the current module. More...

Common::UString	_newArea
	The new area to enter. More...

Area *	_currentArea
	The current area. More...

Common::UString	_module
	The current module's name. More...

Common::UString	_newModule
	The module we should change to. More...

Common::UString	_entryLocation
	The tag of the object in the start location for this module. More...

EventQueue	_eventQueue

ActionQueue	_delayedActions

Additional Inherited Members
Protected Member Functions inherited from Engines::Witcher::ScriptContainer
void	clearScripts ()

void	readScripts (const Aurora::GFF3Struct &gff)

void	readScripts (const ScriptContainer &container)

Protected Member Functions inherited from Aurora::NWScript::ObjectContainer
void	lock ()

void	unlock ()

Protected Attributes inherited from Engines::Witcher::Object
ObjectType	_type
	The object's type. More...

Common::UString	_uniqueID
	A globally unique ID. More...

Aurora::LocString	_name
	The object's name. More...

Aurora::LocString	_description
	The object's description. More...

Common::UString	_conversation
	The object's default conversation. More...

bool	_static
	Is the object static? More...

bool	_usable
	Is the object usable? More...

std::list< uint32 >	_ids
	The object's model IDs. More...

Area *	_area
	The area the object is currently in. More...

float	_position [3]
	The object's position. More...

float	_orientation [4]
	The object's orientation. More...

Sound::ChannelHandle	_sound
	The currently playing object sound. More...

Protected Attributes inherited from Aurora::NWScript::Object
uint32	_id

Common::UString	_tag

Detailed Description

Definition at line 54 of file module.h.

Member Typedef Documentation

◆ ActionQueue

typedef std::multiset<Action> Engines::Witcher::Module::ActionQueue

private

Definition at line 158 of file module.h.

◆ AreaMap

typedef Common::PtrMap<Common::UString, Area> Engines::Witcher::Module::AreaMap

private

Definition at line 155 of file module.h.

◆ EventQueue

typedef std::list<Events::Event> Engines::Witcher::Module::EventQueue

private

Definition at line 157 of file module.h.

Member Enumeration Documentation

◆ ActionType

enum Engines::Witcher::Module::ActionType

private

Enumerator
kActionNone
kActionScript

Definition at line 136 of file module.h.

Constructor & Destructor Documentation

◆ Module()

Engines::Witcher::Module::Module ( ::Engines::Console & console )

Definition at line 59 of file module.cpp.

◆ ~Module()

Engines::Witcher::Module::~Module ( )

Definition at line 64 of file module.cpp.

References clear().

Here is the call graph for this function:

Member Function Documentation

◆ addEvent()

void Engines::Witcher::Module::addEvent ( const Events::Event & event )

Add a single event for consideration into the event queue.

Definition at line 268 of file module.cpp.

References _eventQueue.

◆ changeModule()

void Engines::Witcher::Module::changeModule	(	const Common::UString &	module,
		const Common::UString &	entryLocation
	)

private

Schedule a change to a new module.

Definition at line 135 of file module.cpp.

References _entryLocation, and _newModule.

Referenced by load().

Here is the caller graph for this function:

◆ clear()

void Engines::Witcher::Module::clear ( )

Clear the whole context.

Definition at line 71 of file module.cpp.

References unload().

Referenced by ~Module().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delayScript()

void Engines::Witcher::Module::delayScript	(	const Common::UString &	script,
		const Aurora::NWScript::ScriptState &	state,
		Aurora::NWScript::Object *	owner,
		Aurora::NWScript::Object *	triggerer,
		uint32	delay
	)

Definition at line 505 of file module.cpp.

References _delayedActions, EventMan, kActionScript, Engines::Witcher::Module::Action::owner, Engines::Witcher::Module::Action::script, Engines::Witcher::Module::Action::state, Engines::Witcher::Module::Action::timestamp, Engines::Witcher::Module::Action::triggerer, and Engines::Witcher::Module::Action::type.

Referenced by Engines::Witcher::Functions::actionDoCommand(), Engines::Witcher::Functions::assignCommand(), and Engines::Witcher::Functions::delayCommand().

Here is the caller graph for this function:

◆ enter()

void Engines::Witcher::Module::enter ( Creature & pc )

Enter the loaded module, starting it.

Definition at line 161 of file module.cpp.

References _console, _exit, _ifo, Engines::Witcher::Object::_name, _newArea, _pc, _running, Common::StackException::add(), Engines::Witcher::ObjectContainer::addObject(), Common::UString::c_str(), CameraMan, Common::UString::empty(), getEntryIFOLocation(), getEntryObjectLocation(), Engines::Witcher::Object::getName(), Aurora::IFOFile::getStartMovie(), Aurora::LocString::getString(), isLoaded(), Engines::Witcher::kScriptEnter, Engines::Witcher::kScriptModuleLoad, Engines::Witcher::kScriptModuleStart, loadAreas(), Engines::Witcher::Object::loadModel(), Engines::playVideo(), Engines::Console::printf(), Engines::Witcher::ScriptContainer::runScript(), Engines::Witcher::Object::setOrientation(), and Engines::Witcher::Object::setPosition().

Here is the call graph for this function:

◆ enterArea()

void Engines::Witcher::Module::enterArea ( )

private

Enter a new area.

Definition at line 285 of file module.cpp.

Referenced by processEventQueue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exit()

void Engines::Witcher::Module::exit ( )

Exit the currently running module.

◆ findModule()

Common::UString Engines::Witcher::Module::findModule	(	const Common::UString &	module,
		bool	relative
	)

static

Definition at line 551 of file module.cpp.

References ConfigMan, Common::UString::equalsIgnoreCase(), Common::FilePath::getFile(), Common::FilePath::relativize(), and ResMan.

Referenced by getDescription(), getName(), and Engines::Witcher::Campaign::setupStandaloneModule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentArea()

Area * Engines::Witcher::Module::getCurrentArea ( )

Return the area the PC is currently in.

Definition at line 75 of file module.cpp.

References _currentArea.

◆ getDescription() [1/2]

const Aurora::LocString & Engines::Witcher::Module::getDescription ( ) const

Return the module's description.

Definition at line 496 of file module.cpp.

References Engines::Witcher::Object::getDescription().

Here is the call graph for this function:

◆ getDescription() [2/2]

Common::UString Engines::Witcher::Module::getDescription ( const Common::UString & module )

static

Definition at line 536 of file module.cpp.

References findModule(), Aurora::Archive::findResource(), Aurora::ERFFile::getResource(), Aurora::GFF3Struct::getString(), Aurora::GFF3File::getTopLevel(), Aurora::kFileTypeIFO, and MKTAG.

Here is the call graph for this function:

◆ getEntryIFOLocation()

void Engines::Witcher::Module::getEntryIFOLocation	(	Common::UString &	area,
		float &	entryX,
		float &	entryY,
		float &	entryZ,
		float &	entryAngle
	)

private

Definition at line 248 of file module.cpp.

References _ifo, Aurora::IFOFile::getEntryArea(), Aurora::IFOFile::getEntryDirection(), Aurora::IFOFile::getEntryPosition(), and Common::rad2deg().

Referenced by enter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEntryObjectLocation()

bool Engines::Witcher::Module::getEntryObjectLocation	(	Common::UString &	area,
		float &	entryX,
		float &	entryY,
		float &	entryZ,
		float &	entryAngle
	)

private

Definition at line 242 of file module.cpp.

References _entryLocation, and getObjectLocation().

Referenced by enter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIFO()

const Aurora::IFOFile & Engines::Witcher::Module::getIFO ( ) const

Return the IFO of the currently loaded module.

Definition at line 488 of file module.cpp.

References _ifo.

Referenced by Engines::Witcher::Console::cmdGotoArea(), Engines::Witcher::Console::cmdListAreas(), and Engines::Witcher::Console::updateAreas().

Here is the caller graph for this function:

◆ getName() [1/2]

const Aurora::LocString & Engines::Witcher::Module::getName ( ) const

Return the module's name.

Definition at line 492 of file module.cpp.

References Engines::Witcher::Object::getName().

Referenced by Engines::Witcher::Console::cmdListModules().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getName() [2/2]

Common::UString Engines::Witcher::Module::getName ( const Common::UString & module )

static

Definition at line 521 of file module.cpp.

References findModule(), Aurora::Archive::findResource(), Aurora::ERFFile::getResource(), Aurora::GFF3Struct::getString(), Aurora::GFF3File::getTopLevel(), Aurora::kFileTypeIFO, and MKTAG.

Here is the call graph for this function:

◆ getObjectLocation()

bool Engines::Witcher::Module::getObjectLocation	(	const Common::UString &	object,
		Common::UString &	area,
		float &	x,
		float &	y,
		float &	z,
		float &	angle
	)

private

Definition at line 213 of file module.cpp.

References Aurora::NWScript::ObjectContainer::findObjectsByTag(), Aurora::NWScript::ObjectSearch::get(), Engines::Witcher::Object::getArea(), Engines::Witcher::Object::getPosition(), Engines::Witcher::Area::getResRef(), Engines::Witcher::Object::getType(), Engines::Witcher::kObjectTypeWaypoint, Aurora::NWScript::ObjectSearch::next(), and Engines::Witcher::ObjectContainer::toObject().

Referenced by getEntryObjectLocation(), and movePC().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPC()

Creature * Engines::Witcher::Module::getPC ( )

Return the currently playing PC.

Definition at line 79 of file module.cpp.

References _pc.

Referenced by Engines::Witcher::Area::click(), Engines::Witcher::Functions::getFirstPC(), and Engines::Witcher::Functions::jumpTo().

Here is the caller graph for this function:

◆ handleActions()

void Engines::Witcher::Module::handleActions ( )

private

Definition at line 336 of file module.cpp.

References _delayedActions, EventMan, kActionScript, and Engines::Witcher::ScriptContainer::runScript().

Here is the call graph for this function:

◆ handleEvents()

void Engines::Witcher::Module::handleEvents ( )

private

Definition at line 327 of file module.cpp.

References _currentArea, _eventQueue, Engines::Witcher::Area::addEvent(), and Engines::Witcher::Area::processEventQueue().

Referenced by processEventQueue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLoaded()

bool Engines::Witcher::Module::isLoaded ( ) const

Is a module currently loaded and ready to run?

Definition at line 83 of file module.cpp.

References _hasModule.

Referenced by enter().

Here is the caller graph for this function:

◆ isRunning()

bool Engines::Witcher::Module::isRunning ( ) const

Is a module currently running?

Definition at line 87 of file module.cpp.

References _exit, _newArea, _running, Common::UString::empty(), and EventMan.

Referenced by load(), and processEventQueue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ leave()

void Engines::Witcher::Module::leave ( )

virtual

Leave the running module, quitting it.

Reimplemented from Engines::Witcher::Object.

Definition at line 261 of file module.cpp.

References _exit, _pc, _running, Engines::Witcher::kScriptExit, and Engines::Witcher::ScriptContainer::runScript().

Here is the call graph for this function:

◆ load()

void Engines::Witcher::Module::load	(	const Common::UString &	module,
		const Common::UString &	entryLocation = `""`
	)

Load a module.

Definition at line 91 of file module.cpp.

References changeModule(), isRunning(), and loadModule().

Referenced by movePC(), and Engines::Witcher::Functions::startNewModule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadAreas()

void Engines::Witcher::Module::loadAreas ( )

private

Load the areas.

Definition at line 379 of file module.cpp.

References _areas, _ifo, Common::StackException::add(), Aurora::IFOFile::getAreas(), and status().

Referenced by enter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadModule()

void Engines::Witcher::Module::loadModule	(	const Common::UString &	module,
		const Common::UString &	entryLocation
	)

private

Load the actual module.

Definition at line 103 of file module.cpp.

References _entryLocation, _hasModule, _ifo, _module, Engines::Witcher::Object::_name, _newModule, _resModule, Aurora::NWScript::Object::_tag, Common::StackException::add(), Common::UString::c_str(), Common::UString::clear(), Common::UString::empty(), Aurora::IFOFile::getGFF(), Aurora::IFOFile::getName(), Aurora::IFOFile::getTag(), Engines::indexMandatoryArchive(), Aurora::IFOFile::isSave(), Aurora::IFOFile::load(), Engines::Witcher::ScriptContainer::readScripts(), and unload().

Referenced by load(), and replaceModule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ movedPC()

void Engines::Witcher::Module::movedPC ( )

Notify the module that the PC was moved.

Definition at line 472 of file module.cpp.

References _newArea, _pc, CameraMan, Common::UString::clear(), Engines::Witcher::Object::getArea(), Engines::Witcher::Object::getPosition(), and Engines::Witcher::Area::getResRef().

Referenced by Engines::Witcher::Functions::jumpTo(), and movePC().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ movePC() [1/5]

void Engines::Witcher::Module::movePC ( const Common::UString & area )

Move the player character to this area.

Definition at line 418 of file module.cpp.

References _pc, and Engines::Witcher::Object::getPosition().

Referenced by Engines::Witcher::Door::click(), Engines::Witcher::Console::cmdGotoArea(), Engines::Witcher::Console::cmdMove(), and movePC().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ movePC() [2/5]

void Engines::Witcher::Module::movePC	(	float	x,
		float	y,
		float	z
	)

Move the player character to this position within the current area.

Definition at line 428 of file module.cpp.

References _currentArea, _pc, and movePC().

Here is the call graph for this function:

◆ movePC() [3/5]

void Engines::Witcher::Module::movePC	(	const Common::UString &	area,
		float	x,
		float	y,
		float	z
	)

Move the player character to this position within this area.

Definition at line 435 of file module.cpp.

References _areas, _pc, and movePC().

Here is the call graph for this function:

◆ movePC() [4/5]

void Engines::Witcher::Module::movePC	(	Area *	area,
		float	x,
		float	y,
		float	z
	)

Move the player character to this position within this area.

Definition at line 448 of file module.cpp.

References _pc, movedPC(), Engines::Witcher::Object::setArea(), and Engines::Witcher::Object::setPosition().

Here is the call graph for this function:

◆ movePC() [5/5]

void Engines::Witcher::Module::movePC	(	const Common::UString &	module,
		const Common::UString &	object
	)

Move the player character to this object within this area.

Definition at line 458 of file module.cpp.

References _module, Common::UString::empty(), getObjectLocation(), load(), and movePC().

Here is the call graph for this function:

◆ processEventQueue()

void Engines::Witcher::Module::processEventQueue ( )

Process the current event queue.

Definition at line 272 of file module.cpp.

References enterArea(), handleEvents(), isRunning(), and replaceModule().

Here is the call graph for this function:

◆ refreshLocalized()

void Engines::Witcher::Module::refreshLocalized ( )

virtual

Refresh all localized strings.

Reimplemented from Engines::Witcher::Object.

Definition at line 500 of file module.cpp.

References _areas.

◆ replaceModule()

void Engines::Witcher::Module::replaceModule ( )

private

Actually replace the currently running module.

Definition at line 140 of file module.cpp.

References _console, _entryLocation, _exit, _newModule, _pc, Common::UString::empty(), Engines::Witcher::Object::enter(), Engines::Console::hide(), loadModule(), and unload().

Referenced by processEventQueue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unload()

void Engines::Witcher::Module::unload ( )

private

Unload the whole shebang.

Definition at line 353 of file module.cpp.

References unloadAreas(), unloadModule(), and unloadPC().

Referenced by clear(), loadModule(), and replaceModule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unloadAreas()

void Engines::Witcher::Module::unloadAreas ( )

private

Unload the areas.

Definition at line 401 of file module.cpp.

References _areas, _currentArea, _newArea, Common::PtrMap< Key, T, Compare, Deallocator >::clear(), and Common::UString::clear().

Referenced by unload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unloadModule()

void Engines::Witcher::Module::unloadModule ( )

private

Unload the module.

Definition at line 359 of file module.cpp.

References _delayedActions, _entryLocation, _eventQueue, _exit, _hasModule, _ifo, _module, _newModule, _resModule, _running, Aurora::NWScript::Object::_tag, Common::UString::clear(), Engines::deindexResources(), and Aurora::IFOFile::unload().

Referenced by unload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unloadPC()

void Engines::Witcher::Module::unloadPC ( )

private

Unload the PC.

Definition at line 408 of file module.cpp.

References _pc, Engines::Witcher::Object::hide(), and Engines::Witcher::ObjectContainer::removeObject().

Referenced by unload().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ _areas

AreaMap Engines::Witcher::Module::_areas

private

The areas in the current module.

Definition at line 175 of file module.h.

Referenced by enterArea(), loadAreas(), movePC(), refreshLocalized(), and unloadAreas().

◆ _console

::Engines::Console* Engines::Witcher::Module::_console

private

Definition at line 161 of file module.h.

Referenced by enter(), enterArea(), and replaceModule().

◆ _currentArea

Area* Engines::Witcher::Module::_currentArea

private

The current area.

Definition at line 177 of file module.h.

Referenced by enterArea(), getCurrentArea(), handleEvents(), movePC(), and unloadAreas().

◆ _delayedActions

ActionQueue Engines::Witcher::Module::_delayedActions

private

Definition at line 186 of file module.h.

Referenced by delayScript(), handleActions(), and unloadModule().

◆ _entryLocation

Common::UString Engines::Witcher::Module::_entryLocation

private

The tag of the object in the start location for this module.

Definition at line 183 of file module.h.

Referenced by changeModule(), getEntryObjectLocation(), loadModule(), replaceModule(), and unloadModule().

◆ _eventQueue

EventQueue Engines::Witcher::Module::_eventQueue

private

Definition at line 185 of file module.h.

Referenced by addEvent(), handleEvents(), and unloadModule().

◆ _exit

bool Engines::Witcher::Module::_exit

private

Should we exit the module?

Definition at line 165 of file module.h.

Referenced by enter(), enterArea(), isRunning(), leave(), replaceModule(), and unloadModule().

◆ _hasModule

bool Engines::Witcher::Module::_hasModule

private

Do we have a module?

Definition at line 163 of file module.h.

Referenced by isLoaded(), loadModule(), and unloadModule().

◆ _ifo

Aurora::IFOFile Engines::Witcher::Module::_ifo

private

The module's IFO.

Definition at line 170 of file module.h.

Referenced by enter(), getEntryIFOLocation(), getIFO(), loadAreas(), loadModule(), and unloadModule().

◆ _module

Common::UString Engines::Witcher::Module::_module

private

The current module's name.

Definition at line 179 of file module.h.

Referenced by loadModule(), movePC(), and unloadModule().

◆ _newArea

Common::UString Engines::Witcher::Module::_newArea

private

The new area to enter.

Definition at line 176 of file module.h.

Referenced by enter(), enterArea(), isRunning(), movedPC(), and unloadAreas().

◆ _newModule

Common::UString Engines::Witcher::Module::_newModule

private

The module we should change to.

Definition at line 180 of file module.h.

Referenced by changeModule(), loadModule(), replaceModule(), and unloadModule().

◆ _pc

Creature* Engines::Witcher::Module::_pc

private

The player character we use.

Definition at line 173 of file module.h.

Referenced by enter(), enterArea(), getPC(), leave(), movedPC(), movePC(), replaceModule(), and unloadPC().

◆ _resModule

Common::ChangeID Engines::Witcher::Module::_resModule

private

Resources added by the module.

Definition at line 168 of file module.h.

Referenced by loadModule(), and unloadModule().

◆ _running

bool Engines::Witcher::Module::_running

private

Are we currently running a module?

Definition at line 164 of file module.h.

Referenced by enter(), isRunning(), leave(), and unloadModule().

The documentation for this class was generated from the following files:

src/engines/witcher/module.h
src/engines/witcher/module.cpp

Classes

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ActionQueue

◆ AreaMap

◆ EventQueue

Member Enumeration Documentation

◆ ActionType

Constructor & Destructor Documentation

◆ Module()

◆ ~Module()

Member Function Documentation

◆ addEvent()

◆ changeModule()

◆ clear()

◆ delayScript()

◆ enter()

◆ enterArea()

◆ exit()

◆ findModule()

◆ getCurrentArea()

◆ getDescription() [1/2]

◆ getDescription() [2/2]

◆ getEntryIFOLocation()

◆ getEntryObjectLocation()

◆ getIFO()

◆ getName() [1/2]

◆ getName() [2/2]

◆ getObjectLocation()

◆ getPC()

◆ handleActions()

◆ handleEvents()

◆ isLoaded()

◆ isRunning()

◆ leave()

◆ load()

◆ loadAreas()

◆ loadModule()

◆ movedPC()

◆ movePC() [1/5]

◆ movePC() [2/5]

◆ movePC() [3/5]

◆ movePC() [4/5]

◆ movePC() [5/5]

◆ processEventQueue()

◆ refreshLocalized()

◆ replaceModule()

◆ unload()

◆ unloadAreas()

◆ unloadModule()

◆ unloadPC()

Member Data Documentation

◆ _areas

◆ _console

◆ _currentArea

◆ _delayedActions

◆ _entryLocation

◆ _eventQueue

◆ _exit

◆ _hasModule

◆ _ifo

◆ _module

◆ _newArea

◆ _newModule

◆ _pc

◆ _resModule

◆ _running