Header menu logo Nu

WorldModule4 Module

Universal function definitions for the world (4/4).

Type extensions

Type extension Description

World.make sdlDeps config geometryViewport rasterViewport outerViewport plugin

Full Usage: World.make sdlDeps config geometryViewport rasterViewport outerViewport plugin

Parameters:
Returns: World

Make the world with the given dependencies.

Extended Type: World

sdlDeps : SdlDeps
config : WorldConfig
geometryViewport : Viewport
rasterViewport : Viewport
outerViewport : Viewport
plugin : NuPlugin
Returns: World

World.makePlus plugin eventGraph jobGraph geometryViewport rasterViewport outerViewport dispatchers quadtree octree worldConfig sdlDepsOpt imGui physicsEngine2d physicsEngine3d rendererPhysics3dOpt rendererProcess audioPlayer activeGameDispatcher

Full Usage: World.makePlus plugin eventGraph jobGraph geometryViewport rasterViewport outerViewport dispatchers quadtree octree worldConfig sdlDepsOpt imGui physicsEngine2d physicsEngine3d rendererPhysics3dOpt rendererProcess audioPlayer activeGameDispatcher

Parameters:
Returns: World

Make the world.

Extended Type: World

plugin : NuPlugin
eventGraph : EventGraph
jobGraph : JobGraph
geometryViewport : Viewport
rasterViewport : Viewport
outerViewport : Viewport
dispatchers : Dispatchers
quadtree : Quadtree<Entity>
octree : Octree<Entity>
worldConfig : WorldConfig
sdlDepsOpt : SdlDeps option
imGui : ImGui
physicsEngine2d : PhysicsEngine
physicsEngine3d : PhysicsEngine
rendererPhysics3dOpt : DebugRenderer option
rendererProcess : RendererProcess
audioPlayer : AudioPlayer
activeGameDispatcher : GameDispatcher
Returns: World

World.makeStub worldConfig plugin

Full Usage: World.makeStub worldConfig plugin

Parameters:
Returns: World

Make a world with stub dependencies.

Extended Type: World

worldConfig : WorldConfig
plugin : NuPlugin
Returns: World

World.run worldConfig plugin

Full Usage: World.run worldConfig plugin

Parameters:
Returns: int

Run the game engine, initializing dependencies as indicated by WorldConfig, and returning exit code upon termination.

Extended Type: World

worldConfig : WorldConfig
plugin : NuPlugin
Returns: int

World.runPlus runWhile preProcess perProcess postProcess imGuiProcess imGuiPostProcess worldConfig windowSize geometryViewport rasterViewport outerViewport plugin

Full Usage: World.runPlus runWhile preProcess perProcess postProcess imGuiProcess imGuiPostProcess worldConfig windowSize geometryViewport rasterViewport outerViewport plugin

Parameters:
Returns: int

Run the game engine, initializing dependencies as indicated by WorldConfig, and returning exit code upon termination.

Extended Type: World

runWhile : World -> bool
preProcess : World -> unit
perProcess : World -> unit
postProcess : World -> unit
imGuiProcess : World -> unit
imGuiPostProcess : World -> unit
worldConfig : WorldConfig
windowSize : Vector2i
geometryViewport : Viewport
rasterViewport : Viewport
outerViewport : Viewport
plugin : NuPlugin
Returns: int

World.updateLateBindings assemblies world

Full Usage: World.updateLateBindings assemblies world

Parameters:

Update late bindings internally stored by the engine from types found in the given assemblies.

Extended Type: World

assemblies : Assembly array
world : World

Type something to start searching.