ScummVM API documentation
Hollywood::AnimationFrameEvent Struct Reference

#include <animation_events.h>

Public Types

enum  Type {
  kFramebufferPatch , kResourcePatch , kSound , kLoopingSound ,
  kResidentSound , kStopSound , kSecondarySpeech , kPrimarySpeech ,
  kActorPath , kLayerFrame , kLayerFrameMap , kLayerReset ,
  kLayerVisibility , kStateCommit , kInvalidatePalette , kFadeFromBlack ,
  kCustomHook
}
 
enum  { kMainSoundSlot = 0xff }
 
typedef void(* CommitFunction) (void *target, uint32 value)
 

Public Member Functions

 AnimationFrameEvent (int newFrame, Type newType)
 
bool matches (uint currentFrame) const
 

Public Attributes

int frame
 
bool everyFrame
 
Type type
 
byte selector
 
uint resourceChunk
 
uint16 soundId
 
byte soundVolumePercent
 
byte soundSlot
 
uint16 speechRow
 
byte speechFrame
 
byte speechId
 
uint16 speechCenterX
 
uint16 speechTopY
 
byte speechRed
 
byte speechGreen
 
byte speechBlue
 
int actorX
 
int actorY
 
byte actorFacing
 
byte actorCel
 
uint32 actorPathFrameMillis
 
uint layerId
 
byte layerFrame
 
const byte * layerFrameMap
 
uint layerFrameMapSize
 
int layerFrameMapFirstFrame
 
bool showMappedLayer
 
bool layerVisible
 
void * commitTarget
 
uint32 commitValue
 
CommitFunction commitFunction
 
byte hookId
 

Detailed Description

Describes one action dispatched after an animation installs a frame.

Actions run in insertion order. Referenced maps and commit targets must remain valid throughout synchronous playback.


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