Navigation Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
| Inherits: | Node |
Warning
3D navigation feature is experimental and not recommended for production use.
This class contains functions that enable to get or change parameters of a navigation area within which pathfinding is performed. The navigation area can be either a navigation sector or a navigation mesh.
For example, by using the functions of this class, you can scale velocity of the point moving inside the navigation area. Or you can change the danger factor of the area.
See Also#
- Articles of the Navigation Area section
- A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/paths/ folder
Navigation Class
Members
void setDangerous ( float dangerous ) #
Sets the danger factor that indicates if the point that moves inside the navigation area should try to avoid this area.Notice
If the danger factor exceeds the maximum danger factor set for the route, the navigation area will be excluded from pathfinding calculations.
Arguments
- float dangerous - Danger factor.
float getDangerous ( ) #
Returns the current danger factor that indicates if the point that moves inside the navigation area should try to avoid this area.Notice
If the danger factor exceeds the maximum danger factor set for the route, the navigation area will be excluded from pathfinding calculations.
Return value
The danger factor.Navigation getNavigation ( int num ) #
Returns the specified connected navigation area.Arguments
- int num - The navigation area number.
Return value
The navigation area.Navigation getNavigation ( ) #
Returns the specified connected navigation area.Return value
The navigation area.void setNavigationMask ( int mask ) #
Sets a navigation mask for the navigation area. The navigation mask of the navigation area must match the navigation mask of the route that is calculated within it. Otherwise, the area will not participate in pathfinding. By using the navigation mask, you can specify navigation ares that must be ignored during pathfinding.Arguments
- int mask - An integer value, each bit of which is used to set a mask.
int getNavigationMask ( ) #
Returns the current navigation mask of the navigation area. The navigation mask of the navigation area must match the navigation mask of the route that is calculated within it. Otherwise, the area will not participate in pathfinding.Return value
An integer value, each bit of which is used to set a mask.int getNumNavigations ( ) #
Returns the number of navigation areas that intersect the current one.Return value
The number of connected navigation areas.void setQuality ( int quality ) #
Sets a quality of optimization of the route that has already been calculated. This value specifies the number of iterations that are used for taking the short cut. However, the higher the value, the longer the route calculation will take.Arguments
- int quality - A quality value. If a negative value is provided, 0 will be used instead.
int getQuality ( ) #
Returns the quality of optimization of the route that has already been calculated. The quality value specifies the number of iterations that are used for taking the short cut.Return value
The quality value.void setVelocity ( float velocity ) #
Sets a scaling factor for velocity of the point that moves inside the navigation area along the calculated route.Arguments
- float velocity - A velocity scaling factor.
float getVelocity ( ) #
Returns the current scaling factor for velocity of the point that moves inside the navigation area along the calculated route.Return value
The velocity scaling factor.int inside ( Navigation navigation ) #
Arguments
- Navigation navigation
int inside2D ( Vec3 point, float radius ) #
Depending on the type of the navigation area, the function performs the following:- For navigation sectors, it checks whether the given point is inside the navigation sector. The height of the navigation sector (Z coordinate) is ignored.
- For navigation meshes, it checks whether the given point is inside the navigation mesh and the distance from the point to the mesh is in range [-height;height]. Here height is a height of the navigation mesh.
Arguments
- Vec3 point - Point coordinates.
- float radius - The radius of the point. The radius is used to exclude exceeding the navigation mesh by the point.
If the radius is set, it is more likely that the point will be inside the navigation mesh.
NoticeWhen calling the function for NavigationSector, this option is irrelevant.
Return value
1 if the point is inside the navigation area; otherwise, 0.int inside3D ( Vec3 point, float radius ) #
Depending on the type of the navigation area, the function performs the following:- For navigation sectors, it checks whether the given point is inside the navigation area. Notice that the height of the navigation sector (Z coordinate) is also taken into account.
- For navigation meshes, it checks whether the given point is inside the navigation mesh and the distance from the point to the mesh is in range [0;height]. Here height is a height of the navigation mesh.
Arguments
- Vec3 point - Point coordinates.
- float radius - The radius of the point. The radius is used to exclude exceeding the navigation mesh by the point.
If the radius is set, it is more likely that the point will be inside the navigation mesh.
NoticeWhen calling the function for NavigationSector, this option is irrelevant.
Return value
1 it the point is inside the navigation area; otherwise, 0.Last update:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)