ScummVM API documentation
Alcachofa::Game Class Referenceabstract

Provides functionality specific to a game title / engine version. Also includes all exemptions to inconsistencies in the original games. More...

#include <game.h>

Public Member Functions

virtual void onLoadedGameFiles ()
 
virtual Common::Point getResolution ()=0
 
virtual Common::Point getThumbnailResolution ()=0
 
virtual const char *const * getMapFiles ()=0
 Returns a nullptr-terminated list.
 
virtual GameFileReference getScriptFileRef ()=0
 
virtual Common::Span< const ScriptOp > getScriptOpMap ()=0
 
virtual Common::Span< const ScriptKernelTask > getScriptKernelTaskMap ()=0
 
virtual void updateScriptVariables ()=0
 
virtual void drawScreenStates ()
 
virtual Common::String reencodePath (const Common::String &path)
 
virtual const char * getDialogFileName ()=0
 
virtual const char * getObjectFileName ()=0
 
virtual char getTextFileKey ()=0
 
virtual Common::Point getSubtitlePos ()=0
 
virtual const char * getMenuRoom ()=0
 
virtual const char * getInitScriptName ()=0
 
virtual int32 getKernelTaskArgCount (int32 kernelTaskI)
 
virtual Common::Path getVideoPath (int32 videoId)=0
 
virtual Common::String getSoundPath (const char *filename)=0
 Without file-extension.
 
virtual Common::String getMusicPath (int32 trackId)=0
 Without file-extension.
 
virtual int32 getCharacterJingle (MainCharacterKind kind)=0
 
virtual bool shouldFilterTexturesByDefault ()=0
 
virtual bool shouldClipCamera ()=0
 
virtual bool isAllowedToInteract ()=0
 
virtual bool isAllowedToOpenMenu ()=0
 only the game-specific condition
 
virtual bool shouldScriptLockInteraction ()=0
 
virtual bool shouldChangeCharacterUseGameLock ()=0
 
virtual bool shouldAvoidCollisions ()=0
 
virtual Common::Point getMainCharacterSize ()=0
 
virtual bool doesRoomHaveBackground (const Room *room)
 
virtual void unknownRoomObject (const Common::String &type)
 
virtual void unknownRoomType (const Common::String &type)
 
virtual void unknownDoorTargetRoom (const Common::String &name)
 
virtual void unknownDoorTargetDoor (const Common::String &room, const Common::String &door)
 
virtual void invalidDialogLine (uint index)
 
virtual void tooManyDialogLines (uint lineCount, uint maxLineCount)
 
virtual void tooManyDrawRequests (int order)
 
virtual bool shouldCharacterTrigger (const Character *character, const char *action)
 
virtual bool shouldTriggerDoor (const Door *door)
 
virtual bool hasMortadeloVoice (const Character *character)
 
virtual void onUserChangedCharacter ()
 
virtual void unknownCamSetInactiveAttribute (int attribute)
 
virtual void unknownFadeType (int fadeType)
 
virtual void unknownSerializedObject (const char *object, const char *owner, const char *room)
 
virtual void unknownPickupItem (const char *name)
 
virtual void unknownDropItem (const char *name)
 
virtual void unknownVariable (const char *name)
 
virtual void unknownInstruction (const ScriptInstruction &instruction)
 
virtual void unknownAnimateObject (const char *name)
 
virtual void unknownScriptCharacter (const char *action, const char *name)
 
virtual PointObjectunknownGoPutTarget (const Process &process, const char *action, const char *name)
 May return an alternative target to use.
 
virtual void unknownChangeCharacterRoom (const char *name)
 
virtual void unknownAnimateCharacterObject (const char *name)
 
virtual CharacterunknownSayTextCharacter (const char *name, int32 dialogId)
 
virtual void unknownAnimateTalkingObject (const char *name)
 
virtual void unknownClearInventoryTarget (int characterKind)
 
virtual PointObjectunknownCamLerpTarget (const char *action, const char *name)
 
virtual void unknownKernelTask (int task)
 
virtual void unknownScriptProcedure (const Common::String &procedure)
 
virtual void unknownMenuAction (int32 actionId)
 
virtual void missingAnimation (const Common::String &fileName)
 
virtual void missingSound (const Common::String &fileName)
 
virtual void invalidSNDFormat (uint format, uint channels, uint freq, uint bps)
 
virtual void notEnoughRoomDataRead (const char *path, int64 filePos, int64 objectEnd)
 
virtual void notEnoughObjectDataRead (const char *room, int64 filePos, int64 objectEnd)
 
virtual bool isKnownBadVideo (int32 videoId)
 
virtual void invalidVideo (int32 videoId, const char *context)
 

Static Public Member Functions

static Gamecreate ()
 
static GamecreateForMovieAdventureSpecial ()
 
static GamecreateForMovieAdventureOriginal ()
 
static GamecreateForTerror ()
 
static GamecreateForVaqueros ()
 
static GamecreateForSecta ()
 
static GamecreateForMoscu ()
 
static GamecreateForEscarabajo ()
 

Public Attributes

const Message _message
 

Detailed Description

Provides functionality specific to a game title / engine version. Also includes all exemptions to inconsistencies in the original games.

If an error is truly unrecoverable or a warning never an engine bug, no method is necessary here


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