WorldExternBase Class
UnigineScript is deprecated and will be removed in future releases. Please consider using C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt is not guaranteed, as the current level of support assumes only fixing critical issues.
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.WorldExtern getWorldExtern ( ) #
Returns the WorldExtern smart pointer.Return value
WorldExtern smart pointer.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 preRender ( float ifps ) #
Arguments
- float ifps
void renderHandler ( ) #
Renders the handler for the external world.void renderVisualizer ( ) #
Renders the visualizer.You should enable the engine visualizer by the show_visualizer 1 console command.
int restoreState ( Stream stream ) #
Restores a world state from the stream.This function is deprecated and will be removed in the next release.
Arguments
- Stream stream - Stream smart pointer.
Return value
1 if the world state was successfully restored; otherwise, 0.int saveState ( Stream stream ) #
Saves a world state into the stream.This function is deprecated and will be removed in the next release.
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
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:
2020-04-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)