This page has been translated automatically.
Programming
Fundamentals
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

WorldExternBase Class

Inherits:Base

The base class, from which the custom user-defined worlds are inherited.

WorldExternBase Class

Members


int getClassID()

Returns a unique class ID.

Return value

Returns a unique class ID.

Node getNode()

Returns the Node smart pointer.

Return value

Node smart pointer.

int isOwner()

Returns the owner flag of the pointer. If the pointer is owner, on its deletion the object also will be deleted.

Return value

The owner flag.

WorldExtern getWorldExtern()

Returns the WorldExtern smart pointer.

Return value

WorldExtern smart pointer.

void flush(float ifps)

Flush function. It is called when the node is visible.

Arguments

  • float ifps - Inverse FPS value.

void grab()

Sets the owner flag to 1 for the world pointer. The world should not be handled by the class after this function is called.

int loadWorld(Xml xml)

Loads a world state from the Xml.

Arguments

  • Xml xml - Xml smart pointer.

Return value

Returns 1 if the world state was successfully loaded; otherwise, 0.

void release()

Sets the owner flag to 0 for the world pointer. The world should be handled by the class after this function is called.

void renderHandler()

Renders the handler for the external world.

void renderVisualizer()

Renders the visualizer.
Notice
You should enable the engine visualizer by the show_visualizer 1 console command.

int restoreState(Stream stream)

Restores a world state from the stream.

Arguments

  • Stream stream - Stream smart pointer.

Return value

Returns 1 if the world state was successfully restored; otherwise, 0.

int saveState(Stream stream)

Saves a world state into the stream.

Arguments

  • Stream stream - Stream smart pointer.

Return value

Returns 1 if the world state was successfully saved; otherwise, 0.

int saveWorld(Xml xml)

Saves a world state into the Xml.

Arguments

  • Xml xml - Xml smart pointer.

Return value

Returns 1 if the world state was successfully saved; otherwise, 0.

void update(float ifps)

Update function. It is called when the node is visible.

Arguments

  • float ifps - Inverse FPS value.

void updateEnabled()

Updates enabled.

void updatePosition()

Updates a position of the external world.

void updateTransform()

Updates transformation matrix of the external world.
Last update: 2017-07-03
Build: ()