ScummVM API documentation
Wintermute::BaseGame Class Reference
Inheritance diagram for Wintermute::BaseGame:
Wintermute::BaseObject Wintermute::BaseScriptHolder Wintermute::BaseScriptable Wintermute::BaseNamedObject Wintermute::BaseClass Wintermute::AdGame

Classes

struct  LastClickInfo
 

Public Member Functions

virtual bool onScriptShutdown (ScScript *script)
 
virtual bool getLayerSize (int *LayerWidth, int *LayerHeight, Common::Rect32 *viewport, bool *customViewport)
 
virtual BaseObjectgetNextAccessObject (BaseObject *currObject)
 
virtual BaseObjectgetPrevAccessObject (BaseObject *currObject)
 
virtual bool onActivate (bool activate, bool refreshMouse)
 
virtual bool onMouseLeftDown ()
 
virtual bool onMouseLeftUp ()
 
virtual bool onMouseLeftDblClick ()
 
virtual bool onMouseRightDblClick ()
 
virtual bool onMouseRightDown ()
 
virtual bool onMouseRightUp ()
 
virtual bool onMouseMiddleDown ()
 
virtual bool onMouseMiddleUp ()
 
virtual bool onPaint ()
 
virtual bool onWindowClose ()
 
bool isLeftDoubleClick ()
 
bool isRightDoubleClick ()
 
virtual bool miniUpdate ()
 
void getMousePos (Common::Point32 *pos)
 
virtual bool displayDebugInfo ()
 
virtual bool renderShadowGeometry ()
 
virtual bool resetContent ()
 
void DEBUG_DumpClassRegistry ()
 
bool setWaitCursor (const char *filename)
 
bool displayIndicator ()
 
void setEngineLogCallback (ENGINE_LOG_CALLBACK callback=nullptr, void *data=nullptr)
 
void getOffset (int *offsetX, int *offsetY) const
 
void setOffset (int32 offsetX, int32 offsetY)
 
int getSequence ()
 
bool initInput ()
 
bool initLoop ()
 
bool initConfManSettings ()
 
bool initRenderer ()
 
bool initialize1 ()
 
bool initialize2 ()
 
bool initialize3 ()
 
void LOG (bool res, const char *fmt,...)
 
 BaseGame (const Common::String &targetName)
 
void debugDisable ()
 
void debugEnable (const char *filename=nullptr)
 
virtual bool loadFile (const char *filename)
 
virtual bool loadBuffer (char *buffer, bool complete=true)
 
bool invalidateDeviceObjects () override
 
bool restoreDeviceObjects () override
 
virtual bool externalCall (ScScript *script, ScStack *stack, ScStack *thisStack, char *name)
 
ScValuescGetProperty (const char *name) override
 
bool scSetProperty (const char *name, ScValue *value) override
 
bool scCallMethod (ScScript *script, ScStack *stack, ScStack *thisStack, const char *name) override
 
const char * scToString () override
 
void setWindowTitle ()
 
bool handleMouseWheel (int32 delta) override
 
virtual bool getVersion (byte *verMajor, byte *verMinor, byte *extMajor, byte *extMinor)
 
bool handleKeypress (Common::Event *event, bool printable=false) override
 
virtual void handleKeyRelease (Common::Event *event)
 
bool handleAccessKey (Common::Event *event, bool printable)
 
virtual bool handleCustomActionStart (BaseGameCustomAction action)
 
virtual bool handleCustomActionEnd (BaseGameCustomAction action)
 
bool unfreeze ()
 
bool freeze (bool includingMusic=true)
 
bool focusWindow (UIWindow *window)
 
bool loadSettings (const char *filename)
 
bool resumeMusic (int channel)
 
bool setMusicStartTime (int channel, uint32 time)
 
bool pauseMusic (int channel)
 
bool stopMusic (int channel)
 
bool playMusic (int channel, const char *filename, bool looping=true, uint32 loopStart=0, uint32 privVolume=100)
 
bool displayWindows (bool inGame=false)
 
Common::String readRegistryString (const Common::String &key, const Common::String &initValue) const
 
virtual bool cleanup ()
 
bool loadGame (uint32 slot)
 
bool loadGame (const char *filename)
 
bool saveGame (int32 slot, const char *desc, bool quickSave=false)
 
bool showCursor () override
 
bool validObject (BaseObject *object)
 
bool unregisterObject (BaseObject *object)
 
bool registerObject (BaseObject *object)
 
void quickMessage (const char *text)
 
