ScummVM API documentation
Hollywood::Scene4030 Class Reference
Inheritance diagram for Hollywood::Scene4030:
Hollywood::PlayableScene Hollywood::GameplayLoopDelegate Hollywood::DialogueMenuDelegate Hollywood::ActorPathControllerDelegate Hollywood::SceneAnimationPlayerDelegate

Public Member Functions

 Scene4030 (HollywoodEngine *vm)
 
- Public Member Functions inherited from Hollywood::PlayableScene
bool play ()
 
- Public Member Functions inherited from Hollywood::GameplayLoopDelegate
virtual const SceneHotspotTable & hotspots () const =0
 
virtual const Graphics::Surface & savedFramebuffer () const =0
 
virtual uint16 viewportXOffset () const =0
 
virtual uint16 viewportYOffset () const
 
virtual void prepareGameplayLoop ()
 
virtual void advanceGameplayLoop (uint32 deltaMillis)=0
 
virtual void drawGameplayFrame ()=0
 
virtual void presentGameplayFrame (const SceneHoverCaption &hoverCaption, const GameplayPanelState &panelState)=0
 
virtual void invalidatePresentationPalette ()
 
virtual void prepareOptionsMenuPalette (Common::Array< byte > &palette) const
 
virtual Common::Path optionsMenuSoundBank0ArchiveName () const
 
virtual bool optionsMenuSpeechPreviewSampleId (uint16 &sampleId) const
 
virtual void suspendAudioForOptionsMenu ()
 
virtual void refreshTranslatedText ()
 
virtual bool shouldExitGameplayLoop () const
 
virtual bool isInventoryPanelAvailable () const
 
virtual Common::String inventoryItemName (byte owner, byte itemId) const
 
virtual void beginSharedInventorySpeechLine (uint16 rowIndex, byte frameIndex)
 
virtual byte randomSharedInventorySpeechFrame (byte maxFrameIndex)
 
virtual void playSharedInventorySound (byte sampleId)
 
virtual void showTravelScreenViewer ()
 
virtual bool showInventoryMedia (InventoryMediaId mediaId)
 
virtual bool playSueTapeRecording ()
 
virtual void handleLeftClick (const GameplayLoopCursorState &state)
 
virtual void handleInventoryItemClick (const GameplayLoopCursorState &state)
 
virtual void handleRightClick (const GameplayLoopCursorState &state)
 
- Public Member Functions inherited from Hollywood::DialogueMenuDelegate
virtual Common::String dialogueMenuText (byte stageId, byte textRowId) const =0
 
virtual byte redirectDialogueMenuChoice (byte depthIndex, byte nodeIndex, byte choiceIndex) const
 
virtual void advanceDialogueMenu (uint32 deltaMillis)=0
 
virtual void drawDialogueMenuFrame ()=0
 
virtual void presentDialogueMenuFrame (const DialogueMenuState &state)=0
 
virtual byte paletteRegionAt (int x, int y) const =0
 
virtual bool customizeRouteSegment (byte currentRegion, byte nextRegion, const ActorPathBuildState &state, const ScenePoint &boundary, int &requestedFacing, bool &restoredStepDeltas)=0
 
virtual bool customizeRouteFinal (byte currentRegion, byte targetRegion, const ActorPathBuildState &state, int targetX, int targetY, int &requestedFacing, bool &restoredStepDeltas)=0
 
virtual bool animationPlaybackShouldStop () const =0
 
virtual void presentAnimationFrame ()=0
 
virtual bool waitForAnimationFrame (uint32 millis, bool allowSkip)=0
 
virtual bool consumeAnimationFastForwardRequest ()
 
virtual void handleAnimationFrameEvent (const AnimationFrameEvent &event, uint frame)
 
virtual void handleAnimationFrameHook (byte hookId, uint frame)
 

Additional Inherited Members

- Protected Types inherited from Hollywood::PlayableScene
enum  TransitionFrameMode { kIndependentTransitionFrames , kCumulativeTransitionFrames }
 
