ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Stark::Resources::AnimSoundTrigger Class Reference

An AnimSoundTrigger plays a sound when a certain time of an animation is reached. More...

#include <animsoundtrigger.h>

Inheritance diagram for Stark::Resources::AnimSoundTrigger:
Collaboration diagram for Stark::Resources::AnimSoundTrigger:

List of all members.

Public Types

enum  SubType { kAnimTriggerSound = 1 }

Public Member Functions

 AnimSoundTrigger (Object *parent, byte subType, uint16 index, const Common::String &name)
virtual ~AnimSoundTrigger ()
void readData (Formats::XRCReadStream *stream) override
 Deserialize the resource static data and initial state.
void printData () override
void onAllLoaded () override
 Called when the resource sub-tree is entirely loaded.
void onGameLoop () override
 Called once per game loop.

Static Public Attributes

static const Type::ResourceType TYPE = Type::kAnimSoundTrigger

Private Attributes

uint32 _soundStockType
uint32 _soundTriggerTime
AnimSkeleton_anim
bool _alreadyPlayed
uint _timeRemainingBeforeLoop

Detailed Description

An AnimSoundTrigger plays a sound when a certain time of an animation is reached.

The sound is played at most once per animation loop.

Definition at line 45 of file animsoundtrigger.h.


Member Enumeration Documentation

Enumerator:
kAnimTriggerSound 

Definition at line 49 of file animsoundtrigger.h.


Constructor & Destructor Documentation

Stark::Resources::AnimSoundTrigger::AnimSoundTrigger ( Object parent,
byte  subType,
uint16  index,
const Common::String name 
)

Definition at line 38 of file animsoundtrigger.cpp.

Stark::Resources::AnimSoundTrigger::~AnimSoundTrigger (  )  [virtual]

Definition at line 35 of file animsoundtrigger.cpp.


Member Function Documentation

void Stark::Resources::AnimSoundTrigger::onAllLoaded (  )  [override, virtual]

Called when the resource sub-tree is entirely loaded.

Allows to load data from other nodes.

Reimplemented from Stark::Resources::Object.

Definition at line 48 of file animsoundtrigger.cpp.

void Stark::Resources::AnimSoundTrigger::onGameLoop (  )  [override, virtual]

Called once per game loop.

Reimplemented from Stark::Resources::Object.

Definition at line 53 of file animsoundtrigger.cpp.

void Stark::Resources::AnimSoundTrigger::printData (  )  [override, virtual]

Reimplemented from Stark::Resources::Object.

Definition at line 96 of file animsoundtrigger.cpp.

void Stark::Resources::AnimSoundTrigger::readData ( Formats::XRCReadStream stream  )  [override, virtual]

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Object.

Definition at line 91 of file animsoundtrigger.cpp.


Member Data Documentation

Definition at line 67 of file animsoundtrigger.h.

const Type::ResourceType Stark::Resources::AnimSoundTrigger::TYPE = Type::kAnimSoundTrigger [static]

Definition at line 47 of file animsoundtrigger.h.


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


Generated on Sat Jan 12 2019 05:05:18 for ResidualVM by doxygen 1.7.1
curved edge   curved edge