void quickMessageForm (char *fmt,...)
 
bool displayQuickMsg ()
 
bool updateMusicCrossfade ()
 
bool isVideoPlaying ()
 
bool stopVideo ()
 
bool accessPause ()
 
bool accessUnpause ()
 
virtual bool displayContent (bool update=true, bool displayAll=false)
 
virtual bool displayContentSimple ()
 
void resetMousePos ()
 
void setInteractive (bool state)
 
virtual bool windowLoadHook (UIWindow *win, char **buf, char **params)
 
virtual bool windowScriptMethodHook (UIWindow *win, ScScript *script, ScStack *stack, const char *name)
 
bool getCurrentViewportOffset (int *offsetX=nullptr, int *offsetY=nullptr)
 
bool getCurrentViewportRect (Common::Rect32 *rect, bool *custom=nullptr)
 
bool popViewport ()
 
bool pushViewport (BaseViewport *viewport)
 
bool setActiveObject (BaseObject *obj)
 
bool drawCursor (BaseSprite *cursor)
 
virtual bool initAfterLoad ()
 
void setIndicatorVal (int value)
 
bool getBilinearFiltering ()
 
void addMem (int32 bytes)
 
AnsiString getDeviceType () const
 
bool isDoubleClick (int32 buttonIndex)
 
void autoSaveOnExit ()
 
PluginEventpluginEvents ()
 
- Public Member Functions inherited from Wintermute::BaseObject
virtual const char * getAccessCaption ()
 
virtual bool afterMove ()
 
void setSoundEvent (const char *eventName)
 
virtual bool isReady ()
 
virtual bool getExtendedFlag (const char *flagName)
 
virtual bool resetSoundPan ()
 
virtual bool updateSounds ()
 
bool updateOneSound (BaseSound *sound)
 
bool setSFXTime (uint32 time)
 
bool setSFXVolume (int volume)
 
bool resumeSFX ()
 
bool pauseSFX ()
 
bool stopSFX (bool deleteSound=true)
 
bool playSFX (const char *filename, bool looping=false, bool playNow=true, const char *eventName=nullptr, uint32 loopStart=0)
 
virtual bool handleMouse (TMouseEvent event, TMouseButton button)
 
virtual int32 getHeight ()
 
bool setCursor (const char *filename)
 
bool setActiveCursor (const char *filename)
 
bool cleanup ()
 
const char * getCaption (int caseVal=1)
 
void setCaption (const char *caption, int caseVal=1)
 
bool saveAsText (BaseDynamicBuffer *buffer, int indent) override
 
bool listen (BaseScriptHolder *param1, uint32 param2) override
 
 BaseObject (BaseGame *inGame)
 
virtual bool update ()
 
virtual bool display ()
 
ScValuescGetProperty (const char *name) override
 
bool scSetProperty (const char *name, ScValue *value) override
 
bool scCallMethod (ScScript *script, ScStack *stack, ScStack *thisStack, const char *name) override
 
const char * scToString () override
 
- Public Member Functions inherited from Wintermute::BaseScriptHolder
 BaseScriptHolder (BaseGame *inGame)
 
ScScriptinvokeMethodThread (const char *methodName) override
 
virtual void makeFreezable (bool freezable)
 
bool canHandleEvent (const char *eventName)
 
bool canHandleMethod (const char *eventMethod) override
 
bool cleanup ()
 
bool removeScript (ScScript *script)
 
bool addScript (const char *filename)
 
bool saveAsText (BaseDynamicBuffer *buffer, int indent) override
 
bool applyEvent (const char *eventName, bool unbreakable=false)
 
void setFilename (const char *filename)
 
bool parseProperty (char *buffer, bool complete=true)
 
ScValuescGetProperty (const char *name) override
 
bool scSetProperty (const char *name, ScValue *value) override
 
bool scCallMethod (ScScript *script, ScStack *stack, ScStack *thisStack, const char *name) override
 
const char * scToString () override
 
void scDebuggerDesc (char *buf, int bufSize) override
 
virtual bool sendEvent (const char *eventName)
 
- Public Member Functions inherited from Wintermute::BaseScriptable
 BaseScriptable (BaseGame *inGame, bool noValue=false, bool persistable=true)
 
virtual void * scToMemBuffer ()
 
virtual int scToInt ()
 
virtual double scToFloat ()
 
virtual bool scToBool ()
 
virtual void scSetString (const char *val)
 
virtual void scSetInt (int val)
 
virtual void scSetFloat (double val)
 
virtual void scSetBool (bool val)
 