enum  {
  kPaletteMaskUsedBytes = 0x100 , kScenePaletteRegionCount = 21 , kScenePaletteRegionBoundaryCandidateCount = 3 , kScenePaletteRegionRouteStepCount = 19 ,
  kSceneRouteBoundaryPointCount = kScenePaletteRegionCount * kScenePaletteRegionCount * kScenePaletteRegionBoundaryCandidateCount , kSceneRouteStepCount = kScenePaletteRegionCount * kScenePaletteRegionCount * kScenePaletteRegionRouteStepCount , kResource000TableByteCount = 400 , kAmbientSoundSlotCount = 3 ,
  kActorFacingCount = 6 , kActorBankSegmentCount = 2 * (kActorFacingCount + 1) , kActorCelsPerFacing = 13 , kActiveActorDescriptorSize = 28 ,
  kActiveActorFacingRunStride = 160000 , kSecondaryActorDescriptorSize = 16 , kSecondaryActorFramesPerFacing = 5 , kSecondaryActorFacingRunStride = 16000 ,
  kActorPaletteFirstColor = 0xd0 , kActorPaletteColorCount = 0x19 , kActorPaletteBaseBytes = kActorPaletteColorCount * 3 , kActorPaletteAdjustmentClassCount = (kRouteBoundaryPoints - kPaletteAdjustTable) / 2 ,
  kActorPaletteBytes = 0x90 , kStage003DecodeKeySize = 0x141 , kSpeechCueDescriptorTableSize = 20000 , kStage003SmallRowSize = 0x29 ,
  kStage003LargeRowSize = 0x141 , kStage003LargeRowBaseIndex = 500 , kOriginalSpeechLineHeight = 20
}
 
- Protected Member Functions inherited from Hollywood::PlayableScene
 PlayableScene (HollywoodEngine *vm, const PlayableSceneConfig &config)
 
const char * resourceArchiveName () const
 
uint sceneInitialRequiredChunkCount () const
 
uint sceneArenaFirstChunk () const
 
uint sceneArenaLastChunk () const
 
uint sceneStageIndex () const
 
const char * sceneDebugName () const
 
uint16 sceneViewportXOffset () const
 
uint16 sceneViewportMinXOffset () const
 
uint16 sceneViewportMaxXOffset () const
 
byte inventoryOwnerIndex () const
 
void initializeInventoryOwnerState ()
 
uint resource000ActorPaletteTableEntry () const
 
uint32 inventoryActionTableExtraOffset () const
 
uint resource003InventoryRowsOffsetIndex () const
 
uint32 speechCueDescriptorTableOffset () const
 
byte walkablePaletteMaxRegion () const
 
const char * musicArchiveName () const
 
const char * soundBank0ArchiveName () const
 
bool shouldLoadInventoryActionTables () const
 
bool shouldLoadActorDepthTables () const
 
bool usesActorDepthTest () const
 
bool isMainFlowStateInScene (uint16 stateId) const
 
bool didLeaveSceneAfterLoop () const
 
virtual uint resource000ActorBankTableEntry () const
 
virtual const byte * actorPathStepDeltaTable () const
 
virtual uint actorPathStepDeltaTableSize () const
 
virtual uint framebufferResourceChunkIndex () const
 
virtual int alternatePaletteResourceChunkIndex () const
 
virtual bool isAlternatePaletteResourceActive () const
 
virtual int replacementFillRunsResourceChunkIndex () const
 
virtual int replacementPaletteMaskResourceChunkIndex () const
 
virtual bool shouldConvertSavedFramebufferFF () const
 
virtual bool shouldLoadArenaChunk (uint index) const
 
virtual void runExitSideEffectsAfterLoop ()
 
virtual bool shouldPresentPreviewBeforeEntrySequence () const
 
virtual bool shouldUseActorDepthTest (int actorWorldX, int actorWorldY) const
 
virtual void initializeCustomPreviewState ()
 
virtual void drawCustomComposite (bool drawActiveActor, byte activeFacing, byte activeCel, int activeWorldX, int activeWorldY, bool drawSecondaryActor, byte secondaryFacing, byte secondaryFrame, int secondaryWorldX, int secondaryWorldY, byte actorDrawOrderMode)
 
virtual void prepareCustomComposite (bool drawActors, byte activeFacing, int activeWorldX, int activeWorldY, byte actorDrawOrderMode)
 
virtual void drawCustomBackgroundComposite (int activeWorldX, int activeWorldY)
 
virtual void drawCustomActorForegroundComposite (int activeWorldX, int activeWorldY, byte actorDrawOrderMode)
 
virtual void drawCustomForegroundComposite (int activeWorldX, int activeWorldY)
 
