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

Public Member Functions

virtual bool getLayerSize (int *LayerWidth, int *LayerHeight, Rect32 *viewport, bool *customViewport)
 
virtual bool onScriptShutdown (ScScript *script)
 
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 void miniUpdate ()
 
void getMousePos (Point32 *Pos)
 
virtual bool displayDebugInfo ()
 
void setShowFPS (bool enabled)
 
bool getBilinearFiltering ()
 
bool getSuspendedRendering () const
 
virtual bool renderShadowGeometry ()
 
virtual bool resetContent ()
 
void DEBUG_DumpClassRegistry ()
 
bool setWaitCursor (const char *filename)
 
uint32 getSaveThumbWidth () const
 
uint32 getSaveThumbHeight () const
 
void getOffset (int *offsetX, int *offsetY) const
 
void setOffset (int32 offsetX, int32 offsetY)
 
int getSequence ()
 
BaseObjectgetMainObject ()
 
BaseFontgetSystemFont ()
 
BaseFontgetVideoFont ()
 
bool initInput ()
 
bool initLoop ()
 
bool initConfManSettings ()
 
bool initRenderer ()
 
bool loadGameSettingsFile ()
 
bool initialize1 ()
 
bool initialize2 ()
 
bool initialize3 ()
 
void expandStringByStringTable (char **str) const
 
void expandStringByStringTable (Common::String &str) const
 
char * getKeyFromStringTable (const char *str) const
 
void LOG (bool res, const char *fmt,...)
 
 BaseGame (const Common::String &targetName)
 
virtual bool loadFile (const char *filename)
 
virtual bool loadBuffer (char *buffer, bool complete=true)
 
virtual bool externalCall (ScScript *script, ScStack *stack, ScStack *thisStack, char *name)
 
ScValuescGetProperty (const Common::String &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
 
const char * getGameTargetName () const
 
void setGameTargetName (const Common::String &targetName)
 
bool getIsLoading () const
 
bool handleMouseWheel (int32 delta) override
 
virtual bool getVersion (byte *verMajor, byte *verMinor, byte *extMajor, byte *extMinor) const
 
bool handleKeypress (Common::Event *event, bool printable=false) override
 
virtual void handleKeyRelease (Common::Event *event)
 
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 displayWindows (bool inGame=false)
 
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
 
const TimergetTimer () const
 
const TimergetLiveTimer () const
 
bool validObject (BaseObject *object)
 
bool unregisterObject (BaseObject *object)
 
bool registerObject (BaseObject *object)
 
void quickMessage (const char *text)
 
void quickMessageForm (char *fmt,...)
 
bool displayQuickMsg ()
 
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) const
 
bool getCurrentViewportRect (Rect32 *rect, bool *custom=nullptr) const
 
bool popViewport ()
 
bool pushViewport (BaseViewport *Viewport)
 
bool setActiveObject (BaseObject *Obj)
 
bool drawCursor (BaseSprite *Cursor)
 
bool storeSaveThumbnail ()
 
void deleteSaveThumbnail ()
 
void addMem (int32 bytes)
 
bool stopVideo ()
 
void autoSaveOnExit ()
 
- Public Member Functions inherited from Wintermute::BaseObject
virtual bool afterMove ()
 
virtual bool isReady ()
 
virtual bool getExtendedFlag (const char *flagName)
 
virtual bool resetSoundPan ()
 
virtual bool updateSounds ()
 
bool updateOneSound (BaseSound *sound)
 
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 Common::String &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) const
 
bool canHandleMethod (const char *eventMethod) const 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)
 
const char * getFilename ()
 
bool parseProperty (char *buffer, bool complete=true)
 
ScValuescGetProperty (const Common::String &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)
 
const char * getName () const
 
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 void invalidateValues (void *value, void *data)
 

Public Attributes

bool _autorunDisabled
 
uint32 _lastMiniUpdate
 
bool _miniUpdateEnabled
 
Rect32 _mouseLockRect
 
bool _shuttingDown
 
TTextEncoding _textEncoding
 
bool _textRTL
 
bool _editorMode
 
int32 _offsetY
 
int32 _offsetX
 
float _offsetPercentX
 
float _offsetPercentY
 
uint32 _currentTime
 
uint32 _deltaTime
 
BaseTransitionMgr_transMgr
 
BaseRenderer_renderer
 
BaseSoundMgr_soundMgr
 
ScEngine_scEngine
 
BaseScriptable_mathClass
 
BaseScriptable_directoryClass
 
BaseSurfaceStorage_surfaceStorage
 
BaseFontStorage_fontStorage
 
bool _debugDebugMode
 
int32 _sequence
 
int32 _viewportSP
 
bool _suppressScriptErrors
 
bool _mouseLeftDown
 
bool _compatKillMethodThreads
 
uint32 _surfaceGCCycleTime
 
bool _smartCache
 
bool _subtitles
 
int32 _scheduledLoadSlot
 
bool _quitting
 
bool _loadInProgress
 
UIWindow_focusedWindow
 
bool _editorForceScripts
 
bool _useD3D
 
BaseObject_activeObject
 
bool _interactive
 
TGameState _state
 
TGameState _origState
 
bool _origInteractive
 
BaseObject_capturedObject
 
Point32 _mousePos
 
bool _forceNonStreamedSounds
 
int32 _subtitlesSpeed
 
BaseSprite_lastCursor
 
SaveThumbHelper_cachedThumbnail
 
bool _touchInterface
 
bool _constrainedMemory
 
- Public Attributes inherited from Wintermute::BaseObject
Graphics::TSpriteBlendMode _blendMode
 
float _scale
 
uint32 _alphaColor
 
int32 _sFXVolume
 
bool _editorOnly
 
bool _is3D
 
BaseSprite_cursor
 
bool _sharedCursors
 
BaseSprite_activeCursor
 
bool _movable
 
bool _zoomable
 
bool _shadowable
 
int32 _posY
 
int32 _posX
 
bool _registrable
 
char * _caption [7]
 
bool _saveState
 
bool _nonIntMouseEvents
 
- Public Attributes inherited from Wintermute::BaseScriptHolder
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_gameRef
 

Protected Attributes

BaseFont_systemFont
 
BaseFont_videoFont
 
BaseSprite_loadingIcon
 
int32 _loadingIconX
 
int32 _loadingIconY
 
int32 _loadingIconPersistent
 
BaseFader_fader
 
int32 _freezeLevel
 
VideoPlayer_videoPlayer
 
VideoTheoraPlayer_theoraPlayer
 
bool _autoSaveOnExit
 
uint32 _autoSaveSlot
 
bool _cursorHidden
 
- Protected Attributes inherited from Wintermute::BaseObject
bool _autoSoundPanning
 
uint32 _sFXStart
 
BaseSound_sFX
 
TSFXType _sFXType
 
float _sFXParam1
 
float _sFXParam2
 
float _sFXParam3
 
float _sFXParam4
 
float _relativeRotate
 
bool _rotateValid
 
float _rotate
 
bool _rotatable
 
float _scaleX
 
float _scaleY
 
float _relativeScale
 
bool _editorSelected
 
bool _editorAlwaysRegister
 
bool _ready
 
Rect32 _rect
 
bool _rectSet
 
int32 _iD
 
char * _soundEvent
 
- Protected Attributes inherited from Wintermute::BaseClass
Common::HashMap< Common::String, Common::String_editorProps
 
Common::HashMap< Common::String, Common::String >::iterator _editorPropsIter
 

Additional Inherited Members

- Protected Member Functions inherited from Wintermute::BaseObject
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)
 
void setSoundEvent (const char *eventName)
 

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