Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.WindowGameWorld.Loader Class Reference

Game loader for use with WindowGameWorld. More...

Inheritance diagram for Dragengine.Gui.WindowGameWorld.Loader:
Dragengine.Utils.GameWorldLoader

Public Member Functions

void dispose ()
 Dispose of game world loader to break reference loops. More...
 
WindowGameWorld getWindow ()
 Window to update. More...
 
Loader new (WindowGameWorld window)
 Create game world loader. More...
 
Loader new (WindowGameWorld window, Console console, Loaders loaders, ElementClassList elementClassList)
 Create game world loader. More...
 
Loader new (WindowGameWorld window, Console console, Loaders loaders, ElementClassList elementClassList, MutableID idGenerator)
 Create game world loader. More...
 
void onLoadWorldFailed ()
 Loading world failed. More...
 
void onLoadWorldFinished ()
 Loading world finished. More...
 
- Public Member Functions inherited from Dragengine.Utils.GameWorldLoader
void cancelLoading ()
 Cancel loading. More...
 
Console getConsole ()
 Console console. More...
 
DebugVerifyStubProperties getDebugVerifyStubProperties ()
 Debug verify stub properties while loading or null if not used. More...
 
DecalBuilder getDecalBuilder ()
 Decal builder used for world decals. More...
 
ElementClassList getElementClassList ()
 Element classes list. More...
 
bool getEnableNetworking ()
 Enable networking. More...
 
MutableID getIDGenerator ()
 ID Generator or null. More...
 
bool getIgnorePersistableElements ()
 Ignore persistable elements. More...
 
Loaders getLoaders ()
 Loaders. More...
 
String getPathWorld ()
 World file path. More...
 
PersistencyEnvironment getPersistencyEnvironment ()
 Persistency environment or null. More...
 
FileReader getPersistencyReader ()
 Persistency reader or null. More...
 
PreloadManager getPreloadManager ()
 Preload manager. More...
 
StubGameWorld getStubWorld ()
 Game world stub. More...
 
WindowLoading getWindowLoading ()
 Loading window window. More...
 
GameWorldLoader new ()
 Create game world loader using BaseGameApp parameters. More...
 
GameWorldLoader new (Console console, Loaders loaders, ElementClassList elementClassList)
 Create game world loader. More...
 
GameWorldLoader new (Console console, Loaders loaders, ElementClassList elementClassList, MutableID idGenerator)
 Create game world loader. More...
 
void setDebugVerifyStubProperties (DebugVerifyStubProperties debug)
 Set debug verify stub properties while loading or null if not used. More...
 
void setDecalBuilder (DecalBuilder decalBuilder)
 Set decal builder used for world decals. More...
 
void setEnableNetworking (bool enable)
 Set if networking is enabled. More...
 
void setIgnorePersistableElements (bool ignorePersistableElements)
 Set if persistable elements are ignored. More...
 
void setPathWorld (String path)
 Set world file path. More...
 
void setPersistency (PersistencyEnvironment environment, FileReader reader)
 Set persistency environment and reader. More...
 
void setWindowLoading (WindowLoading window)
 Set loading window. More...
 
void startLoading ()
 Start loading game world. More...
 
void updateLoading ()
 Update loading. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Utils.GameWorldLoader
void cleanUp ()
 Cleaning up. More...
 
void createContentFromStub ()
 Create world content from stubs. More...
 
GameWorld createGameWorld ()
 Create GameWorld instance. More...
 
void createLoadingWindow ()
 Create loading window. More...
 
bool getCleanUpStubWorld ()
 Clean up world stub. More...
 
void loadWorld ()
 Load world. More...
 
void persistencyCreateContentFromStub ()
 Create world content from stubs using persistency. More...
 
void persistencyReadWorld ()
 Read world from persistency reader. More...
 
void preloadResources ()
 Preload resources. More...
 
bool reportPreloadProblems ()
 Log preloading problems. More...
 
void setCleanUpStubWorld (bool cleanUpStubWorld)
 Set clean up world stub. More...
 
void setStubWorld (StubGameWorld stub)
 Set game world stub. More...
 
void startFrameUpdater ()
 Start frame updater if not started. More...
 
void stopFrameUpdater ()
 Stop frame updater if running. More...
 
void worldStoreNextIDAndRemapEntry ()
 Set world next object ID and add ID Remapper entry if required. More...
 

Detailed Description

Game loader for use with WindowGameWorld.

Create subclass to implement your game loading while this class handles the window. If the loading succeeds the loaded game world is set as world in the window. If loading fails null is set as game world in the window.

Member Function Documentation

◆ dispose()

void Dragengine.Gui.WindowGameWorld.Loader.dispose ( )

Dispose of game world loader to break reference loops.

Reimplemented from Dragengine.Utils.GameWorldLoader.

◆ getWindow()

WindowGameWorld Dragengine.Gui.WindowGameWorld.Loader.getWindow ( )

Window to update.

◆ new() [1/3]

Loader Dragengine.Gui.WindowGameWorld.Loader.new ( WindowGameWorld  window)

Create game world loader.

◆ new() [2/3]

Loader Dragengine.Gui.WindowGameWorld.Loader.new ( WindowGameWorld  window,
Console  console,
Loaders  loaders,
ElementClassList  elementClassList 
)

Create game world loader.

◆ new() [3/3]

Loader Dragengine.Gui.WindowGameWorld.Loader.new ( WindowGameWorld  window,
Console  console,
Loaders  loaders,
ElementClassList  elementClassList,
MutableID  idGenerator 
)

Create game world loader.

Version
1.8

◆ onLoadWorldFailed()

void Dragengine.Gui.WindowGameWorld.Loader.onLoadWorldFailed ( )

Loading world failed.

Game loader has been cleaned up before calling this method. It is safe to dispose() of the game loader upon entering this method.

Reimplemented from Dragengine.Utils.GameWorldLoader.

◆ onLoadWorldFinished()

void Dragengine.Gui.WindowGameWorld.Loader.onLoadWorldFinished ( )

Loading world finished.

Game loader has been cleaned up before calling this method. For this reason the result of loading is provided as parameters. It is safe to dispose() of the game loader upon entering this method.

Reimplemented from Dragengine.Utils.GameWorldLoader.


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