virtual bool shouldDrawSecondaryActorInPlayableComposite () const
 
virtual bool shouldApplyGameplayPanelObjectPalette () const
 
virtual void runCustomEntrySequence ()
 
virtual void prepareCustomGameplayLoop ()
 
virtual void advanceCustomGameplayLoop (uint32 delta)
 
virtual void advancePrimarySpeechAnimation (uint32 delta)
 
virtual void advanceAmbientAudio (uint32 delta)
 
virtual void realtimeSpeechEnded (byte speechId, bool completed)
 
virtual bool dispatchCustomSceneAction (uint16 handlerId)
 
virtual bool shouldPlayGameplayClickPath () const
 
virtual byte customizeSceneActionFacing (uint16 handlerId, byte calculatedFacing) const
 
virtual bool adjustCustomWalkTargetToFloorMask (int &targetX, int &targetY) const
 
virtual void prepareCustomActorPathRoute (int startX, int startY)
 
bool customizeRouteSegment (byte currentRegion, byte nextRegion, const ActorPathBuildState &state, const ScenePoint &boundary, int &requestedFacing, bool &restoredStepDeltas) override
 
bool customizeRouteFinal (byte currentRegion, byte targetRegion, const ActorPathBuildState &state, int targetX, int targetY, int &requestedFacing, bool &restoredStepDeltas) override
 
virtual bool applyCustomSceneStateToHotspotsAndPatches (byte selector)
 
virtual bool shouldAnimatePrimarySpeechLine () const
 
virtual void setPrimaryLeftSpeechFrame (byte frameIndex)
 
virtual AmbientAudioProfile ambientAudioProfile () const
 
void handleAnimationFrameHook (byte hookId, uint frame) override
 
virtual void advanceTransitionAnimation (uint32 delta)
 
virtual void advanceFullscreenAnimation (uint32 delta)
 
AmbientAudioProfile createLoopingAmbientAudioProfile (byte volumePercent) const
 
AmbientAudioProfile createRandomAmbientAudioProfile (byte soundFirstCueId, byte soundCueCount, byte soundVolumePercent, byte soundProbabilityModulus, byte musicFirstCueId, byte musicCueCount, byte musicVolumePercent, byte musicProbabilityModulus) const
 
AmbientAudioProfile createMineAmbientAudioProfile (byte musicFirstCueId=0x0b, byte musicCueCount=5, byte musicProbabilityModulus=50) const
 
bool playResidentSoundEffect (byte soundEffectId, byte volumePercent=100)
 
bool playActiveActorFootstep ()
 
bool hasSavedActiveActorPoseForCurrentState () const
 
void restoreActiveActorPoseFromGameState ()
 
void syncActiveActorPoseToGameState ()
 
void setActiveActorPose (int worldX, int worldY, byte facing, byte cel=0)
 
void initializeFramebuffers ()
 
uint framebufferByteCount () const
 
byte * framebufferPixels (Graphics::ManagedSurface &surface)
 
const byte * framebufferPixels (const Graphics::ManagedSurface &surface) const
 
void copyBaseFramebufferToSceneFramebuffer ()
 
void restoreBaseFramebufferFromOriginal ()
 
bool isFramebufferOffsetValid (uint offset) const
 
byte savedFramebufferPixelAt (uint offset) const
 
bool load ()
 
bool loadResource000RuntimeTables (Common::Array< byte > &offsetTable, Common::Array< byte > &sizeTable)
 
bool loadResource000ActorBank (const Common::Array< byte > &offsetTable, const Common::Array< byte > &sizeTable)
 
bool loadResource000ActorPalette (const Common::Array< byte > &offsetTable)
 
void captureActorPaletteBase ()
 
bool loadResource000InventoryActionTables (const Common::Array< byte > &offsetTable)
 
bool loadStage003SceneRows ()
 
bool loadFixedChunk (uint index, Common::Array< byte > &destination, uint fixedSize)
 
bool loadFixedChunk (uint index, Graphics::ManagedSurface &destination, uint fixedSize)
 
bool loadVariableChunk (uint index, Common::Array< byte > &destination)
 
bool loadArenaChunk (uint index)
 
bool initializeActorDepthTables ()
 
void updateActorDepthThresholds (byte actorDrawOrderMode)
 
