ScummVM API documentation
Hollywood::GameplayState Struct Reference

#include <game_state.h>

Public Types

enum  {
  kInventoryOwnerCount = 2 , kInventoryOwnerSlotStride = 0x79 , kInventoryVerbCount = 8 , kInventoryFirstSlot = 1 ,
  kInventoryLastSlot = kInventoryOwnerSlotStride - 1 , kInventoryVisibleSlotCount = 16 , kInvalidInventoryItemResourcePage = 0xff , kTravelScreenSlotCount = 8 ,
  kTravelScreenDisabledSlot = 0xff , kFrankensteinPartRewardCount = 3 , kScene2050MuralTilePermutationSize = 49 , kMineDestinationCount = 9 ,
  kFixedInventoryActionTableEntryCount = kInventoryOwnerSlotStride * kInventoryVerbCount + 1 , kInventoryItemRelationTableEntryCount = kInventoryOwnerSlotStride * kInventoryOwnerSlotStride
}
 

Public Member Functions

void reset ()
 
byte frankensteinPartRewardIndex () const
 
void setFrankensteinPartRewardIndex (byte index)
 
void initializeForState7000 ()
 
byte multiToolKnifeResourcePage () const
 
void initializeRonItemResourcePages ()
 
void initializeRonInventoryItems (bool includeDemoSuitcase=false)
 
void initializeTravelScreenSlots ()
 
void visitMineDestination (uint16 sceneId)
 
bool hasVisitedMineDestination (uint16 sceneId) const
 
bool hasTravelScreenDestination (byte destinationId) const
 
bool unlockTravelScreenDestination (byte destinationId)
 
void requestTravelScreenSelection (byte currentChapterId)
 
void initializeSueItemResourcePages ()
 
void initializeSueInventoryItems (bool giveAllItems)
 
bool hasInventoryItem (byte owner, byte itemId) const
 
byte inventorySlotForItem (byte owner, byte itemId) const
 
void addInventoryItem (byte owner, byte itemId)
 
byte giveInventoryItemsWithResourcePages (byte owner)
 
void removeInventoryItem (byte owner, byte itemId)
 
void compactInventory (byte owner)
 
byte firstVisibleInventorySlotForCount (byte itemCount) const
 
uint16 fixedInventoryVerbHandler (byte owner, byte itemId, byte stripIndex) const
 
uint16 dialogueInventoryRelationHandler (byte primaryItemId, byte secondaryItemId, byte relationMode) const
 
void clearInventoryActionTables ()
 

Public Attributes

uint16 mainFlowStateId
 
bool activeActorPoseValid
 
uint16 activeActorPoseStateId
 
uint16 activeActorWorldX
 
uint16 activeActorWorldY
 
byte activeActorFacing
 
byte activeActorCel
 
uint16 activeViewportXOffset
 
byte activeAudioChapterIndex
 
byte currentInventoryOwnerIndex
 
byte currentAmbientMusicCueId
 
uint16 scene9140ReturnStateId
 
byte scene9140VariantIndex
 
byte inventoryItemCountByOwner [kInventoryOwnerCount]
 
byte inventoryFirstVisibleSlotByOwner [kInventoryOwnerCount]
 
byte inventorySlotItemIdByOwner [kInventoryOwnerCount][kInventoryOwnerSlotStride]
 
byte inventoryItemSlotByOwnerAndItemId [kInventoryOwnerCount][kInventoryOwnerSlotStride]
 
byte inventoryItemResourcePageByOwnerAndItemId [kInventoryOwnerCount][kInventoryOwnerSlotStride]
 
uint16 fixedInventoryVerbHandlerIdsByItemAndStrip [kFixedInventoryActionTableEntryCount]
 
uint16 dialogueRelationMode1HandlerIdsByItemPair [kInventoryItemRelationTableEntryCount]
 
uint16 dialogueRelationMode2HandlerIdsByItemPair [kInventoryItemRelationTableEntryCount]
 
bool sharedActorSpriteBankLoaded
 
bool sueInventoryResourceTablesLoaded
 
bool ronInventoryInitialized
 
bool sueInventoryInitialized
 
bool sceneActionCallbacksInstalled
 
bool inventoryPanelDirty
 
byte multiToolKnifeState
 
byte ronTapeRecorderState
 
bool ronSueTapePlayed
 
byte ronTravelQuipIndex
 
bool ronWalletOpened
 
uint16 ronEgyptianMoneyAmount
 
bool ronPendingMabusePillsInMagnetPillbox
 
bool ronLampFueled
 
bool frankensteinDiaryRead
 
bool ronPosterPhotoRemoved
 
byte travelScreenSlotIds [kTravelScreenSlotCount]
 
bool ronTravelScreenUnlocked
 
