ScummVM API documentation
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Stark::Resources::AnimScript Class Reference

#include <animscript.h>

Inheritance diagram for Stark::Resources::AnimScript:
Stark::Resources::Object

Public Member Functions

 AnimScript (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void onAllLoaded () override
 
void onGameLoop () override
 
void saveLoad (ResourceSerializer *serializer) override
 
void goToScriptItem (AnimScriptItem *item)
 
bool hasReached (AnimScriptItem *item)
 
bool isDone () const
 
- 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 readData (Formats::XRCReadStream *stream)
 
virtual void saveLoadCurrent (ResourceSerializer *serializer)
 
virtual void onPostRead ()
 
virtual void onEnterLocation ()
 
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::kAnimScript
 

Protected Member Functions

void goToNextItem ()
 
int32 findItemIndex (AnimScriptItem *item)
 
- 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
 
virtual void printData ()
 

Protected Attributes

Anim * _anim
 
Common::Array< AnimScriptItem * > _items
 
int32 _nextItemIndex
 
int32 _msecsToNextUpdate
 
bool _done
 
- 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)
 

Detailed Description

Animation scripts control the currently displayed frame for images animation resources.

Animation scripts contain animation script items defining which frames should be displayed and when.

Animation scripts also allow to play sounds.

Member Function Documentation

◆ onAllLoaded()

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

Called when the resource sub-tree is entirely loaded.

Allows to load data from other nodes.

Reimplemented from Stark::Resources::Object.

◆ onGameLoop()

void Stark::Resources::AnimScript::onGameLoop ( )
overridevirtual

Called once per game loop

Reimplemented from Stark::Resources::Object.

◆ saveLoad()

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

Persist / restore the resource state

Reimplemented from Stark::Resources::Object.

◆ goToScriptItem()

void Stark::Resources::AnimScript::goToScriptItem ( AnimScriptItem *  item)

Go to a script item. Cancel any delay so that it is shown immediately.

◆ hasReached()

bool Stark::Resources::AnimScript::hasReached ( AnimScriptItem *  item)

Is the current script item later in the script when compared to the specified one?

◆ isDone()

bool Stark::Resources::AnimScript::isDone ( ) const

Has the script completed playing the last script item at least once since started?

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