void expandFillRunsToSavedFramebuffer ()
 
bool initializeScenePathTables ()
 
void initializePreviewState ()
 
void initializeDefaultPreviewState ()
 
void drawPreviewComposite ()
 
void drawCutsceneComposite (bool drawActiveActor, byte activeFacing, byte activeCel, int activeWorldX, int activeWorldY, bool drawSecondaryActor, byte secondaryFacing, byte secondaryFrame, int secondaryWorldX, int secondaryWorldY, byte actorDrawOrderMode=0)
 
void drawPlayableComposite ()
 
void drawActiveAndSecondaryActorFrames (bool drawActiveActor, byte activeFacing, byte activeCel, int activeWorldX, int activeWorldY, bool drawSecondaryActor, byte secondaryFacing, byte secondaryFrame, int secondaryWorldX, int secondaryWorldY, int minimumYExclusive)
 
void drawActiveActorFrame (byte facing, byte cel, int worldX, int worldY, int minimumYExclusive)
 
void updateActorPaletteForWorldPoint (int worldX, int worldY)
 
int drawSecondaryActorFrame (byte facing, byte frame, int worldX, int worldY)
 
int drawActorRun (const Common::Array< byte > &runStreams, uint cursor, uint runBase, uint runCount, int spriteX, int spriteY, int minimumYExclusive, int actorWorldX, int actorWorldY, uint *nextCursor=nullptr)
 
int drawActorPaletteRemapRun (const Common::Array< byte > &runStreams, uint cursor, uint runBase, uint runCount, int spriteX, int spriteY, int minimumYExclusive, int actorWorldX, int actorWorldY)
 
void runEntryCutscene ()
 
void runEntryPath (int startX, int startY, byte startFacing, int targetX, int targetY)
 
bool runBasicGameplayLoop ()
 
const SceneHotspotTable & hotspots () const override
 
const Graphics::Surface & savedFramebuffer () const override
 
uint16 viewportXOffset () const override
 
uint16 viewportYOffset () const override
 
void prepareGameplayLoop () override
 
void advanceGameplayLoop (uint32 delta) override
 
void drawGameplayFrame () override
 
void presentGameplayFrame (const SceneHoverCaption &hoverCaption, const GameplayPanelState &panelState) override
 
void invalidatePresentationPalette () override
 
void prepareOptionsMenuPalette (Common::Array< byte > &palette) const override
 
Common::Path optionsMenuSoundBank0ArchiveName () const override
 
bool optionsMenuSpeechPreviewSampleId (uint16 &sampleId) const override
 
void suspendAudioForOptionsMenu () override
 
void refreshTranslatedText () override
 
bool shouldExitGameplayLoop () const override
 
Common::String inventoryItemName (byte owner, byte itemId) const override
 
void beginSharedInventorySpeechLine (uint16 rowIndex, byte frameIndex) override
 
byte randomSharedInventorySpeechFrame (byte maxFrameIndex) override
 
void playSharedInventorySound (byte sampleId) override
 
void showTravelScreenViewer () override
 
bool showInventoryMedia (InventoryMediaId mediaId) override
 
bool playSueTapeRecording () override
 
void handleLeftClick (const GameplayLoopCursorState &state) override
 
void handleInventoryItemClick (const GameplayLoopCursorState &state) override
 
void updateAmbientAudioAndMusicCues (uint32 delta)
 
void resetAmbientAudioState ()
 
void ensureAmbientSoundCuePlaying (byte slotIndex, uint16 cueId, byte volumePercent)
 
void stopAmbientSoundCues ()
 
void updateAmbientSoundCue (const AmbientAudioProfile &profile)
 
void updateAmbientMusicCue (const AmbientAudioProfile &profile)
 
void advanceSecondaryActorSpeechAnimation (uint32 delta)
 
void advanceSecondaryActorSpeechFrame ()
 
void advancePrimaryLeftSpeechFrame ()
 
void advancePrimaryDialogueSpeechFrame (uint32 delta)
 
bool startRealtimePrimarySpeechLine (uint16 rowIndex, byte frameIndex, uint16 centerX, uint16 topY, byte red, byte green, byte blue, byte animationGroup, byte speechId, byte volumePercent=0xff)
 
bool startRealtimeSecondarySpeechLine (uint16 rowIndex, byte frameIndex, byte speechId)
 