byte travelScreenCurrentChapterId
 
bool scene3010EntryLineSeen
 
bool scene3010ForestExitSeen
 
bool windmillBladesMoving
 
bool scene3020MaceTaken
 
bool scene3030MachineActivated
 
bool scene3040EntryLineSeen
 
bool scene3040HiddenObjectVisible
 
bool scene3050EntryLineSeen
 
bool scene3050LibraryCaptionRevealed
 
byte scene3060SecretDoorRevealState
 
byte scene3060GlobeFrame
 
byte scene3060GlobePuzzleRunIndex
 
byte scene3060LastGlobePuzzleButton
 
byte scene3060GlobePuzzleRuns [8]
 
byte scene3060InspectedTitleFlags
 
bool scene3060GlobeButtonsDiscovered
 
bool scene3070EntryLineSeen
 
bool scene3070DrawerOpen
 
byte scene3070SurgicalNeedleThreadState
 
byte scene3070FrankensteinBodyState
 
bool scene3070SurgicalNeedleThreadTaken
 
bool scene3070OperatingTableAlternateDescription
 
byte scene3070StoryPhase
 
byte scene3070SerumIngredientCount
 
bool scene3070OperatingTableForegroundAlternate
 
bool scene3070WindowForegroundPatchActive
 
bool scene3070InterludeCutsceneSeen
 
bool scene3070InterludeUnlocked
 
bool scene3070LateCutscenePlayed
 
bool scene3080EntryLineSeen
 
bool scene3080CabinDoorVisited
 
bool scene3080FrankensteinDiaryRevealed
 
bool scene3080FrankensteinDiaryTaken
 
bool scene3080WindowOpened
 
bool scene3080BranchTaken
 
bool scene3080ChimneySmokeAnimationChanged
 
bool scene3090EntryLineSeen
 
byte scene3090SecretDiaryPuzzleStage
 
byte scene3090WindowOpenSequenceState
 
bool scene3090BlindManPlayingSaxophone
 
bool scene3090SaltShakerTaken
 
bool scene3090DowsingRodTaken
 
bool scene3090BlindManConversationSeen
 
byte scene3090SecretDiaryPuzzleProgress
 
bool scene3090DialogueMentionedBlindManLaxative
 
byte dowsingRodKarlExchangeState
 
bool scene3100CabinVisited
 
byte scene3100GirlConversationState
 
bool scene3100DaisyVisible
 
byte scene3100GirlDialogueRepeatCounter
 
bool scene3100SapSyringeTaken
 
bool scene3100DaisyTaken
 
bool scene1010EntryLineSeen
 
bool scene1020EntryLineSeen
 
byte scene1020HookPositionState
 
byte scene1020ChainAttachedToGrate
 
bool scene1020GrateRaised
 
bool scene1020SueTapeVisible
 
bool scene1020BrokenRecorderIdentified
 
bool scene1020RustyRailGreased
 
bool scene1020SueTapeNoticed
 
bool scene1030EntryConversationSeen
 
byte scene1030TablePickupState
 
bool scene1030SleepingDrunkInspected
 
bool scene1030ShrinkingManNamed
 
bool scene1040EntryLineSeen
 
bool scene1040CloakroomDoorOpened
 
byte scene1040GorillaCordState
 
bool scene1040BalloonTaken
 
bool scene1050SuitcaseTaken
 
bool scene1050CloakroomAttendantConversationSeen
 
bool scene1050JackLookedAt
 
bool scene1050CharlieBogWerewolfClueHeard
 
bool scene1060EntryLineSeen
 
byte scene1060DrMoscaState
 
bool scene1060DrMoscaConversationSeen
 
bool scene1060PocketPaperTaken
 
bool scene1060InvisibleManConversationSeen
 
byte scene1060PartyRemainsState
 
bool scene1060FlySlimeHotspotActive
 
bool scene1070DoorOpened
 
bool scene1070ChainRemoved
 
bool scene1070SpiritBlockingHotspot
 
bool scene1070QuasimodoConversationSeen
 
bool scene1070SpencerConversationSeen
 
byte scene1070SpencerTravelClueProgress
 
bool scene1070SpencerCocktailRecipeLearned
 
bool scene1070MicrophoneStandTaken
 
bool scene1070MicrophoneTaken
 
bool scene1080EntryLineSeen
 
byte scene1080FrancoisProgressState
 
bool scene1090EntryLineSeen
 
bool scene1090LightsOff
 
byte scene1090WrappedBrainState
 
bool scene2010EntryLineSeen
 
bool scene2010LongSequenceFirstSpeechSeen
 
bool scene2010B02EntranceUsed
 
byte scene2010TravelReturnSpeechState
 
bool scene2020EntryLineSeen
 
bool scene2020PrincessGone
 
