Myst3::Database Class Reference

Public Member Functions
	Database (const Common::Platform platform, const Common::Language language, const uint32 localizationType)
void	cacheRoom (uint32 roomID, uint32 ageID)
bool	isCommonRoom (uint32 roomID, uint32 ageID) const
NodePtr	getNodeData (uint16 nodeID, uint32 roomID, uint32 ageID)
int32	getNodeZipBitIndex (uint16 nodeID, uint32 roomID, uint32 ageID)
const Common::Array< Opcode > &	getNodeInitScript ()
Common::String	getRoomName (uint32 roomID, uint32 ageID) const
RoomKey	getRoomKey (const char *name)
Common::Array< uint16 >	listRoomNodes (uint32 roomID, uint32 ageID)
uint32	getAgeLabelId (uint32 ageID)
Common::String	getSoundName (uint32 id)
uint32	getSoundIdMin () const
uint32	getSoundIdMax () const
const AmbientCue &	getAmbientCue (uint16 id)
int16	getGameLanguageCode () const
bool	areRoomsScriptsEqual (uint32 roomID1, uint32 ageID1, uint32 roomID2, uint32 ageID2, ScriptType scriptType)

Member Function Documentation

cacheRoom()

void Myst3::Database::cacheRoom	(	uint32	roomID,
		uint32	ageID
	)

Loads a room's nodes into the database cache

isCommonRoom()

bool Myst3::Database::isCommonRoom	(	uint32	roomID,
		uint32	ageID
	)		const

Tells if a room is a common room

Common rooms are always in the cache

getNodeData()

NodePtr Myst3::Database::getNodeData	(	uint16	nodeID,
		uint32	roomID,
		uint32	ageID
	)

Returns a node's hotspots and scripts from the currently loaded room

getNodeZipBitIndex()

int32 Myst3::Database::getNodeZipBitIndex	(	uint16	nodeID,
		uint32	roomID,
		uint32	ageID
	)

Returns a node's zip id, as used by savestates

getNodeInitScript()

const Common::Array<Opcode>& Myst3::Database::getNodeInitScript ( )

inline

Returns the generic node init script

getRoomName()

Common::String Myst3::Database::getRoomName	(	uint32	roomID,
		uint32	ageID
	)		const

Returns the name of the currently loaded room

getRoomKey()

RoomKey Myst3::Database::getRoomKey

(

const char *

name

)

Returns the id of a room from its name

listRoomNodes()

Common::Array<uint16> Myst3::Database::listRoomNodes	(	uint32	roomID,
		uint32	ageID
	)

Returns the list of the nodes of a room

getAgeLabelId()

uint32 Myst3::Database::getAgeLabelId

(

uint32

ageID

)

Returns an age's label id, to be used with AGES 1000 metadata

getSoundName()

Common::String Myst3::Database::getSoundName

(

uint32

id

)

Retrieve the file name of a sound from its id

getSoundIdMin()

uint32 Myst3::Database::getSoundIdMin ( ) const

inline

Get the sound variable id range

getAmbientCue()

const AmbientCue& Myst3::Database::getAmbientCue

(

uint16

id

)

Retrieve an ambient cue from its id

areRoomsScriptsEqual()

bool Myst3::Database::areRoomsScriptsEqual	(	uint32	roomID1,
		uint32	ageID1,
		uint32	roomID2,
		uint32	ageID2,
		ScriptType	scriptType
	)

Check if the scripts for two rooms are identical

---

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

• engines/myst3/database.h