bool waitForRealtimeSpeech (bool allowSkip=true)
 
void advanceRealtimeSpeech (uint32 delta)
 
void stopRealtimeSpeech ()
 
bool isRealtimeSpeechActive () const
 
bool isRealtimeSecondarySpeechActive () const
 
byte realtimeSpeechId () const
 
void startRealtimeSpeechPart ()
 
void finishRealtimeSpeech (bool completed)
 
void processSceneActionClick (const GameplayLoopCursorState &state)
 
void processSceneRelationClick (const GameplayLoopCursorState &state, byte itemId)
 
bool gameplayActionInputBlocked () const
 
void runGameplayAction (uint16 handlerId)
 
bool dispatchGenericInventoryAction (const GameplayLoopCursorState &state)
 
void dispatchSceneAction (uint16 handlerId)
 
bool dispatchGenericSceneAction (uint16 handlerId)
 
bool walkActiveActorTo (int targetX, int targetY, byte finalFacing, byte finalCel, bool cancelOnSkip=false)
 
void startConcurrentActorPath (int targetX, int targetY, byte finalFacing, byte finalCel, uint32 frameMillis, bool snapToTargetIfNoPath=false)
 
bool startPlayerDirectedActorPath (int targetX, int targetY, byte finalFacing, byte finalCel, uint16 actionHandlerId)
 
void finishConcurrentActorPath (bool allowSkip=false)
 
void cancelConcurrentActorPath ()
 
bool concurrentActorPathActive () const
 
bool adjustWalkTargetToFloorMask (int &targetX, int &targetY) const
 
void queueActorPathWithPaletteRegionRouting (int startX, int startY, int targetX, int targetY, byte finalFacing, byte finalCel)
 
byte paletteRegionAt (int x, int y) const override
 
byte walkableMaskAt (int x, int y) const
 
void resetActorPathStepDeltas ()
 
byte calculateFacingTowardPoint (int fromX, int fromY, int toX, int toY) const
 
void applySceneStateToHotspotsAndPatches (byte selector)
 
void rebuildWalkablePaletteMask ()
 
bool unlockTravelDestination (byte destinationId)
 
void requestTravelScreenSelection (byte currentChapterId)
 
bool hasInventoryItem (byte itemId) const
 
void addInventoryItem (byte itemId)
 
void removeInventoryItem (byte itemId)
 
Common::String dialogueMenuText (byte stageId, byte textRowId) const override
 
void advanceDialogueMenu (uint32 delta) override
 
void drawDialogueMenuFrame () override
 
void presentDialogueMenuFrame (const DialogueMenuState &state) override
 
void runActorReplacement (uint chunkIndex, uint descriptorCount, const byte *frameMap, uint frameMapSize, uint32 frameMillis)
 
void runActorReplacement (const ActionOverlaySpec &spec)
 
void runSceneOverlay (uint chunkIndex, uint descriptorCount, const byte *frameMap, uint frameMapSize, uint32 frameMillis)
 
void runSceneOverlay (const ActionOverlaySpec &spec)
 
virtual byte primarySpeechAnimationBaseFrame (byte animationGroup) const
 
virtual byte primarySpeechAnimationInitialFrame (byte animationGroup, byte baseFrame) const
 
virtual byte primarySpeechAnimationFrameCount (byte animationGroup) const
 
virtual uint32 primarySpeechAnimationFrameMillis (byte animationGroup) const
 
virtual byte primarySpeechVolumePercent (byte animationGroup) const
 
virtual void setPrimarySpeechAnimationFrame (byte animationGroup, byte frameIndex)
 
virtual void primarySpeechAnimationStarted (byte animationGroup, byte baseFrame)
 
virtual void primarySpeechAnimationRestored (byte animationGroup, byte baseFrame)
 
bool waitSceneMillis (uint32 millis, bool allowSkip=true)
 
void resetViewportFromScene ()
 
void centerViewportOnActor (int actorWorldX)
 
void advanceViewportScroll (uint32 delta)
 
void clearSpeechOverlay ()
 
void clearAllSpeechOverlays ()
 
void drawSpeechOverlay ()
 
void drawMappedSpriteFrame (uint chunkIndex, uint descriptorCount, const byte *frameMap, uint frameMapSize, byte frameIndex)
 