byte scene2020TigerToothState
 
bool scene2020TigerFedSteak
 
bool scene2020HatPresent
 
bool scene2020SunglassesPresent
 
bool scene2020PrincessConversationSeen
 
bool scene2030RightMerchantConversationSeen
 
byte scene2030SeedOfferState
 
byte scene2030MerchantItem2AOfferState
 
bool scene6010StudioEntryUnlocked
 
bool scene6010Item59Visible
 
byte scene6010DoorActionState
 
bool scene6010ExitOverlayPlayed
 
bool scene6010EndgameTravelExitBlocked
 
bool scene6011PendingItem69Visible
 
bool scene6010Item58Taken
 
byte scene2040SphinxBasePatchState
 
byte scene2040SphinxFaceState
 
byte scene2040SphinxItemRevealed
 
byte scene2040SphinxExitInterviewState
 
byte scene2050EntrySpeechState
 
byte scene2050MuralPuzzleState
 
byte scene2050MuralTilePermutation [kScene2050MuralTilePermutationSize]
 
bool scene2050SealRevealed
 
bool scene2050LabyrinthLampReady
 
byte egyptSealPuzzleProgress
 
byte egyptLabyrinthPositionIndex
 
byte scene2070EntryProgress
 
byte scene2070SealExitPatchState
 
byte scene2070InnerPassagePatchState
 
byte scene2070HiddenItemPatchState
 
bool scene2080EntryLineSeen
 
byte scene2080ForegroundState
 
bool scene2080ExitBackSequenceSeen
 
byte scene2080PrincessHairSearchState
 
bool scene2080FirstRow09LookSeen
 
bool scene2080DialogueBranchBUnlocked
 
byte scene2080DialogueBranchAIndex
 
byte scene2080DialogueBranchBIndex
 
byte scene2080DialogueTerminalIndex
 
bool scene2090EntryLineSeen
 
bool scene2100RaStaffTaken
 
bool scene2100PassageOpen
 
byte scene2100MummyBranchState
 
bool scene2100MummyGreetingSeen
 
bool scene2100AfterlifeBranchUnlocked
 
uint16 scene2100MummyDialogueUsedChoiceMask
 
bool scene2110EntryLineSeen
 
byte scene2110TreasureGrantIndex
 
bool scene2110TreasureGranted
 
bool scene6020TaffyKnown
 
bool scene6020TaffyLeft
 
bool scene6020AgendaRead
 
bool scene6020PhoneAnnouncementSeen
 
bool scene6020PhoneCallCompleted
 
bool scene6030HannoverInterviewCompleted
 
bool scene6030SaxophoneTaken
 
bool scene6030HannoverAbsent
 
byte scene6030CoffeeState
 
bool scene6040EntryLineSeen
 
bool scene6040PaintCanTaken
 
byte scene6040WireState
 
bool scene6050MuseumInteriorUnlocked
 
bool scene6050GuardPresent
 
bool scene6050GuardAllowsEntry
 
bool scene6050DisplayCaseOpened
 
bool scene6070SuePresent
 
bool scene6070CellDoorOpen
 
bool scene6080Visited
 
bool scene6090Visited
 
bool scene6100EntryLineSeen
 
byte scene6100CharlieState
 
bool scene6100BriefcasePresent
 
bool seenScene8010EntryLine
 
byte scene8010FishermanConversationState
 
bool seenScene8020EntryLine
 
byte scene8020ForegroundObjectState
 
bool scene8020SecondaryObjectVisible
 
byte scene4010AlternateBackgroundState
 
bool scene4010FirstEntryConversationSeen
 
byte scene4010EntryPathSpeechState
 
byte scene4010ProgressiveExitSpeechState
 
byte scene4010Item3APickupState
 
byte scene4010PillboxPickupState
 
bool scene4010DestinationUnlocked
 
bool scene4020FallReactionLineSeen
 
bool scene4020GateUnlocked
 
bool scene4030TowerVisited
 
bool scene4030InitialEntryLineSeen
 
bool scene4030RopeTaken
 
byte scene4030LooseBoneState
 
bool scene4030ImprovisedLeverInstalled
 
bool scene4030IronMaidenOpen
 
bool scene4030MechanismRemarkSeen
 
bool scene4040EntryLineSeen
 
bool scene4040CandilTaken
 
bool scene4050EntryLineSeen
 
byte scene4050RopeSwingState
 
byte scene4060PictureCardStage
 
byte scene4060PerfumeBottleCardStage
 
byte scene4060SherilynSheetWon
 
bool scene4060EntryLineSeen
 
bool scene4060SherilynDialogueIntroSeen
 
byte scene4060SherilynPokerProgressCounter
 
byte scene4070DraculaStage
 
bool scene4070EntryLineSeen
 
