Inheritance diagram for CryOmni3D::CryOmni3DEngine:

Public Types
typedef void(CryOmni3DEngine::*	HNMCallback) (uint frameNum)

Public Types inherited from Engine
enum	EngineFeature { kSupportsSubtitleOptions, kSupportsReturnToLauncher, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime, kSupportsChangingOptionsDuringRuntime, kSupportsArbitraryResolutions, kSupportsHelp, kSupportsQuitDialogOverride }

Public Member Functions
	CryOmni3DEngine (OSystem syst, const CryOmni3DGameDescription gamedesc)

const char *	getGameId () const

uint32	getFeatures () const

uint16	getVersion () const

Common::Platform	getPlatform () const

uint8	getGameType () const

Common::Language	getLanguage () const

bool	hasFeature (EngineFeature f) const override

bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override

bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr) override

void	setCanLoadSave (bool canLoadSave)

Image::ImageDecoder *	loadHLZ (const Common::Path &filepath)

void	fillSurface (byte color)

void	setCursor (const Graphics::Cursor &cursor) const

void	setCursor (uint cursorId) const

bool	showMouse (bool visible)

void	playHNM (const Common::Path &filepath, Audio::Mixer::SoundType soundType=Audio::Mixer::kPlainSoundType, HNMCallback beforeDraw=nullptr, HNMCallback afterDraw=nullptr)

bool	displayHLZ (const Common::Path &filepath, uint32 timeout=uint(-1))

bool	pollEvents ()

Common::Point	getMousePos ()

void	setMousePos (const Common::Point &point)

uint	getCurrentMouseButton ()

Common::KeyState	getNextKey ()

bool	checkKeysPressed ()

bool	checkKeysPressed (uint numKeys,...)

void	clearKeys ()

void	waitMouseRelease ()

void	setAutoRepeatClick (uint millis)

DragStatus	getDragStatus ()

virtual bool	displayToolbar (const Graphics::Surface *original)=0

virtual bool	hasPlaceDocumentation ()=0

virtual bool	displayPlaceDocumentation ()=0

virtual uint	displayOptions ()=0

virtual bool	shouldAbort ()

virtual void	makeTranslucent (Graphics::Surface &dst, const Graphics::Surface &src) const =0

virtual void	setupPalette (const byte *colors, uint start, uint num)=0

Public Member Functions inherited from Engine
MetaEngine *	getMetaEngine () const

void	setMetaEngine (MetaEngine *metaEngine)

PauseToken	pauseEngine ()

bool	isPaused () const

void	openMainMenuDialog ()

uint32	getTotalPlayTime () const

void	setTotalPlayTime (uint32 time=0)

Common::TimerManager *	getTimerManager ()

Common::EventManager *	getEventManager ()

Common::SaveFileManager *	getSaveFileManager ()

bool	existExtractedCDAudioFiles (uint track=1)

bool	isDataAndCDAudioReadFromSameCD ()

void	warnMissingExtractedCDAudio ()

void	handleAutoSave ()

void	saveAutosaveIfEnabled ()

virtual bool	canSaveAutosaveCurrently ()

virtual int	getAutosaveSlot () const

virtual bool	gameTypeHasAddOns () const

virtual bool	dirCanBeGameAddOn (const Common::FSDirectory &dir) const

virtual bool	dirMustBeGameAddOn (const Common::FSDirectory &dir) const

Common::ErrorCode	updateAddOns (const MetaEngine *metaEngine) const

	Engine (OSystem *syst)

virtual	~Engine ()

virtual void	initializePath (const Common::FSNode &gamePath)

virtual void	errorString (const char buf_input, char buf_output, int buf_output_size)

virtual GUI::Debugger *	getDebugger () final

void	setDebugger (GUI::Debugger *debugger)

GUI::Debugger *	getOrCreateDebugger ()

bool	enhancementEnabled (int32 cls)

virtual void	syncSoundSettings ()

virtual void	applyGameSettings ()

virtual void	flipMute ()

virtual Common::String	getSaveStateName (int slot) const

virtual Common::Error	loadGameState (int slot)

virtual Common::Error	loadGameStream (Common::SeekableReadStream *stream)

void	setGameToLoadSlot (int slot)

virtual Common::Error	saveGameState (int slot, const Common::String &desc, bool isAutosave=false)

virtual Common::Error	saveGameStream (Common::WriteStream *stream, bool isAutosave=false)

bool	saveGameDialog ()

bool	loadGameDialog ()

Public Attributes
const CryOmni3DGameDescription *	_gameDescription

Public Attributes inherited from Engine
OSystem *	_system

Audio::Mixer *	_mixer

Static Public Attributes
static const uint	kSaveDescriptionLen = 20

Protected Member Functions
Common::Error	run () override

DATSeekableStream *	getStaticData (uint32 gameId, uint16 version) const

void	copySubPalette (byte dst, const byte src, uint start, uint num)

void	setPalette (const byte *colors, uint start, uint num)

void	lockPalette (uint startRW, uint endRW)

void	unlockPalette ()

void	fadeOutPalette ()

void	fadeInPalette (const byte *colors)

void	setBlackPalette ()

void	setHNMClipping (const Common::Rect &clip)

void	unsetHNMClipping ()

Protected Member Functions inherited from Engine
virtual int	runDialog (GUI::Dialog &dialog)

void	defaultSyncSoundSettings ()

Protected Attributes
bool	_canLoadSave

FontManager	_fontManager

Sprites	_sprites

Objects	_objects

Inventory	_inventory

Common::Queue< Common::KeyState >	_keysPressed

DragStatus	_dragStatus

Common::Point	_dragStart

uint	_lastMouseButton

uint	_autoRepeatNextEvent

Protected Attributes inherited from Engine
Common::TimerManager *	_timer

Common::EventManager *	_eventMan

Common::SaveFileManager *	_saveFileMan

GUI::Dialog *	_mainMenuDialog

const Common::String	_targetName

int32	_activeEnhancements = kEnhGameBreakingBugFixes

Additional Inherited Members
Static Public Member Functions inherited from Engine
static void	quitGame ()

static bool	shouldQuit ()

static bool	warnUserAboutUnsupportedGame (Common::String msg=Common::String())

static bool	warnUserAboutUnsupportedAddOn (Common::String addOnName)

static void	errorAddingAddOnWithoutBaseGame (Common::String addOnName, Common::String gameId)

static void	errorUnsupportedGame (Common::String extraMsg)

Member Function Documentation

◆ run()

Common::Error CryOmni3D::CryOmni3DEngine::run ( )

overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns: kNoError on success, otherwise an error code.

Implements Engine.

Reimplemented in CryOmni3D::Versailles::CryOmni3DEngine_Versailles, and CryOmni3D::CryOmni3DEngine_HNMPlayer.

◆ hasFeature()

bool CryOmni3D::CryOmni3DEngine::hasFeature ( EngineFeature f ) const

overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

Reimplemented in CryOmni3D::Versailles::CryOmni3DEngine_Versailles.

◆ canLoadGameStateCurrently()

bool CryOmni3D::CryOmni3DEngine::canLoadGameStateCurrently ( Common::U32String * msg = nullptr )

inlineoverridevirtual

Indicate whether a game state can be loaded.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ canSaveGameStateCurrently()

bool CryOmni3D::CryOmni3DEngine::canSaveGameStateCurrently ( Common::U32String * msg = nullptr )

inlineoverridevirtual

Indicate whether a game state can be saved.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

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

engines/cryomni3d/cryomni3d.h

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ run()

◆ hasFeature()

◆ canLoadGameStateCurrently()

◆ canSaveGameStateCurrently()