Load world for nteractive main menu. More...

Inheritance diagram for Dragengine.Gui.MainMenus.Interactive.IMMLoadWorld:

Public Member Functions
void	dispose ()
	Dispose of widget. More...

DebugVerifyStubProperties	getDebugVerifyStubProperties ()
	Debug verify stub properties while loading or null if not used. More...

InteractiveMainMenu	getMainMenu ()
	Interactive main menu. More...

PreloadManager	getPreloadManager ()
	Preload manager. More...

StubGameWorld	getStubWorld ()
	World stub. More...

GameWorld	getWorld ()
	World or null. More...

void	loadWorld (String path)
	Start loading world. More...

IMMLoadWorld	new (InteractiveMainMenu mainMenu)
	Create load world for interactive main menu. More...

void	setDebugVerifyStubProperties (DebugVerifyStubProperties debug)
	Set debug verify stub properties while loading or null if not used. More...

GameWorld	update (float elapsed)
	Update loading. More...

Protected Member Functions
void	finishLoading ()
	Finish preloading. More...

bool	reportPreloadProblems ()
	Report preload problems. More...

Detailed Description

Load world for nteractive main menu.

Loads a world file using it as the menu the user can interact with. The elements placed in the world are special element classes providing the menu interaction support. This makes the world file fully conclusive not requiring anything else than the world file path to create the menu.

The main camera spot is named "main". The world is required to have one camera spot with this name for the interactive main menu to work correctly.

Member Function Documentation

◆ dispose()

void Dragengine.Gui.MainMenus.Interactive.IMMLoadWorld.dispose ( )

Dispose of widget.

◆ finishLoading()

void Dragengine.Gui.MainMenus.Interactive.IMMLoadWorld.finishLoading ( )

protected

Finish preloading.

◆ getDebugVerifyStubProperties()

DebugVerifyStubProperties Dragengine.Gui.MainMenus.Interactive.IMMLoadWorld.getDebugVerifyStubProperties ( )

Debug verify stub properties while loading or null if not used.

◆ getMainMenu()

InteractiveMainMenu Dragengine.Gui.MainMenus.Interactive.IMMLoadWorld.getMainMenu ( )

Interactive main menu.

◆ getPreloadManager()

PreloadManager Dragengine.Gui.MainMenus.Interactive.IMMLoadWorld.getPreloadManager ( )

Preload manager.

◆ getStubWorld()

StubGameWorld Dragengine.Gui.MainMenus.Interactive.IMMLoadWorld.getStubWorld ( )

World stub.

◆ getWorld()

GameWorld Dragengine.Gui.MainMenus.Interactive.IMMLoadWorld.getWorld ( )

World or null.

◆ loadWorld()

void Dragengine.Gui.MainMenus.Interactive.IMMLoadWorld.loadWorld ( String path )

Start loading world.

Exceptions

EInvalidParam Loading in progress.

◆ new()

IMMLoadWorld Dragengine.Gui.MainMenus.Interactive.IMMLoadWorld.new ( InteractiveMainMenu mainMenu )

Create load world for interactive main menu.

◆ reportPreloadProblems()

bool Dragengine.Gui.MainMenus.Interactive.IMMLoadWorld.reportPreloadProblems ( )

protected

Report preload problems.

◆ setDebugVerifyStubProperties()

void Dragengine.Gui.MainMenus.Interactive.IMMLoadWorld.setDebugVerifyStubProperties ( DebugVerifyStubProperties debug )

Set debug verify stub properties while loading or null if not used.

◆ update()

GameWorld Dragengine.Gui.MainMenus.Interactive.IMMLoadWorld.update ( float elapsed )

Update loading.

If loading fails an exception is thrown and the all temporary instances cleaned up.

Returns: loaded world instance or null if still loading.

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

IMMLoadWorld.ds

Public Member Functions

Protected Member Functions