bool scene4070TrophyBaseOpened
 
byte scene4070FrankiePartGranted
 
bool scene4070DraculaDialogueIntroSeen
 
byte scene4080GwendolynState
 
byte scene4080GwendolynStateTransition
 
byte scene4080CoffinShiftedState
 
byte scene4080OilBottleState
 
byte scene4080GwendolynNameState
 
byte scene4080GominolaVisibleState
 
bool scene4090InitialGreetingSeen
 
byte scene4090WideCoffinVariant
 
bool scene4090OrganRevealDialogueSeen
 
byte scene4090FinalCutsceneCompleted
 
bool scene4090FinalCutsceneDialogueSeen
 
bool scene4100EntryLineSeen
 
bool scene4110StrawTaken
 
bool scene4110BridgeOpened
 
bool seenScene5010EntryLine
 
byte scene5010MineTransportState
 
bool scene5010MineTransportReady
 
bool scene5010SwitchPanelSeen
 
byte scene5010SwitchRow
 
byte scene5010SwitchColumn
 
bool scene5010MineCartDeparted
 
bool scene5010DestinationTableInitialized
 
uint16 scene5010DestinationStateBySwitchSlot [9]
 
uint16 scene5010VisitedDestinations
 
bool scene5020ExplosivesCrateIdentified
 
bool scene5020WoodenPlankTaken
 
bool scene5030EntryLineSeen
 
byte scene5030DeckOfCardsState
 
bool scene5030MusiciansNamed
 
bool scene5040EntryLineSeen
 
byte scene5040MineGalleryState
 
bool scene5040LooseObjectTaken
 
bool scene5040OldSockTaken
 
byte scene5040DialState
 
bool scene5040KarlDialogueIntroSeen
 
byte scene5040SpecialTransitionState
 
bool scene5050EntryLineSeen
 
bool scene5050TrophyBoxTaken
 
byte scene5050PickupIndex
 
bool scene5060EntryLineSeen
 
bool scene5060GasSmelled
 
bool scene5060RockTaken
 
bool scene5070ShovelTaken
 
byte scene5070AviatorCapState
 
bool scene5080EntryLineSeen
 
bool scene5080PassageUnlocked
 
bool scene5080AlternatePassageSide
 
bool scene5080BookTaken
 
bool scene5080StairDoorBarrierSeen
 
bool scene5080StairDoorConstructionSeen
 
bool scene5090EntryLineSeen
 
bool scene5100EntryLineSeen
 
bool scene5100ButtonsUnlocked
 
bool scene5110IntroSeen
 
bool scene5110UnderwearTaken
 
byte scene5110BottleState
 
byte scene5110SalonTransformState
 
bool scene5110ElevatorTransitionSeen
 
bool scene5110MirrorTaken
 
byte scene5110JacuzziInspectionState
 
bool scene5110WerewolfDialogueChoiceUnlocked
 
bool scene5120TongsTaken
 
byte scene5120CocktailState
 
byte scene5120CocktailRed
 
byte scene5120CocktailGreen
 
byte scene5120CocktailBlue
 
bool reviewedFrankensteinNote
 
byte frankensteinNoteOverlayMode
 
byte hannoverCourtyardDialogueState
 
bool hannoverCourtyardFollowUpSeen
 
bool seenJosephGuestListGreeting
 
byte officeStatueActionProgress
 
byte officeNotePickupState
 
bool openedOfficeClosetDoor
 
bool spokenToCloakroomAttendant
 
byte cloakroomRagVisible
 
bool spokenToBruno
 
byte humeroBarrierState
 
byte humeroBonePickupState
 
byte punchBowlGlassPatchState
 
bool activatedLabExitMachine
 
byte labMachineSpeed
 
bool seenGramophoneRoomIntro
 
byte gramophoneRoomDoorState
 
byte gramophoneCrankState
 
bool seenHannoverOfficeIntro
 
bool crankOnHannoverDesk
 
bool seenHannoverBedroomIntro
 
bool movedBedroomArmor
 
bool cellPipesActive
 
byte cellPlateRatProgress
 
bool posterOnCellWall
 
bool cellPlateRemoved
 
bool musicEnabled
 
bool soundEffectsEnabled
 
bool optionsTestAudioEnabled
 
byte musicVolumeLevel
 
byte soundEffectsVolumeLevel
 
byte voiceVolumeLevel
 
byte speechTextSpeedLevel
 
byte actorSpeechTextMode
 

Detailed Description

Holds gameplay state shared across scene instances.

Serialized fields cover the current flow and actor pose, inventory, puzzle progression, travel unlocks, and user settings. reset() establishes new-game defaults. Runtime-only cache flags are rebuilt or dirtied after loading. Derived rendering and per-frame animation state remains owned by scene objects.


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