Unigine.World Class
This class provides functionality for the world script. It contains methods required for loading the world with all its nodes, managing a spatial tree and handling nodes collisions and intersections.
Loading of nodes on demand is managed via the AsyncQueue Class.
Notice
C++ methods running editor script functions are described in the Engine class reference.
See also#
- AsyncQueue Class to manage loading nodes and other resources on demand.
- The Intersections article demonstrating how to use intersection-related functions
World Class
Enums
CALLBACK_INDEX#
| Name | Description |
|---|---|
| PRE_WORLD_LOAD = 0 | Callback to be fired before loading the world. |
| POST_WORLD_LOAD = 1 | Callback to be fired after loading the world. |
| PRE_WORLD_SAVE = 2 | Callback to be fired before saving the world. |
| POST_WORLD_SAVE = 3 | Callback to be fired after saving the world. |
| PRE_WORLD_CLEAR = 4 | Callback to be fired before clearing the world: either closing the current world or preparing to load the next world. This callback always takes place in Engine::swap(), i.e. in the end of the frame. |
| POST_WORLD_CLEAR = 5 | Callback to be fired after clearing the world. |
| PRE_NODE_SAVE = 6 | Callback to be fired before calling the World::saveNode() method. |
| POST_NODE_SAVE = 7 | Callback to be fired after calling the World::saveNode() method. |
| PRE_WORLD_INIT = 8 | Callback to be fired before calling all WorldLogic::init() methods. |
| POST_WORLD_INIT = 9 | Callback to be fired after calling all WorldLogic::init() methods.
Notice
Forced closing of the Engine should be disabled with the -auto_quit 0 command-line option. |
| PRE_WORLD_SHUTDOWN = 10 | Callback to be fired before calling all WorldLogic::shutdown() methods. |
| POST_WORLD_SHUTDOWN = 11 | Callback to be fired after calling all WorldLogic::shutdown() methods. |
Properties
bool UnpackNodeReferences#
The value indicating if automatic unpacking of node references at run time is enabled. This option can be used to simplify hierarchy management, as when it is enabled all nodes contained in node references will be present in the world hierarchy. When disabled you have to check the hierarchy of each node reference individually (e.g. to find the number of children or manage some of them). The content of NodeReference nodes is unpacked only at run time and does not affect your *.world and *.node files. So, you can use all advantages of node references when building worlds in the UnigineEditor and manage a clear and straightforward hierarchy at run time.
Notice
This option is available only via code, can be enabled in the System Script and works for all worlds used in your project.
Notice
Auto-unpacking is enabled in C# projects by default.
bool AutoReloadNodeReferences#
The value indicating if automatic reloading of nodereferences is enabled. if enabled all NodeReference nodes will reload their *.node files, when the saveNode() method is called.
Notice
This option can be used if you modify and save reference nodes at runtime. Otherwise you'll have to manually update pointers for all NodeReferences referring to the changed node.
float UpdateGridSize#
The current size of the grid to be used for spatial tree update. the default value is an average one, and can be adjusted when necessary depending on the scene.
float Distance#
The distance, at which (and farther) nothing will be rendered or simulated.
float Budget#
The value of the world generation budget for grass and clutter objects. new objects are not created when time is out of the budget.
bool IsLoaded#
The value indicating if the current world is fully loaded.
string ScriptName#
The name of the world script file *.usc.
string Path#
The current path to the *.world-file where the world is stored.
bool ScriptExecute#
The value indicating if the world script (*.usc file) associated with the world should be executed.
string PhysicsSettings#
The name of the *.physics file containing default physics settings currently used by the world.
string SoundSettings#
The name of the *.sound file containing default sound settings currently used by the world.
string RenderSettings#
The name of the *.render file containing default render settings currently used by the world.
string LoadWorldRequestPath#
The path to the world to be loaded.
bool IsLoadWorldRequested#
The value indicating if another world is going to be loaded in the next frame.
Members
bool GetCollision ( WorldBoundBox bb, Object[] objects ) #
Searches for all collider objects within a given bounding box.Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- WorldBoundBox bb - Bounding box.
- Object[] objects - Array with collider objects' smart pointers.
Return value
1 if collider objects are found; otherwise, 0.bool GetCollision ( WorldBoundSphere bs, Object[] objects ) #
Searches for all collider objects within a given bounding sphere.Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- WorldBoundSphere bs - Bounding sphere.
- Object[] objects - Array with collider objects' smart pointers.
Return value
1 if collider objects are found; otherwise, 0.bool GetCollision ( vec3 p0, vec3 p1, Object[] objects ) #
Performs tracing from the p0 point to the p1 point to find all collider objects intersected by the line. This function detects intersection with surfaces (polygons) of mesh and terrain objects.
Collisions with the surface can be found only if the following conditions are fulfilled:
- The surface is enabled.
- Per-surface Collision flag is enabled.
- The surface has a material assigned.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- vec3 p0 - The start point coordinates.
- vec3 p1 - The end point coordinates.
- Object[] objects - Array with collider objects' smart pointers.
Return value
1 if collider objects are found; otherwise, 0.void SetData ( string name, string data ) #
Sets user data associated with the world with the specified key. In the *.world file, the data is set in the data tag with the specified key.Arguments
- string name - String containing a key identifying user data to be stored in the *.world file.NoticeThe "editor_data" key is reserved for the UnigineEditor.
- string data - New user data.
string GetData ( string name ) #
Returns user string data associated with the world by the specified key. This string is written directly into the data tag of the *.world file with the specified key.Arguments
- string name - String containing a key identifying user data stored in the *.world file.NoticeThe "editor_data" key is reserved for the UnigineEditor.
Return value
User string data.Object GetIntersection ( vec3 p0, vec3 p1, int mask ) #
Performs tracing from the p0 point to the p1 point to find the first object intersected by the line. This function detects intersection with surfaces (polygons) of meshes. An intersection can be found only if an object has a matching intersection mask.
Intersections with the surface can be found only if the following conditions are fulfilled:
- The surface is enabled.
- Per-surface Intersection flag is enabled.
- The surface has a material assigned.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- vec3 p0 - Line start point coordinates.
- vec3 p1 - Line end point coordinates.
- int mask - Intersection mask. If 0 is passed, the function will return NULL.
Return value
Intersected object.Object GetIntersection ( vec3 p0, vec3 p1, int mask, Node[] exclude ) #
Performs tracing from the p0 point to the p1 point to find the first object intersected by the line (except for the ones passed in the exclude list). This function detects intersection with surfaces (polygons) of meshes. An intersection can be found only if an object has a matching intersection mask.
Intersections with the surface can be found only if the following conditions are fulfilled:
- The surface is enabled.
- Per-surface Intersection flag is enabled.
- The surface has a material assigned.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- vec3 p0 - Line start point coordinates.
- vec3 p1 - Line end point coordinates.
- int mask - Intersection mask. If 0 is passed, the function will return NULL.
- Node[] exclude - List of nodes to be ignored when searching for intersection by the traced line.
Return value
The first intersected object found at the line (except for the ones passed in the exclude list); nullptr if there was no intersection.Object GetIntersection ( vec3 p0, vec3 p1, int mask, WorldIntersection intersection ) #
Performs tracing from the p0 point to the p1 point to find the first object intersecting the line. This function detects intersection with surfaces (polygons) of meshes. An intersection can be found only if an object is matching the intersection mask.
Intersections with the surface can be found only if the following conditions are fulfilled:
- The surface is enabled.
- Per-surface Intersection flag is enabled.
- The surface has a material assigned.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- vec3 p0 - Coordinates of the line start point.
- vec3 p1 - Coordinates of the line end point.
- int mask - Intersection mask. If 0 is passed, the function will return NULL.
- WorldIntersection intersection - WorldIntersection object to be filled.
Return value
First intersected object.Object GetIntersection ( vec3 p0, vec3 p1, int mask, WorldIntersectionNormal intersection ) #
Performs tracing from the p0 point to the p1 point to find the first object intersecting the line. This function detects intersection with surfaces (polygons) of meshes. An intersection can be found only if an object is matching the intersection mask.
Intersections with the surface can be found only if the following conditions are fulfilled:
- The surface is enabled.
- Per-surface Intersection flag is enabled.
- The surface has a material assigned.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- vec3 p0 - Coordinates of the line start point.
- vec3 p1 - Coordinates of the line end point.
- int mask - Intersection mask. If 0 is passed, the function will return NULL.
- WorldIntersectionNormal intersection - WorldIntersectionNormal object to be filled.
Return value
First intersected object.Object GetIntersection ( vec3 p0, vec3 p1, int mask, WorldIntersectionTexCoord intersection ) #
Performs tracing from the p0 point to the p1 point to find the first object intersecting the line. This function detects intersection with surfaces (polygons) of meshes. An intersection can be found only if an object is matching the intersection mask.
Intersections with the surface can be found only if the following conditions are fulfilled:
- The surface is enabled.
- Per-surface Intersection flag is enabled.
- The surface has a material assigned.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- vec3 p0 - Coordinates of the line start point.
- vec3 p1 - Coordinates of the line end point.
- int mask - Intersection mask. If 0 is passed, the function will return NULL.
- WorldIntersectionTexCoord intersection - WorldIntersectionTexCoord object to be filled.
Return value
First intersected object.Object GetIntersection ( vec3 p0, vec3 p1, int mask, Node[] exclude, WorldIntersection intersection ) #
Performs tracing from the p0 point to the p1 point to find the first object intersecting the line. This function detects intersection with surfaces (polygons) of meshes. An intersection can be found only if an object is matching the intersection mask.
Intersections with the surface can be found only if the following conditions are fulfilled:
- The surface is enabled.
- Per-surface Intersection flag is enabled.
- The surface has a material assigned.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- vec3 p0 - Coordinates of the line start point.
- vec3 p1 - Coordinates of the line end point.
- int mask - Intersection mask. If 0 is passed, the function will return NULL.
- Node[] exclude - The list of nodes to be excluded.
- WorldIntersection intersection - WorldIntersection object to be filled.
Return value
First intersected object.Object GetIntersection ( vec3 p0, vec3 p1, int mask, Node[] exclude, WorldIntersectionNormal intersection ) #
Performs tracing from the p0 point to the p1 point to find the first object intersecting the line. This function detects intersection with surfaces (polygons) of meshes. An intersection can be found only if an object is matching the intersection mask.
Intersections with the surface can be found only if the following conditions are fulfilled:
- The surface is enabled.
- Per-surface Intersection flag is enabled.
- The surface has a material assigned.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- vec3 p0 - Coordinates of the line start point.
- vec3 p1 - Coordinates of the line end point.
- int mask - Intersection mask. If 0 is passed, the function will return NULL.
- Node[] exclude - The list of nodes to be excluded.
- WorldIntersectionNormal intersection - WorldIntersectionNormal object to be filled.
Return value
First intersected object.Object GetIntersection ( vec3 p0, vec3 p1, int mask, Node[] exclude, WorldIntersectionTexCoord intersection ) #
Performs tracing from the p0 point to the p1 point to find the first object intersected by the line. This function detects intersection with surfaces (polygons) of meshes. An intersection can be found only if an object is matching the intersection mask.
Intersections with the surface can be found only if the following conditions are fulfilled:
- The surface is enabled.
- Per-surface Intersection flag is enabled.
- The surface has a material assigned.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- vec3 p0 - Coordinates of the line start point.
- vec3 p1 - Coordinates of the line end point.
- int mask - Intersection mask. If 0 is passed, the function will return NULL.
- Node[] exclude - The list of nodes to be excluded.
- WorldIntersectionTexCoord intersection - WorldIntersectionTexCoord object to be filled.
Return value
First intersected object.bool GetIntersection ( vec3 p0, vec3 p1, Object[] objects ) #
Performs tracing from the p0 point to the p1 point to find objects intersected by the line. This function detects intersection with objects' bounds.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- vec3 p0 - Coordinates of the line start point.
- vec3 p1 - Coordinates of the line end point.
- Object[] objects - Array of intersected objects.
Return value
true if intersections are found; otherwise, false.bool GetIntersection ( WorldBoundBox bb, Object[] objects ) #
Searches for intersections with objects that are found in a given bounding box.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- WorldBoundBox bb - Bounding box where intersection search will be performed.
- Object[] objects - Array of intersected objects.
Return value
true if intersections are found; otherwise, false.bool GetIntersection ( WorldBoundBox bb, Node[] nodes ) #
Searches for intersections with nodes that are found in a given bounding box.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- WorldBoundBox bb - Bounding box where intersection search will be performed.
- Node[] nodes - Array of intersected nodes.
Return value
true if intersections are found; otherwise, false.bool GetIntersection ( WorldBoundBox bb, Node.TYPE type, Node[] nodes ) #
Searches for intersections with specified type of nodes that are found in a given bounding box.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- WorldBoundBox bb - Bounding box where intersection search will be performed.
- Node.TYPE type - Node type filter. Only the nodes of the specified type will be checked.
- Node[] nodes - Array of intersected nodes.
Return value
true if intersections are found; otherwise, false.bool GetIntersection ( WorldBoundSphere bs, Object[] objects ) #
Searches for intersections with objects that are found in a given bounding sphere.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- WorldBoundSphere bs - Bounding sphere where intersection search will be performed.
- Object[] objects - Array of intersected objects.
Return value
true if intersections are found; otherwise, false.bool GetIntersection ( WorldBoundSphere bs, Node[] nodes ) #
Searches for intersections with nodes that are found in a given bounding sphere.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- WorldBoundSphere bs - Bounding sphere where intersection search will be performed.
- Node[] nodes - Array of intersected nodes.
Return value
true if intersections are found; otherwise, false.bool GetIntersection ( WorldBoundSphere bs, Node.TYPE type, Node[] nodes ) #
Searches for intersections with nodes of the specified type that are found in a given bounding sphere.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- WorldBoundSphere bs - Bounding sphere where intersection search will be performed.
- Node.TYPE type - Node type filter. Only the nodes of the specified type will be checked.
- Node[] nodes - Array of intersected nodes.
Return value
true if intersections are found; otherwise, false.bool GetIntersection ( WorldBoundFrustum bf, Object[] objects ) #
Searches for intersections with Objects that are found in a given bounding frustum. This method catches all objects independent of their visibility (i.e., if an object is disabled, any of its LODs are disabled, or it is out of the visibility distance range, but is located within the bounding frustum, the intersection shall be detected). To check for intersections while taking into account the visibility aspect, use getVisibleIntersection(). Check the usage example applying this method.
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- WorldBoundFrustum bf - Bounding frustum where intersection search will be performed.
- Object[] objects - Array of intersected objects.
Return value
true if intersections are found; otherwise, false.bool GetIntersection ( WorldBoundFrustum bf, Node.TYPE type, Node[] nodes ) #
Searches for intersections with nodes of the specified type that are found in a given bounding frustum. This method catches all nodes of the specified type independent of their visibility (i.e., if an object is disabled, any of its LODs are disabled, or it is out of the visibility distance range, but is located within the bounding frustum, the intersection shall be detected). To check for intersections while taking into account the visibility aspect, use getVisibleIntersection().
Notice
As a new node becomes a part of the BSP tree only after the updateSpatial() method is called (the engine calls the method automatically each frame after the world script update() code is executed), all engine subsystems can process this node only in the next frame. If you need to get the node in the very first frame, call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
Arguments
- WorldBoundFrustum bf - Bounding frustum where intersection search will be performed.
- Node.TYPE type - Node type filter. Only the nodes of the specified type will be checked.
- Node[] nodes - Array of intersected nodes.
Return value
true if intersections are found; otherwise, false.bool GetVisibleIntersection ( vec3 camera, WorldBoundFrustum bf, Object[] objects, float max_distance ) #
Searches for intersections with objects inside a given bounding frustum that are visible to the specified camera position, i.e. either of its LODs is within the visibility distance distance. Unlike the getIntersection() method, this one takes the "visibility" concept into account (hidden objects or the ones that are too far away won't be found). Check this usage example for more details.Arguments
- vec3 camera - Position of the camera from which the visibility distance to objects is checked.
- WorldBoundFrustum bf - Bounding frustum inside which intersection search is performed.
- Object[] objects - Array of intersected objects.
- float max_distance - Maximum visibility distance for objects, in units. If the distance from the specified camera position to an object exceeds this limit, the intersection is not registered even if the node is within the specified bounding frustum.
Return value
true if at least one intersection is found; otherwise, false.bool GetVisibleIntersection ( vec3 camera, WorldBoundFrustum bf, Node.TYPE type, Node[] nodes, float max_distance ) #
Searches for intersections with nodes inside a given bounding frustum that are visible to the specified camera position, i.e. either of its LODs is within the visibility distance distance. Unlike the getIntersection() method, this one takes the "visibility" concept into account (hidden nodes or the ones that are too far away won't be found). Check this usage example for more details.
Notice
This method can be used only for nodes inherited from the Object class, i.e. they have sufraces that store LOD and visibility distance data.
Arguments
- vec3 camera - Position of the camera from which the visibility distance to nodes is checked.
- WorldBoundFrustum bf - Bounding frustum inside which intersection search is performed.
- Node.TYPE type - Node type (one of the NODE_* variables); set it to -1 if you won't use this filter.
- Node[] nodes - Array of intersected nodes.
- float max_distance - Maximum visibility distance for nodes, in units. If the distance from the specified camera position to a node exceeds this limit, the intersection is not registered even if the node is within the specified bounding frustum.
Return value
true if at least one intersection is found; otherwise, false.bool LoadWorld ( string path ) #
Loads a world from the specified file path and replaces the current world with it. The world is not loaded immediately — loading starts at the beginning of the next frame, while the current world is unloaded at the end of the current frame.Arguments
- string path - Path to the file describing the world.
Return value
true if the world is loaded successfully; otherwise, false.bool LoadWorld ( string path, bool partial_path ) #
Loads a world from the specified file path and replaces the current world with it. The world is not loaded immediately — loading starts at the beginning of the next frame, while the current world is unloaded at the end of the current frame.Arguments
- string path - Path to the file describing the world.
- bool partial_path - true if the path to the world file is partial; or false if it is a full path.
Return value
true if the world is loaded successfully; otherwise, false.bool LoadWorldForce ( string path ) #
Loads a world from the specified file path and replaces the current world with it. The world is loaded immediately, breaking the Execution Sequence, therefore should be used either before Engine::update() or after Engine::swap(). If called in Engine::update(), the Execution Sequence will be as follows: update() before calling loadWorldForce(), loadWorldForce(), shutdown(), continuation of update() from the place of interruption, postUpdate(), swap(), init(), etc. This function is recommended for the Editor-related use.Arguments
- string path - Path to the file describing the world.
Return value
true if the world is loaded successfully; otherwise, false.bool LoadWorldForce ( string path, bool partial_path ) #
Loads a world from the specified file path and replaces the current world with it. The world is loaded immediately, breaking the Execution Sequence, therefore should be used either before Engine::update() or after Engine::swap(). If called in Engine::update(), the Execution Sequence will be as follows: update() before calling loadWorldForce(), loadWorldForce(), shutdown(), continuation of update() from the place of interruption, postUpdate(), swap(), init(), etc. This function is recommended for the Editor-related use.Arguments
- string path - Path to the file describing the world.
- bool partial_path - true if the path to the world file is partial; or false if it is a full path.
Return value
true if the world is loaded successfully; otherwise, false.bool SaveWorld ( ) #
Saves the world.Return value
true, if the world has been saved successfully; otherwise false.bool SaveWorld ( string path ) #
Saves the world to the specified location.Arguments
- string path - Path to where the world is going to be saved.
Return value
true, if the world has been saved successfully; otherwise false.bool ReloadWorld ( ) #
Reloads the world.Return value
true, if the world has been reloaded successfully; otherwise false.bool QuitWorld ( ) #
Closes the world.Return value
true, if the world has been quit successfully; otherwise false.bool IsLoadWorldRequested ( ) #
Returns a value indicating if another world is going to be loaded in the next frame.Return value
true, if another world is going to be loaded in the next frame.string GetLoadWorldRequestPath ( ) #
Returns the path to the world which is going to be loaded.Return value
The path to the world to be loaded.int AddWorld ( string name ) #
Loads a world from a file and adds it to the current world.Arguments
- string name - Name of the file describing the world.
Return value
1 if the world is loaded and added successfully; otherwise, 0.void SetPhysicsSettings ( string settings ) #
Sets the name of the *.physics file containing default physics settings to be used for the world.Arguments
- string settings - Name of the default *.physics asset to be used for the world.
string GetPhysicsSettings ( ) #
Returns the name of the *.physics file containing default physics settings currently used by the world.Return value
Name of the default *.physics asset used for the world.void SetRenderSettings ( string settings ) #
Sets the name of the *.render file containing default render settings to be used for the world.Arguments
- string settings - Name of the default *.render asset to be used for the world.
string GetRenderSettings ( ) #
Returns the name of the *.render file containing default render settings currently used by the world.Return value
Name of the default *.render asset used for the world.void SetSoundSettings ( string settings ) #
Sets the name of the *.sound file containing default sound settings to be used for the world.Arguments
- string settings - Name of the default *.sound asset to be used for the world.
string GetSoundSettings ( ) #
Returns the name of the *.sound file containing default sound settings currently used by the world.Return value
Name of the default *.sound asset used for the world.bool IsNode ( int id ) #
Checks if a node with a given ID exists in the world.Arguments
- int id - Node ID.
Return value
true if the node with the given ID exists; otherwise, false.void GetNodes ( Node[] nodes ) #
Returns all instances of all nodes (either loaded from the *.world file or created dynamically at run time), including cache, Node Reference internals, etc.Notice
If you need only root nodes to be returned, use getRootNodes() instead
Arguments
- Node[] nodes - Array with node smart pointers.
int ClearNode ( string name ) #
Clears cached nodes of the given node file.When the node is cached and you try to access it, take into account the following:
- if the node was loaded by the name — the node gets stored in the cache by its name;
- if the node was loaded from the parent node reference — the node is stored in the cache by its GUID.
Source code (C#)
Node node = World.LoadNode(file_name);
// change something in the node...
World.SaveNode(file_name, node);
// clear cache by the name
World.ClearNode(file_name);
// clear cache by the GUID (if this node is inside another node reference)
World.ClearNode("guid://" + FileSystem.GetGUID("file_name").GetString());
// reload the node
node.DeleteForce();
node = World.LoadNode(file_name);Arguments
- string name - Path to the *.node file.
Return value
1 if the cache is cleared successfully; otherwise, 0.Node LoadNode ( string name, int cache = 1 ) #
Loads a node (or a hierarchy of nodes) from a .node / .fbx file. If the node is loaded successfully, it is managed by the current world (its Lifetime is World).Cached nodes remain in the memory. If you don't intend to load more node references from a certain .node asset, set the cache argument to 0 or you can delete cached nodes from the list of world nodes afterwards by using the clearNode() method.
Arguments
- string name - Path to the *.node file.
- int cache - 1 to use caching of nodes, 0 not to use.
Return value
Loaded node; NULL if the node cannot be loaded.int LoadNodes ( string name, Node[] nodes ) #
Loads nodes from a file.Arguments
- string name - Path to the *.node file.
- Node[] nodes - Array of nodes' smart pointers to which the loaded nodes are appended.
Return value
1 if the nodes are loaded successfully; otherwise, 0.int SaveNode ( string name, Node node, int binary = 0 ) #
Saves a given node to a file with due regard for its local transformation.Arguments
- string name - Path to the *.node file.
- Node node - Pointer to the node to save.
- int binary - If set to 1, the node is saved to the binary *.xml. This file cannot be read, but using it speeds up the saving of the node and requires less disk space.
Return value
1 if the node is saved successfully; otherwise, 0.int SaveNodes ( string name, Node[] nodes, int binary = 0 ) #
Saves nodes to a file.Arguments
- string name - Path to the *.node file.
- Node[] nodes - Array of nodes' smart pointers to be saved.
- int binary - If set to 1, the node is saved to the binary *.xml. This file cannot be read, but using it speeds up the saving of the node and requires less disk space.
Return value
1 if the nodes are saved successfully; otherwise, 0.void UpdateSpatial ( ) #
Updates the node BSP (binary space partitioning) tree.
The engine calls this method automatically each frame after the world script update() code is executed. As a new node becomes a part of the BSP tree only after this method is called, all engine subsystems (renderer, physics, sound, pathfinding, collisions, intersections, etc.) can process this node only in the next frame. If you need the subsystem to process the node in the very first frame, you can call the updateSpatial() method manually. The engine will call this method automatically after the update() code is executed anyways.
void SetScriptExecute ( bool execute ) #
Sets a value indicating if a logic script associated with the world is to be loaded with it.Arguments
- bool execute - true - to load the world along with the associated logic script (if any), false - to ignore it.
bool IsScriptExecute ( ) #
Returns a value indicating if a logic script associated with the world is to be loaded with it.Return value
true if a logic script associated with the world is to be loaded with it; otherwise, false.Node GetNodeByID ( int node_id ) #
Returns a node by its identifier if it exists.Arguments
- int node_id - Node ID.
Return value
Node, if it exists in the world; otherwise, null.Node GetNodeByName ( string name ) #
Returns a node by its name if it exists. If the world contains multiple nodes having the same name, only the first one found shall be returned. To get all nodes having the same name, use the getNodesByName() method.Notice
method filters out isolated node hierarchies and cache nodes, so it does not return nodes having a possessor (NodeReference / Clutter / Cluster) among its predecessors or nodes from cache.
Arguments
- string name - Node name.
Return value
Node, if it exists in the world; otherwise, null.void GetNodesByName ( string name, Node[] nodes ) #
Generates a list of nodes in the world with a given name and puts it to nodes.Arguments
- string name - Node name.
- Node[] nodes - List of nodes with the given name (if any); otherwise, null.
Node GetNodeByType ( int type ) #
Returns the first node of the specified type in the world. Hidden and system nodes are ignored.Arguments
- int type - Node type identifier, one of the NODE_* values.
Return value
First node of the specified type, if it exists in the world; otherwise, null.void GetNodesByType ( int type, Node[] nodes ) #
Generates a list of nodes of the specified type in the world and puts it to nodes. Hidden and system nodes are ignored.Arguments
- int type - Node type identifier, one of the NODE_* values.
- Node[] nodes - List of nodes of the given type (if any); otherwise, null.
bool IsNode ( string name ) #
Checks if a node with a given name exists in the world.Arguments
- string name - Node name.
Return value
true if a node with the specified name exists in the world; otherwise, false.void ClearBindings ( ) #
Clears internal buffers with pointers and instances. This function is used for proper cloning of objects with hierarchies, for example, bodies and joints. Should be called before cloning.void GetRootNodes ( Node[] nodes ) #
Gets all root nodes in the world hierarchy and puts them to nodes. Doesn't include cached nodes.Arguments
- Node[] nodes - Array, to which all root nodes of the world hierarchy are to be put.
int GetRootNodeIndex ( Node node ) #
Returns the index for the specified root node, that belongs to the world hierarchy.Arguments
- Node node - Root node, for which an index is to be obtained.
Return value
Index of the specified root node if it exists; otherwise, -1.void SetRootNodeIndex ( Node node, int index ) #
Sets a new index for the specified root node, that belongs to the world hierarchy.Arguments
- Node node - Root node, for which a new index is to be set.
- int index - New index to be set for the specified root node.
IntPtr AddCallback ( int callback, CallbackDelegate func ) #
Adds a callback of the specified type. Callback functions can be used to determine actions to be performed when the world is loaded, saved, or cleared. The signature of the callback function must be as follows:Source code (C++)
void callback_function_name(const char *world_path);Arguments
- int callback - Callback type. One of the CALLBACK_* variables.
- CallbackDelegate func - Callback function with the following signature: void CallbackDelegate(string world_path)
Return value
ID of the last added callback of the specified type, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.IntPtr AddCallback ( int callback, CallbackDelegate func ) #
Adds a callback of the specified type. This method adds a callback function to be used to determine actions to be performed when a node in the world is saved. The signature of the callback function must be as follows:Source code (C++)
void callback_function_name(const char *world_path, NodePtr node);Arguments
- int callback - Callback type. One of the CALLBACK_* variables.
- CallbackDelegate func - Callback function with the following signature: void CallbackDelegate(string world_path, Node node)
Return value
ID of the last added callback of the specified type, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.bool RemoveCallback ( int callback, IntPtr id ) #
Removes the specified callback from the list of callbacks of the specified type. Callback functions can be used to determine actions to be performed when the world is loaded, saved, or cleared.Arguments
- int callback - Callback type. One of the CALLBACK_* variables.
- IntPtr id - Callback ID obtained when adding it.
Return value
True if the callback with the given ID was removed successfully; otherwise false.void ClearCallbacks ( int callback ) #
Clears all added callbacks of the specified type. Callback functions can be used to determine actions to be performed when the world is loaded, saved, or cleared.Arguments
- int callback - Callback type. One of the CALLBACK_* variables.
Last update:
2022-12-27
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)