ScummVM API documentation
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Stark::Resources::PATTable Class Reference
Inheritance diagram for Stark::Resources::PATTable:
Stark::Resources::Object

Classes

struct  Entry
 

Public Types

enum  ActionType { kActionUse = 1, kActionLook = 2, kActionTalk = 3, kActionExit = 7 }
 

Public Member Functions

 PATTable (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void readData (Formats::XRCReadStream *stream) override
 
void onAllLoaded () override
 
void onEnterLocation () override
 
void saveLoad (ResourceSerializer *serializer) override
 
ActionArray listPossibleActions () const
 
bool runScriptForAction (uint32 action)
 
bool canPerformAction (uint32 action) const
 
int32 getDefaultAction () const
 
void setTooltip (String *string)
 
- Public Member Functions inherited from Stark::Resources::Object
Type getType () const
 
byte getSubType () const
 
uint16 getIndex () const
 
Common::String getIndexAsString () const
 
Common::String getName () const
 
virtual void saveLoadCurrent (ResourceSerializer *serializer)
 
virtual void onPostRead ()
 
virtual void onGameLoop ()
 
virtual void onEnginePause (bool pause)
 
virtual void onExitLocation ()
 
virtual void onPreDestroy ()
 
template<class T >
T * findParent ()
 
Object * findChildWithIndex (Type type, uint16 index, int subType=-1) const
 
Object * findChildWithOrder (Type type, uint16 order, int subType=-1) const
 
Object * findChildWithName (Type type, const Common::String &name, int subType=-1) const
 
template<class T >
T * findChild (bool mustBeUnique=true) const
 
template<class T >
T * findChildWithSubtype (int subType, bool mustBeUnique=true) const
 
template<class T >
T * findChildWithIndex (uint16 index, int subType=-1) const
 
template<class T >
T * findChildWithOrder (uint16 order, int subType=-1) const
 
template<class T >
T * findChildWithName (const Common::String &name, int subType=-1) const
 
template<class T >
Common::Array< T * > listChildren (int subType=-1) const
 
template<class T >
Common::Array< T * > listChildrenRecursive (int subType=-1)
 
void addChild (Object *child)
 
virtual void print (uint depth=0)
 
template<>
Object * cast (Object *resource)
 
template<>
Object * findParent ()
 
template<>
Common::Array< Object * > listChildren (int subType) const
 

Static Public Attributes

static const Type::ResourceType TYPE = Type::kPATTable
 

Protected Types

typedef Common::HashMap< uint32, Entry > EntryMap
 

Protected Member Functions

void addOwnEntriesToItemEntries ()
 
Common::Array< Entry > listItemEntries () const
 
ItemTemplate * findItemTemplate ()
 
void printData () override
 
- Protected Member Functions inherited from Stark::Resources::Object
 Object (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void printWithDepth (uint depth, const Common::String &string) const
 
void printDescription (uint depth) const
 

Protected Attributes

Common::Array< Entry > _ownEntries
 
EntryMap _itemEntries
 
int32 _defaultAction
 
int32 _tooltipOverrideIndex
 
- Protected Attributes inherited from Stark::Resources::Object
Type _type
 
byte _subType
 
uint16 _index
 
Common::String _name
 
Object * _parent
 
Common::Array< Object * > _children
 

Additional Inherited Members

- Static Public Member Functions inherited from Stark::Resources::Object
template<class T >
static T * cast (Object *resource)
 

Member Function Documentation

◆ readData()

void Stark::Resources::PATTable::readData ( Formats::XRCReadStream *  stream)
overridevirtual

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Object.

◆ onAllLoaded()

void Stark::Resources::PATTable::onAllLoaded ( )
overridevirtual

Called when the resource sub-tree is entirely loaded.

Allows to load data from other nodes.

Reimplemented from Stark::Resources::Object.

◆ onEnterLocation()

void Stark::Resources::PATTable::onEnterLocation ( )
overridevirtual

Called when entering a location

Reimplemented from Stark::Resources::Object.

◆ saveLoad()

void Stark::Resources::PATTable::saveLoad ( ResourceSerializer *  serializer)
overridevirtual

Persist / restore the resource state

Reimplemented from Stark::Resources::Object.

◆ getDefaultAction()

int32 Stark::Resources::PATTable::getDefaultAction ( ) const

If a default action is available, only it can be executed

◆ setTooltip()

void Stark::Resources::PATTable::setTooltip ( String *  string)

Replace the PAT tooltip with the name of a string resource

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