Unigine::WorldLogic Class

WorldLogic Class

Members

---

int init( )

Engine calls this function on world initialization and initializes resources for a world scene during the world start. Similar to the world script's init() function.

Return value

Returns 1 if there were no errors; otherwise, 0.

int shutdown( )

Engine calls this function on world shutdown. Here you can delete resources that were created during world script execution to avoid memory leaks. Similar to the world script's shutdown() function.

Return value

Returns 1 if there were no errors; otherwise, 0.

int destroy( )

Engine calls this function when the video mode is changed or application is restarted (video_restart is called). It is used to destroy all created resources (e.g. dynamic textures, etc.) to avoid crashes due to invalid pointers, when the context is re-initialized. Similar to the world script's destroy() function.

Return value

Returns 1 if there were no errors; otherwise, 0.

int update( )

Engine calls this function before updating each render frame. You can specify here all logic-related functions you want to be called every frame while your application executes. Similar to the world script's update() function.

Return value

Returns 1 if there were no errors; otherwise, 0.

int render( )

Engine calls this function before rendering each render frame. You can correct behavior after the state of the node has been updated. Similar to the world script's render() function.

Return value

Returns 1 if there were no errors; otherwise, 0.

int flush( )

Engine calls this function before updating each physics frame. This function is used to control physics in your application. The engine calls flush() with the fixed rate (60 times per second by default) regardless of the fps number. Similar to the world script's flush() function.

Return value

Returns 1 if there were no errors; otherwise, 0.

int save( const StreamPtr & stream )

Engine calls this function when the world is saving its state (state_save is called). Here you can save custom user data to a file. Similar to the world script's save() function.

Arguments

• const StreamPtr & stream - Data stream.

Return value

Returns 1 if there were no errors; otherwise, 0.

int restore( const StreamPtr & stream )

Engine calls this function when the world is restoring its state (state_restore is called). Restore custom user data to a file here. Similar to the world script's restore() function.

Arguments

• const StreamPtr & stream - Stream for restored data.

Return value

Returns 1 if there were no errors; otherwise, 0.