ScummVM API documentation
Stark::Resources::InventoryItem Class Reference

#include <item.h>

Inheritance diagram for Stark::Resources::InventoryItem:
Stark::Resources::ItemVisual Stark::Resources::Item Stark::Resources::Object

Public Member Functions

 InventoryItem (Object *parent, byte subType, uint16 index, const Common::String &name)
 
Gfx::RenderEntrygetRenderEntry (const Common::Point &positionOffset) override
 
void setEnabled (bool enabled) override
 
VisualgetActionVisual (bool active) const
 
VisualgetCursorVisual () const
 
- Public Member Functions inherited from Stark::Resources::ItemVisual
 ItemVisual (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void readData (Formats::XRCReadStream *stream) override
 
void onAllLoaded () override
 
void saveLoad (ResourceSerializer *serializer) override
 
void saveLoadCurrent (ResourceSerializer *serializer) override
 
ItemVisualgetSceneInstance () override
 
void setAnimHierarchy (AnimHierarchy *animHierarchy) override
 
virtual void setPosition2D (const Common::Point &position)
 
int getHotspotIndexForPoint (const Common::Point &point)
 
Common::String getHotspotTitle (uint32 hotspotIndex)
 
bool canPerformAction (uint32 action, uint32 hotspotIndex)
 
bool doAction (uint32 action, uint32 hotspotIndex)
 
void setAnimActivity (int32 activity)
 
int32 getAnimActivity () const
 
AnimgetAnim () const
 
AnimgetActionAnim () const
 
void playActionAnim (Anim *anim)
 
void resetActionAnim ()
 
- Public Member Functions inherited from Stark::Resources::Item
 Item (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void onGameLoop () override
 
bool isEnabled () const
 
int32 getCharacterIndex () const
 
void setMovement (Movement *movement)
 
MovementgetMovement () const
 
void setMovementSuspendedScript (Script *script)
 
virtual Common::Array< Common::PointlistExitPositions ()
 
- 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 onPostRead ()
 
virtual void onEnterLocation ()
 
virtual void onEnginePause (bool pause)
 
virtual void onExitLocation ()
 
virtual void onPreDestroy ()
 
template<class T >
T * findParent ()
 
ObjectfindChildWithIndex (Type type, uint16 index, int subType=-1) const
 
ObjectfindChildWithOrder (Type type, uint16 order, int subType=-1) const
 
ObjectfindChildWithName (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<>
Objectcast (Object *resource)
 
template<>
ObjectfindParent ()
 
template<>
Common::Array< Object * > listChildren (int subType) const
 

Additional Inherited Members

- Public Types inherited from Stark::Resources::Item
enum  SubType {
  kItemGlobalTemplate = 1, kItemInventory = 2, kItemLevelTemplate = 3, kItemStaticProp = 5,
  kItemAnimatedProp = 6, kItemBackgroundElement = 7, kItemBackground = 8, kItemModel = 10
}
 
- Static Public Member Functions inherited from Stark::Resources::Item
static Objectconstruct (Object *parent, byte subType, uint16 index, const Common::String &name)
 
- Static Public Member Functions inherited from Stark::Resources::Object
template<class T >
static T * cast (Object *resource)
 
- Static Public Attributes inherited from Stark::Resources::Item
static const Type::ResourceType TYPE = Type::kItem
 
- Protected Member Functions inherited from Stark::Resources::ItemVisual
void printData () override
 
Common::Array< Common::PointlistExitPositionsImpl ()
 
VisualgetVisual ()
 
- 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 inherited from Stark::Resources::ItemVisual
Gfx::RenderEntry_renderEntry
 
Anim_actionAnim
 
AnimHierarchy_animHierarchy
 
int32 _currentAnimActivity
 
bool _clickable
 
- Protected Attributes inherited from Stark::Resources::Item
bool _enabled
 
int32 _characterIndex
 
Movement_movement
 
Script_movementSuspendedScript
 
- Protected Attributes inherited from Stark::Resources::Object
Type _type
 
byte _subType
 
uint16 _index
 
Common::String _name
 
Object_parent
 
Common::Array< Object * > _children
 

Detailed Description

An inventory item

Member Function Documentation

◆ getRenderEntry()

Gfx::RenderEntry* Stark::Resources::InventoryItem::getRenderEntry ( const Common::Point positionOffset)
overridevirtual

Obtain the render entry to use to display the item

Reimplemented from Stark::Resources::Item.

◆ setEnabled()

void Stark::Resources::InventoryItem::setEnabled ( bool  enabled)
overridevirtual

Enable or disable the item

Reimplemented from Stark::Resources::ItemVisual.

◆ getActionVisual()

Visual* Stark::Resources::InventoryItem::getActionVisual ( bool  active) const

Obtain an action menu icon

◆ getCursorVisual()

Visual* Stark::Resources::InventoryItem::getCursorVisual ( ) const

Obtain an inventory item cursor


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