ScummVM API documentation
Hollywood::ActionOverlaySpec Struct Reference

#include <action_overlay.h>

Inheritance diagram for Hollywood::ActionOverlaySpec:
Hollywood::AnimationEventSpec< ActionOverlaySpec >

Public Member Functions

 ActionOverlaySpec (uint newChunkIndex, uint newDescriptorCount, uint32 newFrameMillis)
 
 ActionOverlaySpec (uint newChunkIndex, uint newDescriptorCount, const byte *newFrameMap, uint newFrameMapSize, uint32 newFrameMillis)
 
ActionOverlaySpec & holdFirstFrame ()
 
ActionOverlaySpec & holdFrame (int frame)
 
ActionOverlaySpec & bookendWithLastFrame ()
 
ActionOverlaySpec & returnToFirstFrame ()
 
ActionOverlaySpec & reverse ()
 
ActionOverlaySpec & drawAt (SceneAnimationStratum stratum)
 
ActionOverlaySpec & restoreBaseBackground ()
 
ActionOverlaySpec & noFinalFrameDelay ()
 
ActionOverlaySpec & unskippable ()
 
ActionOverlaySpec & startAt (uint firstFrame)
 
ActionOverlaySpec & endAt (uint endFrame)
 
ActionOverlaySpec & frameRange (uint firstFrame, uint endFrame)
 
uint playbackFrameCount () const
 
uint targetFrame (uint playbackFrame) const
 
- Public Member Functions inherited from Hollywood::AnimationEventSpec< ActionOverlaySpec >
ActionOverlaySpec & patchAt (int frame, byte selector)
 
ActionOverlaySpec & resourcePatchAt (int frame, uint resourceChunkIndex)
 
ActionOverlaySpec & soundAt (int frame, uint16 soundId, byte volumePercent=100, byte slotIndex=AnimationFrameEvent::kMainSoundSlot)
 
ActionOverlaySpec & loopingSoundAt (int frame, uint16 soundId, byte volumePercent=100, byte slotIndex=AnimationFrameEvent::kMainSoundSlot)
 
ActionOverlaySpec & stopSoundAt (int frame)
 
ActionOverlaySpec & ambientSoundAt (int frame, uint16 soundId, byte volumePercent=100, byte slotIndex=0)
 
ActionOverlaySpec & loopingAmbientSoundAt (int frame, uint16 soundId, byte volumePercent=100, byte slotIndex=0)
 
ActionOverlaySpec & residentSoundAt (int frame, byte soundId, byte volumePercent=100)
 
ActionOverlaySpec & secondarySpeechAt (int frame, uint16 rowIndex, byte frameIndex, byte speechId=0)
 
ActionOverlaySpec & primarySpeechAt (int frame, uint16 rowIndex, byte frameIndex, uint16 centerX, uint16 topY, byte red, byte green, byte blue)
 
ActionOverlaySpec & actorPathAt (int frame, int targetX, int targetY, byte finalFacing, byte finalCel, uint32 frameMillis)
 
ActionOverlaySpec & layerFrameAt (int frame, uint layerId, byte layerFrame)
 
ActionOverlaySpec & mappedLayerFrames (uint layerId, const byte *mappedFrames, uint mappedFrameCount, int firstPlaybackFrame=0)
 
ActionOverlaySpec & visibleMappedLayerFrames (uint layerId, const byte *mappedFrames, uint mappedFrameCount, int firstPlaybackFrame=0)
 
ActionOverlaySpec & layerVisibleAt (int frame, uint layerId, bool visible)
 
ActionOverlaySpec & layerResetAt (int frame, uint layerId, byte layerFrame)
 
ActionOverlaySpec & commitAt (int frame, T &target, const V &value)
 
ActionOverlaySpec & invalidatePaletteAt (int frame)
 
ActionOverlaySpec & fadeFromBlackAt (int frame)
 
ActionOverlaySpec & hookAt (int frame, byte hookId)
 
ActionOverlaySpec & hookEveryFrame (byte hookId)
 

Public Attributes

uint chunkIndex
 
uint descriptorCount
 
const byte * frameMap
 
uint frameMapSize
 
uint32 frameMillis
 
int heldFrame
 
bool bookendLastFrame
 
bool appendFirstFrame
 
bool reversePlayback
 
bool hasDrawStratum
 
SceneAnimationStratum drawStratum
 
bool restoreBackgroundBeforeDraw
 
ActionOverlayOptions options
 
- Public Attributes inherited from Hollywood::AnimationEventSpec< ActionOverlaySpec >
Common::Array< AnimationFrameEvent > _events
 

Detailed Description

Describes an overlay that PlayableScene plays synchronously.

Playback blocks its caller while scene events, animation, and drawing continue between frames. The clamped frame range is [firstFrame, endFrame), with zero endFrame meaning the end of the playback sequence. Frame events run in declaration order after their frame is installed. Frames normally hold for frameMillis, including the last; noFinalFrameDelay() makes the terminal frame an immediate handoff. The terminal frame remains presented until the caller's next draw, so state and scene transitions cannot expose an intermediate composite. unskippable() reserves input for the scene while a state-changing sequence runs. The playback entry point controls actor visibility; drawAt() only changes composition order. restoreBaseBackground() clears the sprite bounds from the base framebuffer before each draw.


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