ScummVM API documentation
Harvester::Script Class Reference

Public Types

enum  { kNoMonsterfyPosZOverride = 0x7fffffff }
 

Public Member Functions

bool load (ResourceManager &resources)
 
bool reloadTownWorld (ResourceManager &resources)
 
const Common::StringgetPath () const
 
const Common::Array< byte > & getData () const
 
const Common::Array< EntranceRecord > & getEntrances () const
 
const Common::Array< MapEntranceRecord > & getMapEntrances () const
 
const Common::Array< MapLocationRecord > & getMapLocations () const
 
const Common::Array< RoomRecord > & getRooms () const
 
const Common::Array< ObjectRecord > & getObjects () const
 
const Common::Array< AnimRecord > & getAnimations () const
 
const Common::Array< NpcRecord > & getNpcs () const
 
const Common::Array< MonsterRecord > & getMonsters () const
 
const Common::Array< TimerRecord > & getTimers () const
 
const Common::Array< RegionRecord > & getRegions () const
 
const Common::Array< FlagRecord > & getFlags () const
 
const Common::Array< CommandRecord > & getCommands () const
 
const Common::Array< ExecListRecord > & getExecLists () const
 
const Common::Array< TextRecord > & getTexts () const
 
const Common::Array< HeadRecord > & getHeads () const
 
const Common::Array< UseItemRecord > & getUseItems () const
 
bool isQuickTipsEnabled () const
 
void setQuickTipsEnabled (bool enabled)
 
const Common::StringgetVoicePath () const
 
bool isGoreEnabled () const
 
void setGoreEnabled (bool enabled)
 
StartupDialogueTextMode getDialogueTextMode () const
 
void setDialogueTextMode (StartupDialogueTextMode mode)
 
int getFxVolumeLevel () const
 
void setFxVolumeLevel (int level)
 
int getMusicVolumeLevel () const
 
void setMusicVolumeLevel (int level)
 
int getGammaLevel () const
 
void setGammaLevel (int level)
 
const Common::StringgetParentalPassword () const
 
void setParentalPassword (const Common::String &password)
 
bool saveConfig () const
 
void resetRuntimeState ()
 
void syncRuntimeSaveState (Common::Serializer &s)
 
bool resolveRoomSetupState (const Common::String &entranceName, RoomSetupState &state, ResourceManager &resources)
 
bool resolveRoomSetupStateByRoomName (const Common::String &roomName, RoomSetupState &state, ResourceManager &resources)
 
bool materializeRoomState (const Common::String &entranceName, const Common::String &roomName, RoomSetupState &state, ResourceManager &resources) const
 
bool hasRoomSetupTarget (const Common::String &entranceName, const Common::String &roomName) const
 
bool executeRoomEnterCommands (const Common::String &roomName, InteractionResult &result)
 
bool executeRoomExitCommands (const Common::String &roomName, InteractionResult &result)
 
bool resolveObjectInteraction (const ObjectRecord &object, InteractionResult &result, const Common::String &roomName=Common::String())
 
bool resolveRegionInteraction (const RegionRecord &region, InteractionResult &result, const Common::String &roomName=Common::String())
 
bool resolveUseItemInteraction (const Common::String &itemName, const ObjectRecord &target, InteractionResult &result, const Common::String &roomName=Common::String())
 
bool executeDebugCommand (const CommandRecord &command, InteractionResult &result, bool allowTransitions=true)
 
bool executeActionTag (const Common::String &tag, InteractionResult &result, bool allowTransitions=true, const Common::String &roomName=Common::String())
 
bool executeTimerAction (const Common::String &timerName, InteractionResult &result, bool allowTransitions=true, const Common::String &roomName=Common::String())
 
bool executeNestedActionTag (const Common::String &tag, InteractionResult &result, bool allowTransitions=true)
 
bool isPickupObject (const ObjectRecord &object) const
 
bool isPickupBlockedByAction (const ObjectRecord &object, InteractionResult *result=nullptr) const
 
bool hasObjectInteraction (const ObjectRecord &object) const
 
bool hasUseItemInteraction (const Common::String &itemName, const ObjectRecord &target) const
 
void getVisibleInventoryObjects (Common::Array< ObjectRecord > &objects) const
 
bool isObjectInInventory (const Common::String &objectName) const
 
void markObjectIdentShown (const ObjectRecord &object)
 
bool resolveObjectInspectText (const ObjectRecord &object, ResolvedText &text) const
 
bool resolveTextRecord (const Common::String &key, ResolvedText &text) const
 
Common::String resolveInventoryTooltipText (const ObjectRecord &object) const
 
Common::String resolveObjectLabel (const ObjectRecord &object) const
 
Common::String resolveTextValue (const Common::String &key) const
 
const HeadRecordfindHeadRecord (const Common::String &headId) const
 
const EntranceRecordfindEntranceRecord (const Common::String &entranceName) const
 
const MapEntranceRecordfindMapEntranceRecord (const Common::String &entryName) const
 
bool getFlagValue (const Common::String &flagName) const
 
const TimerRecordfindRuntimeTimerRecord (const Common::String &timerName) const
 
const NpcRecordfindRuntimeNpcRecord (const Common::String &npcName) const
 
bool setRuntimeFlagValue (const Common::String &flagName, bool value)
 
bool resetRuntimeObjectToInitialState (const Common::String &objectName)
 
bool addRuntimeObjectToInventory (const Common::String &objectName)
 
bool syncRuntimeObjectRecord (const ObjectRecord &object)
 
bool setRuntimeObjectVisible (const Common::String &ownerOrRoom, const Common::String &objectName, bool visible)
 
bool setRuntimeNpcState (const Common::String &npcName, bool active, bool visible)
 
bool queueRuntimeNpcDeathOrMonsterfy (const Common::String &npcName, int deathDamageType=0)
 
bool finalizeRuntimeNpcDeathOrMonsterfy (const Common::String &npcName, int deathDamageType=0, bool preserveCorpse=false, int corpseFrame=-1, int monsterfyPosZ=kNoMonsterfyPosZOverride)
 
void pushDeferredLiveNpcDeathTransitions ()
 
void popDeferredLiveNpcDeathTransitions ()
 
bool isNamedNpcDeathTypeClear (const Common::String &npcName) const
 
int getCurrentStoryDayIndex () const
 
int getPlayerCurrentHitPoints () const
 
int getPlayerCombatLoadout () const
 
int getPlayerCombatResourceCount (int loadout) const
 
bool consumePlayerCombatResourceUnit (int loadout)
 
bool isPlayerControlPaused () const
 
bool adjustPlayerCurrentHitPoints (int delta)
 
bool setPlayerCombatLoadout (int loadout)
 
bool setPlayerControlPaused (bool paused)
 
bool syncRuntimeAnimState (const Common::String &animName, bool active, bool visible, int currentFrame)
 
bool syncRuntimeMonsterRecord (const MonsterRecord &monster)
 
bool syncRuntimeTimerRecord (const TimerRecord &timer)
 
bool setRuntimeRegionEnabled (const Common::String &regionName, bool enabled)
 
bool setRuntimeTimerEnabled (const Common::String &timerName, bool enabled)
 

Static Public Attributes

static const int kDefaultPlayerHitPoints = 30
 

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