virtual int scCompare (BaseScriptable *val)
 
virtual Common::String debuggerToString () const
 
- Public Member Functions inherited from Wintermute::BaseNamedObject
 BaseNamedObject (BaseGame *inGame)
 
 BaseNamedObject (TDynamicConstructor, TDynamicConstructor)
 
void setName (const char *name)
 
- Public Member Functions inherited from Wintermute::BaseClass
bool setEditorProp (const Common::String &propName, const Common::String &propValue)
 
Common::String getEditorProp (const Common::String &propName, const Common::String &initVal=Common::String())
 
 BaseClass (TDynamicConstructor, TDynamicConstructor)
 
bool parseEditorProperty (char *buffer, bool complete=true)
 
 BaseClass (BaseGame *gameOwner)
 
virtual const char * getClassName ()
 
virtual bool persist (BasePersistenceManager *persistMgr)
 

Static Public Member Functions

static bool emptySaveSlot (int slot)
 
static bool isSaveSlotUsed (int slot)
 
static bool getSaveSlotDescription (int slot, Common::String &desc)
 
static void getSaveSlotTimestamp (int slot, TimeDate *time)
 
static bool getSaveSlotFilename (int slot, Common::String &desc)
 
static void afterLoadRegion (void *region, void *data)
 
static void afterLoadSubFrame (void *subframe, void *data)
 
static void afterLoadSound (void *sound, void *data)
 
static void afterLoadFont (void *font, void *data)
 
static void afterLoadScript (void *script, void *data)
 
static void afterLoadScene (void *scene, void *data)
 
static void invalidateValues (void *value, void *data)
 

Public Attributes

bool _autorunDisabled
 
uint32 _lastMiniUpdate
 
bool _miniUpdateEnabled
 
Common::Rect32 _mouseLockRect
 
bool _shuttingDown
 
bool _debugShowFPS
 
bool _suspendedRendering
 
int32 _soundBufferSizeSec
 
TTextEncoding _textEncoding
 
bool _textRTL
 
BaseSprite_loadingIcon
 
int32 _loadingIconX
 
int32 _loadingIconY
 
int32 _loadingIconPersistent
 
char * _localSaveDir
 
bool _saveDirChecked
 
bool _indicatorDisplay
 
uint32 _indicatorColor
 
int32 _indicatorProgress
 
int32 _indicatorX
 
int32 _indicatorY
 
int32 _indicatorWidth
 
int32 _indicatorHeight
 
bool _richSavedGames
 
char * _savedGameExt
 
char * _loadImageName
 
char * _saveImageName
 
int32 _saveImageX
 
int32 _saveImageY
 
int32 _loadImageX
 
int32 _loadImageY
 
BaseSurface_saveLoadImage
 
bool _hasDrawnSaveLoadImage
 
uint32 _thumbnailWidth
 
uint32 _thumbnailHeight
 
bool _reportTextureFormat
 
ENGINE_LOG_CALLBACK _engineLogCallback
 
void * _engineLogCallbackData
 
bool _editorMode
 
int32 _offsetY
 
int32 _offsetX
 
float _offsetPercentX
 
float _offsetPercentY
 
BaseObject_mainObject
 
uint32 _currentTime {}
 
uint32 _deltaTime
 
BaseFont_systemFont
 
BaseFont_videoFont
 
BaseAccessMgr_accessMgr
 
BaseFileManager_fileManager
 
BaseTransitionMgr_transMgr
 
BaseRenderer_renderer
 
BaseSoundMgr_soundMgr
 
ScEngine_scEngine
 
BaseScriptable_mathClass
 
BaseScriptable_directoryClass
 
BaseSurfaceStorage_surfaceStorage
 
BaseFontStorage_fontStorage
 
bool _debugMode
 
void * _debugLogFile
 
int32 _sequence
 
BaseArray< BaseQuickMsg * > _quickMessages
 
BaseArray< UIWindow * > _windows
 
BaseArray< BaseViewport * > _viewportStack
 
int32 _viewportSP
 
bool _mouseLeftDown
 
bool _mouseRightDown
 
bool _mouseMidlleDown
 
BaseStringTable_stringTable
 
int _settingsResWidth
 
int _settingsResHeight
 
bool _settingsRequireAcceleration
 
bool _settingsAllowWindowed
 
bool _settingsAllowAdvanced
 
bool _settingsAllowAccessTab
 
bool _settingsAllowAboutTab
 
bool _settingsRequireSound
 
bool _settingsAllowDesktopRes
 