void restoreResourceSpriteLayerBackground (const ResourceSpriteLayer &layer, const Graphics::Surface &background)
 
void drawResourceSpriteLayer (const ResourceSpriteLayer &layer)
 
void restoreSceneLayerBackground (uint layerId, const Graphics::Surface &background)
 
void drawSceneLayer (uint layerId)
 
void drawLayerStack (SceneAnimationStratum stratum)
 
void drawActionOverlayAtStratum (SceneAnimationStratum stratum)
 
void drawActionOverlayLayer ()
 
template<class FrameTarget >
bool playAnimationFrames (FrameTarget &target, const AnimationFrameRange &range)
 
template<class FrameTarget >
bool playAndPresentAnimationFrames (FrameTarget &target, const AnimationFrameRange &range)
 
bool playAnimationFrames (uint layerId, const AnimationFrameRange &range)
 
bool playAndPresentAnimationFrames (uint layerId, const AnimationFrameRange &range)
 
template<class FrameTarget >
bool playAnimationTransition (FrameTarget &target, const AnimationTransition &transition)
 
template<class FrameTarget >
bool playAndPresentAnimationTransition (FrameTarget &target, const AnimationTransition &transition)
 
bool playAnimationTransition (uint layerId, const AnimationTransition &transition)
 
bool playAndPresentAnimationTransition (uint layerId, const AnimationTransition &transition)
 
bool playResourceLayerSequence (uint layerId, uint chunkIndex, uint16 descriptorCount, const byte *frameMap, uint frameMapSize, const AnimationFrameRange &range, bool clearAtEnd=true)
 
bool playResourceLayerSequence (uint layerId, uint chunkIndex, uint16 descriptorCount, const AnimationFrameRange &range, bool clearAtEnd=true)
 
template<uint size>
bool playResourceLayerSequence (uint layerId, uint chunkIndex, uint16 descriptorCount, const byte(&frameMap)[size], const AnimationFrameRange &range, bool clearAtEnd=true)
 
void clearSceneLayer (uint layerId)
 
void drawClipFrameDeltaFromResource (const Common::Array< byte > &resource, uint32 frameTableOffset, uint32 chunkSize, uint tableEntryCount, byte frameIndex)
 
void drawClipFrameDelta (uint chunkIndex, uint tableEntryCount, byte frameIndex)
 
void playDeltaClip (uint chunkIndex, uint tableEntryCount, uint frameCount, uint32 frameMillis, uint firstFrame=0)
 
bool playTransitionFrames (TransitionFrameRenderer &renderer, byte firstFrame, byte lastFrame, uint32 frameMillis, TransitionFrameMode mode, bool allowSkip=true)
 
template<class Callback >
bool playTransitionFrames (const Callback &drawFrame, byte firstFrame, byte lastFrame, uint32 frameMillis, TransitionFrameMode mode, bool allowSkip=true)
 
bool waitDeltaClipFrameMillis (uint32 millis)
 
bool waitFullscreenAnimationFrame (uint32 millis, bool allowSkip)
 
bool playFullscreenDeltaAnimation (const Common::Array< byte > &base, const Common::Array< byte > &palette, const Common::Array< byte > &frames, uint frameCount, uint32 frameMillis)
 
bool fadePaletteFromBlack ()
 
bool fadePaletteToBlack ()
 
bool animationPlaybackShouldStop () const override
 
void presentAnimationFrame () override
 
bool waitForAnimationFrame (uint32 millis, bool allowSkip) override
 
bool consumeAnimationFastForwardRequest () override
 
void handleAnimationFrameEvent (const AnimationFrameEvent &event, uint frame) override
 
void beginSecondarySpeechLine (uint16 rowIndex, byte frameIndex)
 
bool startSecondarySpeechLine (uint16 rowIndex, byte frameIndex, bool positional=true)
 
void beginStaticSecondarySpeechLine (uint16 rowIndex, byte frameIndex)
 
void beginPrimarySpeechLine (uint16 rowIndex, byte frameIndex, uint16 centerX, uint16 topY, byte red, byte green, byte blue)
 
void beginPrimarySpeechLineWithAnimationGroup (uint16 rowIndex, byte frameIndex, uint16 centerX, uint16 topY, byte red, byte green, byte blue, byte animationGroup)
 
void beginPrimaryLeftSpeechLine (uint16 rowIndex, byte frameIndex)
 
