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

#include <item.h>

Inheritance diagram for Stark::Resources::LevelItemTemplate:
Stark::Resources::ItemTemplate Stark::Resources::Item Stark::Resources::Object

Public Member Functions

 LevelItemTemplate (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void readData (Formats::XRCReadStream *stream) override
 
void onAllLoaded () override
 
BonesMeshfindBonesMesh () override
 
TextureSetfindTextureSet (uint32 textureType) override
 
AnimHierarchyfindStockAnimHierarchy () override
 
ItemTemplategetItemTemplate () const
 
- Public Member Functions inherited from Stark::Resources::ItemTemplate
 ItemTemplate (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void onEnterLocation () override
 
void saveLoadCurrent (ResourceSerializer *serializer) override
 
ItemVisualgetSceneInstance () override
 
void setAnimHierarchy (AnimHierarchy *animHierarchy) override
 
void setStockAnimHierachy (AnimHierarchy *animHierarchy)
 
void setBonesMesh (int32 index)
 
void setTexture (int32 index, uint32 textureType)
 
void setInstanciatedItem (Item *instance)
 
- Public Member Functions inherited from Stark::Resources::Item
 Item (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void onGameLoop () override
 
void saveLoad (ResourceSerializer *serializer) override
 
bool isEnabled () const
 
virtual void setEnabled (bool enabled)
 
int32 getCharacterIndex () const
 
virtual Gfx::RenderEntrygetRenderEntry (const Common::Point &positionOffset)
 
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 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
 

Protected Member Functions

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

ResourceReference _reference
 
- Protected Attributes inherited from Stark::Resources::ItemTemplate
int32 _meshIndex
 
int32 _textureNormalIndex
 
int32 _textureFaceIndex
 
int32 _animHierarchyIndex
 
Item_instanciatedItem
 
ItemTemplate_referencedItem
 
- 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
 

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
 

Detailed Description

A level item template

Level item templates are found in levels so that they can be shared between locations.

Member Function Documentation

◆ readData()

void Stark::Resources::LevelItemTemplate::readData ( Formats::XRCReadStream stream)
overridevirtual

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Item.

◆ onAllLoaded()

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

Called when the resource sub-tree is entirely loaded.

Allows to load data from other nodes.

Reimplemented from Stark::Resources::ItemTemplate.

◆ findBonesMesh()

BonesMesh* Stark::Resources::LevelItemTemplate::findBonesMesh ( )
overridevirtual

Obtain the bone mesh to use to render the item

Implements Stark::Resources::ItemTemplate.

◆ findTextureSet()

TextureSet* Stark::Resources::LevelItemTemplate::findTextureSet ( uint32  textureType)
overridevirtual

Obtain the texture to use to render the item

Implements Stark::Resources::ItemTemplate.

◆ findStockAnimHierarchy()

AnimHierarchy* Stark::Resources::LevelItemTemplate::findStockAnimHierarchy ( )
overridevirtual

Obtain the animation hierarchy to fetch animations from

Implements Stark::Resources::ItemTemplate.

◆ getItemTemplate()

ItemTemplate* Stark::Resources::LevelItemTemplate::getItemTemplate ( ) const

Get the item's level or global template if any


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