int32 _settingsTLMode
 
char * _settingsGameFile
 
BaseFader_fader
 
bool _suppressScriptErrors
 
bool _compatKillMethodThreads
 
uint32 _surfaceGCCycleTime
 
bool _smartCache
 
bool _videoSubtitles
 
bool _subtitles
 
uint32 _musicStartTime [5]
 
bool _compressedSavegames
 
int32 _scheduledLoadSlot
 
bool _loading
 
bool _personalizedSave
 
bool _quitting
 
int32 _freezeLevel
 
VideoPlayer_videoPlayer
 
VideoTheoraPlayer_theoraPlayer
 
bool _loadInProgress
 
UIWindow_focusedWindow
 
bool _editorForceScripts
 
BaseSound_music [5]
 
bool _musicCrossfadeRunning
 
bool _musicCrossfadeSwap
 
uint32 _musicCrossfadeStartTime
 
uint32 _musicCrossfadeLength
 
int32 _musicCrossfadeChannel1
 
int32 _musicCrossfadeChannel2
 
int32 _musicCrossfadeVolume1
 
int32 _musicCrossfadeVolume2
 
bool _useD3D
 
BaseSprite_cursorNoninteractive
 
BaseObject_activeObject
 
BaseKeyboardState_keyboardState
 
bool _interactive
 
TGameState _state
 
TGameState _origState
 
bool _origInteractive
 
uint32 _timer
 
uint32 _timerDelta
 
uint32 _timerLast
 
uint32 _liveTimer
 
uint32 _liveTimerDelta
 
uint32 _liveTimerLast
 
BaseObject_capturedObject
 
Common::Point32 _mousePos
 
uint32 _fps
 
BaseArray< BaseObject * > _regObjects
 
bool _accessTTSEnabled
 
bool _accessTTSTalk
 
bool _accessTTSCaptions
 
bool _accessTTSKeypress
 
bool _accessKeyboardEnabled
 
bool _accessKeyboardCursorSkip
 
bool _accessKeyboardPause
 
bool _accessGlobalPaused
 
UIWindow_accessShieldWin
 
bool _forceNonStreamedSounds
 
int32 _subtitlesSpeed
 
BaseSprite_lastCursor
 
SaveThumbHelper_cachedThumbnail
 
BaseGameMusic * _musicSystem
 
Common::String _targetName
 
bool _touchInterface
 
bool _bilinearFiltering {}
 
LastClickInfo _lastClick [2]
 
uint32 _usedMem
 
- Public Attributes inherited from Wintermute::BaseObject
char * _accessCaption
 
Graphics::TSpriteBlendMode _blendMode
 
float _relativeRotate
 
bool _rotateValid
 
float _rotate
 
bool _rotatable
 
uint32 _alphaColor
 
float _scale
 
float _scaleX
 
float _scaleY
 
float _relativeScale
 
bool _autoSoundPanning
 
uint32 _sFXStart
 
int32 _sFXVolume
 
BaseSound_sFX
 
TSFXType _sFXType
 
float _sFXParam1
 
float _sFXParam2
 
float _sFXParam3
 
float _sFXParam4
 
bool _editorSelected
 
bool _editorAlwaysRegister
 
bool _editorOnly
 
bool _is3D
 
BaseSprite_cursor
 
bool _sharedCursors
 
BaseSprite_activeCursor
 
bool _ready
 
bool _registrable
 
bool _zoomable
 
bool _shadowable
 
Common::Rect32 _rect
 
bool _rectSet
 
int32 _id
 
bool _movable
 
char * _caption [7]
 
char * _soundEvent
 
int32 _posY
 
int32 _posX
 
bool _saveState
 
bool _nonIntMouseEvents
 
- Public Attributes inherited from Wintermute::BaseScriptHolder
char * _filename
 
bool _freezable
 
bool _ready {}
 
BaseArray< ScScript * > _scripts
 
- Public Attributes inherited from Wintermute::BaseScriptable
int32 _refCount
 
ScValue_scValue
 
ScValue_scProp
 
- Public Attributes inherited from Wintermute::BaseNamedObject
char * _name
 
- Public Attributes inherited from Wintermute::BaseClass
bool _persistable
 
BaseGame_game
 
Common::HashMap< Common::String, Common::String_editorProps
 
Common::HashMap< Common::String, Common::String >::iterator _editorPropsIter
 

Protected Attributes

bool _autoSaveOnExit
 
uint32 _autoSaveSlot
 
bool _cursorHidden
 

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