void runSpeechLine (SpeechOverlay &overlay, uint16 rowIndex, byte frameIndex, uint16 centerX, uint16 topY, byte colorIndex, bool useRequestedTop, bool animatePrimaryLeft, bool animatePrimaryDialogue, byte primaryAnimationGroup=0xff)
 
void runSpeechCue (SpeechOverlay &overlay, uint16 textRecordId, byte continuationCount, uint16 voiceSampleId, uint16 centerX, uint16 topY, byte colorIndex, bool useRequestedTop, bool animatePrimaryLeft, bool animatePrimaryDialogue, byte primaryAnimationGroup=0xff)
 
bool getStage003Cue (uint16 rowIndex, byte frameIndex, uint16 &textRecordId, byte &continuationCount, uint16 &voiceSampleId) const
 
bool getStaticSpeechCue (uint16 rowIndex, byte frameIndex, uint16 &textRecordId, byte &continuationCount, uint16 &voiceSampleId) const
 
void wrapActorSpeechText (const Common::String &text, uint16 anchorSceneX, Common::Array< Common::String > &lines) const
 
Common::String getResource003LargeTextRecord (uint16 recordId) const
 
void calculateSpeechOverlayBounds (SpeechOverlay &overlay, int centerX, int topY, bool useRequestedTop, int actorWorldY)
 
void calculateSecondarySpeechBounds (int actorWorldX, int actorWorldY)
 
bool waitForSpeechOrDelay (uint32 fallbackMillis, bool animatePrimaryLeft)
 
bool consumeStepAdvanceRequest ()
 
bool runSueTapeSpeechLine (InventoryMediaPlayer &media, uint16 rowIndex, byte frameIndex, byte red, byte green, byte blue, byte &animationFrame, uint32 &animationMillis)
 
bool waitForFullscreenMediaDismissal ()
 
bool pollFullscreenMediaEvents (bool &dismissed)
 
void installFullscreenInventoryMedia (const InventoryMediaPlayer &media, Graphics::ManagedSurface &savedScene, Common::Array< byte > &savedPalette, uint16 &savedViewportX)
 
void restoreFullscreenInventoryMedia (const Graphics::ManagedSurface &savedScene, const Common::Array< byte > &savedPalette, uint16 savedViewportX)
 
void setPaletteEntry6Bit (byte colorIndex, byte red, byte green, byte blue)
 
byte paletteEntryComponent6Bit (byte colorIndex, uint component) const
 
void applyGameplayPanelPalette ()
 
void drawGameplayPanel (Graphics::Surface &surface, const GameplayPanelState &panelState)
 
void drawVerbPanel (Graphics::Surface &surface, const GameplayPanelState &panelState)
 
void drawInventoryPanel (Graphics::Surface &surface, const GameplayPanelState &panelState)
 
void presentFrame (const SceneHoverCaption *hoverCaption=nullptr, const GameplayPanelState *panelState=nullptr, const DialogueMenuState *dialogueMenuState=nullptr)
 
virtual bool pollEvents (bool allowSkip)
 
- Protected Attributes inherited from Hollywood::PlayableScene
HollywoodEngine * _vm
 
PlayableSceneConfig _config
 
uint16 _sceneStateId
 
SceneResources _resources
 
ResourceChunkTable & _sceneChunkTable
 
uint32(& _resourceChunkOffsets )[kResourceChunkCount]
 
Common::Array< byte > & _resourceArena
 
Common::Array< byte > & _metadata
 
SceneSurfaceState _surfaceState
 
Common::Array< byte > & _paletteResource
 
Common::Array< byte > & _paletteCurrent
 
Common::Array< byte > & _actorPaletteBase
 
Graphics::ManagedSurface & _baseFramebufferOriginal
 
Graphics::ManagedSurface & _baseFramebuffer
 
Graphics::ManagedSurface & _sceneFramebuffer
 
Graphics::ManagedSurface & _savedFramebuffer
 
Common::Array< byte > & _fillRuns
 
Common::Array< byte > & _paletteMaskOriginal
 
Common::Array< byte > & _paletteMask
 
Common::Array< byte > & _fullPaletteRegionMask
 
Common::Array< byte > & _walkablePaletteMask
 
Common::Array< byte > & _colorToActorDepthClassMap
 
Common::Array< byte > & _presentationPaletteRemapTable
 
