Verge3D Manual

AppPuzzles

A class for setting up a 3D application, capable of loading the Puzzles editor and executing visual logic code.

Performs app initialization/loading in the following order:

starts loading a scene, a logic script and the Puzzles Editor depending on the method used (.loadScene, .loadSceneWithLogic, .loadSceneWithEditor)
calls the corresponding callback (.onSceneLoad, .onLogicLoad, .onEditorLoad) when something is loaded or the .onError callback in case of an error
calls the .onLoadFinished callback after all loading actions were finished successfully or not
removes the preloader, starts the rendering cycle and executes the logic script successively by calling the .run method.

Constructor

AppPuzzles(containerId, ctxSettings, preloader)

containerId - the id of an HTML-element containing the canvas.
ctxSettings - the WebGL context attributes to be passed in the 'canvas.getContext()' method.
preloader - the application's Preloader.

Properties

# .ExternalInterface : Object

An object containing functions created in the Puzzles Editor to access them from the application's code. Typical usage: calling a function manually, setting/overriding a function.

Methods

# .loadScene (url) : null

# .loadSceneWithEditor (url, logicURL, editorDir) : null

Load a gltf scene along with the Puzzles Editor. The editor needs to be provided with the path to the target logic JS file (specified by the logicURL parameter) and with the path to the Puzzles Editor's resource folder (specified by the editorDir parameter, should have the content of the SDK's 'puzzles' folder).

# .loadSceneWithLogic (url, logicURL) : null

# .onEditorLoad () : null

# .onError (error) : null

A callback, called when an error is occured during the loading process. Some specific errors with the following names are also generated:

EditorLoadError - the Puzzles Editor wasn't properly loaded
LogicLoadError - the logic file wasn't properly loaded
SceneLoadError - the scene file wasn't properly loaded

Prints all errors in the browser console by default.

# .onLoadFinished (sceneLoaded, logicLoaded, editorLoaded) : null

A callback, called when all loading actions are finsihed successfully or not, which is indicated by its parameters: sceneLoaded, logicLoaded and editorLoaded. By default calls the .run method if a scene was loaded.