Common::Array< uint16 > & _actorDepthYThresholds
 
Common::Array< uint16 > & _drawActorDepthYThresholds
 
Graphics::ManagedSurface & _screen
 
Palette6Bit & _displayPalette
 
Common::Array< byte > _resource000OffsetTable
 
Common::Array< byte > _resource000SizeTable
 
Common::Array< byte > _activeActorRunStreams
 
Common::Array< byte > _secondaryActorRunStreams
 
Common::Array< ActiveActorSpriteDescriptor > _activeActorDescriptors
 
Common::Array< SecondaryActorSpriteDescriptor > _secondaryActorDescriptors
 
SceneTextStore _textStore
 
Common::Array< byte > & _stage003DecodeKey
 
Common::Array< byte > & _stage003SmallRows
 
ActorPathController _pathController
 
Common::Array< ScenePoint > & _routeBoundaryPoints
 
Common::Array< byte > & _routeSteps
 
Common::Array< ActorPathFrame > & _actorPathFrames
 
Common::Array< byte > & _actorPathStepDeltas
 
GameplayPanelArt _panelArt
 
SceneHotspotTable _hotspots
 
SoundBank0Player _soundBank0
 
SoundBank0Player _ambientSoundBank0
 
SoundBank0Player _additionalAmbientSoundBank0Slots [kAmbientSoundSlotCount - 1]
 
ResidentSoundEffectPlayer _residentSoundEffects
 
Common::RandomSource _random
 
SceneLayerStack _sceneLayers
 
RealtimeAnimationTracks _realtimeAnimationTracks
 
SceneAnimationPlayer _animationPlayer
 
TimedAnimationChannel _concurrentActorPathChannel
 
SpeechController _speechController
 
SpeechPlayer _realtimeSpeechPlayer
 
SpeechPlayer & _speech
 
SpeechOverlay & _speechOverlay
 
SpeechOverlay & _primarySpeechOverlay
 
byte & _primaryLeftSpeechLastFrame
 
byte & _primaryDialogueSpeechLastFrame
 
byte & _primaryDialogueSpeechGroup
 
bool & _primaryLeftSpeechActive
 
bool & _primaryDialogueSpeechActive
 
uint32 & _secondaryActorTimerAccumulator
 
uint32 & _primaryLeftSpeechTimerAccumulator
 
uint32 & _primaryDialogueSpeechTimerAccumulator
 
byte & _secondaryActorFrame
 
uint32 _realtimeSpeechElapsed
 
uint32 _realtimeSpeechDuration
 
uint16 _realtimeSpeechTextRecordId
 
uint16 _realtimeSpeechVoiceSampleId
 
uint16 _realtimeSpeechCenterX
 
uint16 _realtimeSpeechTopY
 
byte _realtimeSpeechContinuationPart
 
byte _realtimeSpeechContinuationCount
 
byte _realtimeSpeechAnimationGroup
 
byte _realtimeSpeechId
 
byte _realtimeSpeechVolumePercent
 
bool _realtimeSpeechActive
 
bool _realtimeSpeechPrimary
 
ActionOverlayPlayer _actionOverlayPlayer
 
bool & _hideActiveActor
 
bool _inventoryItems [121]
 
byte _sceneStateFlags [8]
 
uint32 _ambientMusicTimerAccumulator
 
byte _previousAmbientMusicTrackId
 
byte _currentAmbientSoundCueId
 
byte _previousAmbientSoundCueId
 
uint16 _viewportXOffset
 
uint16 _viewportMinXOffset
 
uint16 _viewportMaxXOffset
 
int _lastViewportScrollActorWorldX
 
uint _concurrentActorPathFrameIndex
 
bool _concurrentActorPathActive
 
bool _actorPathPlaybackActive
 
bool _playerDirectedActorPathActive
 
bool _playerDirectedActorPathFootstepPlayed
 
uint16 _pendingGameplayActionHandlerId
 
int _activeActorWorldX
 
int _activeActorWorldY
 
byte _activeActorFacing
 
byte _activeActorCel
 
byte _activeActorDrawOrderMode
 
byte _lastSceneActionItemId
 
byte _lastInventoryActionItemId
 
byte _lastInventoryPrimaryItemId
 
bool _skipRequested
 
bool _stepAdvanceRequested
 

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