NavigationServer3D

public static Rid AgentCreate();

Creates the agent.

public static bool AgentGetAvoidanceEnabled(Rid agent);

Returns true if the provided agent has avoidance enabled.

public static uint AgentGetAvoidanceLayers(Rid agent);

Returns the avoidance_layers bitmask of the specified agent.

public static uint AgentGetAvoidanceMask(Rid agent);

Returns the avoidance_mask bitmask of the specified agent.

public static float AgentGetAvoidancePriority(Rid agent);

Returns the avoidance_priority of the specified agent.

public static float AgentGetHeight(Rid agent);

Returns the height of the specified agent.

public static Rid AgentGetMap(Rid agent);

Returns the navigation map Rid the requested agent is currently assigned to.

public static int AgentGetMaxNeighbors(Rid agent);

Returns the maximum number of other agents the specified agent takes into account in the navigation.

public static float AgentGetMaxSpeed(Rid agent);

Returns the maximum speed of the specified agent.

public static float AgentGetNeighborDistance(Rid agent);

Returns the maximum distance to other agents the specified agent takes into account in the navigation.

public static bool AgentGetPaused(Rid agent);

Returns true if the specified agent is paused.

public static Vector3 AgentGetPosition(Rid agent);

Returns the position of the specified agent in world space.

public static float AgentGetRadius(Rid agent);

Returns the radius of the specified agent.

public static float AgentGetTimeHorizonAgents(Rid agent);

Returns the minimal amount of time for which the specified agent's velocities that are computed by the simulation are safe with respect to other agents.

public static float AgentGetTimeHorizonObstacles(Rid agent);

Returns the minimal amount of time for which the specified agent's velocities that are computed by the simulation are safe with respect to static avoidance obstacles.

public static bool AgentGetUse3DAvoidance(Rid agent);

Returns true if the provided agent uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z).

public static Vector3 AgentGetVelocity(Rid agent);

Returns the velocity of the specified agent.

public static bool AgentHasAvoidanceCallback(Rid agent);

Return true if the specified agent has an avoidance callback.

public static bool AgentIsMapChanged(Rid agent);

Returns true if the map got changed the previous frame.

public static void AgentSetAvoidanceCallback(Rid agent, Callable callback);

Sets the callback Callable that gets called after each avoidance processing step for the agent. The calculated safe_velocity will be dispatched with a signal to the object just before the physics calculations. Note: Created callbacks are always processed independently of the EntityTree state as long as the agent is on a navigation map and not freed. To disable the dispatch of a callback from an agent use NavigationServer3D.AgentSetAvoidanceCallback again with an empty Callable.

public static void AgentSetAvoidanceEnabled(Rid agent, bool enabled);

If enabled is true, the provided agent calculates avoidance.

public static void AgentSetAvoidanceLayers(Rid agent, uint layers);

Set the agent's avoidance_layers bitmask.

public static void AgentSetAvoidanceMask(Rid agent, uint mask);

Set the agent's avoidance_mask bitmask.

public static void AgentSetAvoidancePriority(Rid agent, float priority);

Set the agent's avoidance_priority with a priority between 0.0 (lowest priority) to 1.0 (highest priority). The specified agent does not adjust the velocity for other agents that would match the avoidance_mask but have a lower avoidance_priority. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent.

public static void AgentSetHeight(Rid agent, float height);

Updates the provided agent height.

public static void AgentSetMap(Rid agent, Rid map);

Puts the agent in the map.

public static void AgentSetMaxNeighbors(Rid agent, int count);

Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe.

public static void AgentSetMaxSpeed(Rid agent, float maxSpeed);

Sets the maximum speed of the agent. Must be positive.

public static void AgentSetNeighborDistance(Rid agent, float distance);

Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe.

public static void AgentSetPaused(Rid agent, bool paused);

If paused is true the specified agent will not be processed. For example, it will not calculate avoidance velocities or receive avoidance callbacks.

public static void AgentSetPosition(Rid agent, Vector3 position);

Sets the position of the agent in world space.

public static void AgentSetRadius(Rid agent, float radius);

Sets the radius of the agent.

public static void AgentSetTimeHorizonAgents(Rid agent, float timeHorizon);

The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. A too high value will slow down agent movement considerably. Must be positive.

public static void AgentSetTimeHorizonObstacles(Rid agent, float timeHorizon);

The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to static avoidance obstacles. The larger this number, the sooner this agent will respond to the presence of static avoidance obstacles, but the less freedom this agent has in choosing its velocities. A too high value will slow down agent movement considerably. Must be positive.

public static void AgentSetUse3DAvoidance(Rid agent, bool enabled);

Sets if the agent uses the 2D avoidance or the 3D avoidance while avoidance is enabled. If true the agent calculates avoidance velocities in 3D for the XYZ axes, e.g. for games that take place in the air, underwater, or space. The 3D agent only avoids other 3D avoidance agents. The 3D agent only reacts to radius based avoidance obstacles. The 3D agent ignores any vertices based obstacles. The 3D agent only avoids other 3D agents. If false the agent calculates avoidance velocities in 2D along the xz-axes ignoring the y-axis. The 2D agent only avoids other 2D avoidance agents. The 2D agent reacts to radius avoidance obstacles. The 2D agent reacts to vertex based avoidance obstacles. The 2D agent only avoids other 2D agents. 2D agents will ignore other 2D agents or obstacles that are below their current position or above their current position including the agent's height in 2D avoidance.

public static void AgentSetVelocity(Rid agent, Vector3 velocity);

Sets velocity as the new wanted velocity for the specified agent. The avoidance simulation will try to achieve this velocity if possible, but will adjust it to avoid colliding with other agents and obstacles. When an agent is teleported to a new position far away, use NavigationServer3D.AgentSetVelocityForced instead to reset the internal velocity state.

public static void AgentSetVelocityForced(Rid agent, Vector3 velocity);

Replaces the internal velocity in the collision avoidance simulation with velocity for the specified agent. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck.

public static void BakeFromSourceGeometryData(NavigationMesh navigationMesh, NavigationMeshSourceGeometryData3D sourceGeometryData, Callable callback = default);

Synchronously bakes supplied source data into a navigation resource. Does not automatically parse the entire level or assign output to a region. Check polygon count, assign the resource and wait for map publication.

public static void BakeFromSourceGeometryDataAsync(NavigationMesh navigationMesh, NavigationMeshSourceGeometryData3D sourceGeometryData, Callable callback = default);

Bakes the provided navigation_mesh with the data from the provided source_geometry_data as an async task running on a background thread. After the process is finished the optional callback will be called.

public static void FreeRid(Rid rid);

Destroys the given RID.

public static bool GetDebugEnabled();

Reads the server debug flag. An enabled flag does not prove geometry is visible: the corresponding Entity types provide standard visualization subject to additional settings.

public static Reckfell.Collections.Array<Rid> GetMaps();

Returns all created navigation map Rids on the NavigationServer. This returns both 2D and 3D created navigation maps as there is technically no distinction between them.

public static int GetProcessInfo(NavigationServer3D.ProcessInfo processInfo);

Reads a 3D server counter. Aggregates cover active maps after server processing, not all allocated RIDs. A disabled region remains in RegionCount while assigned to an active map. This does not measure search time.

public static bool IsBakingNavigationMesh(NavigationMesh navigationMesh);

Returns true when the provided navigation mesh is being baked on a background thread.

public static Rid LinkCreate();

Create a new link between two positions on a map.

public static bool LinkGetEnabled(Rid link);

Returns true if the specified link is enabled.

public static Vector3 LinkGetEndPosition(Rid link);

Returns the ending position of this link.

public static float LinkGetEnterCost(Rid link);

Returns the enter cost of this link.

public static uint LinkGetIterationId(Rid link);

Returns the current iteration ID of the navigation link. Every time the navigation link changes and synchronizes, the iteration ID increases. An iteration ID of 0 means the navigation link has never synchronized. Note: The iteration ID will wrap around to 1 after reaching its range limit.

public static Rid LinkGetMap(Rid link);

Returns the navigation map Rid the requested link is currently assigned to.

public static uint LinkGetNavigationLayers(Rid link);

Returns the navigation layers for this link.

public static ulong LinkGetOwnerId(Rid link);

Returns the ObjectID of the object which manages this link.

public static Vector3 LinkGetStartPosition(Rid link);

Returns the starting position of this link.

public static float LinkGetTravelCost(Rid link);

Returns the travel cost of this link.

public static bool LinkIsBidirectional(Rid link);

Returns whether this link can be travelled in both directions.

public static void LinkSetBidirectional(Rid link, bool bidirectional);

Sets whether this link can be travelled in both directions.

public static void LinkSetEnabled(Rid link, bool enabled);

If enabled is true, the specified link will contribute to its current navigation map.

public static void LinkSetEndPosition(Rid link, Vector3 position);

Sets the exit position for the link.

public static void LinkSetEnterCost(Rid link, float enterCost);

Sets the enter_cost for this link.

public static void LinkSetMap(Rid link, Rid map);

Sets the navigation map Rid for the link.

public static void LinkSetNavigationLayers(Rid link, uint navigationLayers);

Sets the given link's navigation layers to navigation_layers. This allows selecting links from a path request (when using NavigationServer3D.MapGetPath).

public static void LinkSetOwnerId(Rid link, ulong ownerId);

Set the ObjectID of the object which manages this link.

public static void LinkSetStartPosition(Rid link, Vector3 position);

Sets the entry position for this link.

public static void LinkSetTravelCost(Rid link, float travelCost);

Sets the travel_cost for this link.

public static Rid MapCreate();

Creates a separate navigation map without geometry. Its owner must enable processing, add regions, wait for publication and eventually release the map with FreeRid.

public static void MapForceUpdate(Rid map);

This function immediately forces synchronization of the specified navigation map Rid. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed). Due to technical restrictions the current NavigationServer command queue will be flushed. This means all already queued update commands for this physics frame will be executed, even those intended for other maps, regions, and agents not part of the specified map. The expensive computation of the navigation meshes and region connections of a map will only be done for the specified map. Other maps will receive the normal synchronization at the end of the physics frame. Should the specified map receive changes after the forced update it will update again as well when the other maps receive their update. Avoidance processing and dispatch of the safe_velocity signals is unaffected by this function and continues to happen for all maps and agents at the end of the physics frame. Note: With great power comes great responsibility. This function should only be used by users that really know what they are doing and have a good reason for it. Forcing an immediate update of a navigation map requires locking the NavigationServer and flushing the entire NavigationServer command queue. Not only can this severely impact the performance of a game but it can also introduce bugs if used inappropriately without much foresight.

public static Reckfell.Collections.Array<Rid> MapGetAgents(Rid map);

Returns all navigation agent Rids that are currently assigned to the requested navigation map.

public static float MapGetCellHeight(Rid map);

Returns the map cell height used to rasterize the navigation mesh vertices on the Y axis.

public static float MapGetCellSize(Rid map);

Returns the map cell size used to rasterize the navigation mesh vertices on the XZ plane.

public static Vector3 MapGetClosestPoint(Rid map, Vector3 toPoint);

Returns the navigation mesh surface point closest to the provided to_point on the navigation map.

public static Vector3 MapGetClosestPointNormal(Rid map, Vector3 toPoint);

Returns the navigation mesh surface normal closest to the provided to_point on the navigation map.

public static Rid MapGetClosestPointOwner(Rid map, Vector3 toPoint);

Returns the owner region RID for the navigation mesh surface point closest to the provided to_point on the navigation map.

public static Vector3 MapGetClosestPointToSegment(Rid map, Vector3 start, Vector3 end, bool useCollision = false);

Returns the navigation mesh surface point closest to the provided start and end segment on the navigation map. If use_collision is true, a closest point test is only done when the segment intersects with the navigation mesh surface.

public static float MapGetEdgeConnectionMargin(Rid map);

Returns the edge connection margin of the map. This distance is the minimum vertex distance needed to connect two edges from different regions.

public static uint MapGetIterationId(Rid map);

Returns the current iteration id of the navigation map. Every time the navigation map changes and synchronizes the iteration id increases. An iteration id of 0 means the navigation map has never synchronized. Note: The iteration id will wrap back to 1 after reaching its range limit.

public static float MapGetLinkConnectionRadius(Rid map);

Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to.

public static Reckfell.Collections.Array<Rid> MapGetLinks(Rid map);

Returns all navigation link Rids that are currently assigned to the requested navigation map.

public static float MapGetMergeRasterizerCellScale(Rid map);

Returns the map's internal merge rasterizer cell scale.

public static Reckfell.Collections.Array<Rid> MapGetObstacles(Rid map);

Returns all navigation obstacle Rids that are currently assigned to the requested navigation map.

public static Vector3[] MapGetPath(Rid map, Vector3 origin, Vector3 destination, bool optimize, uint navigationLayers = 1);

Queries path points on a published map. A nonempty result may be partial or have projected start/target positions; check both endpoints. The array neither moves a character nor updates itself after map changes.

public static Vector3 MapGetRandomPoint(Rid map, uint navigationLayers, bool uniformly);

Returns a random position picked from all map region polygons with matching navigation_layers. If uniformly is true, all map regions, polygons, and faces are weighted by their surface area (slower). If uniformly is false, just a random region and a random polygon are picked (faster).

public static Reckfell.Collections.Array<Rid> MapGetRegions(Rid map);

Returns all navigation region Rids that are currently assigned to the requested navigation map.

public static Vector3 MapGetUp(Rid map);

Returns the map's up direction.

public static bool MapGetUseAsyncIterations(Rid map);

Returns true if the map synchronization uses an async process that runs on a background thread.

public static bool MapGetUseEdgeConnections(Rid map);

Returns true if the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.

public static bool MapIsActive(Rid map);

Returns true if the map is active.

public static void MapSetActive(Rid map, bool active);

Enables or disables the map participation in server processing. False does not prohibit direct queries against already published navigation, as verified in the installed build. Pause character behavior through game logic.

public static void MapSetCellHeight(Rid map, float cellHeight);

Sets the map cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height of the used navigation meshes.

public static void MapSetCellSize(Rid map, float cellSize);

Sets the map cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size of the used navigation meshes.

public static void MapSetEdgeConnectionMargin(Rid map, float margin);

Set the map edge connection margin used to weld the compatible region edges.

public static void MapSetLinkConnectionRadius(Rid map, float radius);

Set the map's link connection radius used to connect links to navigation polygons.

public static void MapSetMergeRasterizerCellScale(Rid map, float scale);

Set the map's internal merge rasterizer cell scale used to control merging sensitivity.

public static void MapSetUp(Rid map, Vector3 up);

Sets the map up direction.

public static void MapSetUseAsyncIterations(Rid map, bool enabled);

If enabled is true the map synchronization uses an async process that runs on a background thread.

public static void MapSetUseEdgeConnections(Rid map, bool enabled);

Set the navigation map edge connection use. If enabled is true, the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.

public static Rid ObstacleCreate();

Creates a new obstacle.

public static bool ObstacleGetAvoidanceEnabled(Rid obstacle);

Returns true if the provided obstacle has avoidance enabled.

public static uint ObstacleGetAvoidanceLayers(Rid obstacle);

Returns the avoidance_layers bitmask of the specified obstacle.

public static float ObstacleGetHeight(Rid obstacle);

Returns the height of the specified obstacle.

public static Rid ObstacleGetMap(Rid obstacle);

Returns the navigation map Rid the requested obstacle is currently assigned to.

public static bool ObstacleGetPaused(Rid obstacle);

Returns true if the specified obstacle is paused.

public static Vector3 ObstacleGetPosition(Rid obstacle);

Returns the position of the specified obstacle in world space.

public static float ObstacleGetRadius(Rid obstacle);

Returns the radius of the specified dynamic obstacle.

public static bool ObstacleGetUse3DAvoidance(Rid obstacle);

Returns true if the provided obstacle uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z).

public static Vector3 ObstacleGetVelocity(Rid obstacle);

Returns the velocity of the specified dynamic obstacle.

public static Vector3[] ObstacleGetVertices(Rid obstacle);

Returns the outline vertices for the specified obstacle.

public static void ObstacleSetAvoidanceEnabled(Rid obstacle, bool enabled);

If enabled is true, the provided obstacle affects avoidance using agents.

public static void ObstacleSetAvoidanceLayers(Rid obstacle, uint layers);

Sets the given obstacle's avoidance layers to layers.

public static void ObstacleSetHeight(Rid obstacle, float height);

Sets the height for the obstacle. In 3D agents will ignore obstacles that are above or below them while using 2D avoidance.

public static void ObstacleSetMap(Rid obstacle, Rid map);

Assigns the obstacle to a navigation map.

public static void ObstacleSetPaused(Rid obstacle, bool paused);

If paused is true the specified obstacle will not be processed. For example, it will no longer affect avoidance velocities.

public static void ObstacleSetPosition(Rid obstacle, Vector3 position);

Updates the position in world space for the obstacle.

public static void ObstacleSetRadius(Rid obstacle, float radius);

Sets the radius of the dynamic obstacle.

public static void ObstacleSetUse3DAvoidance(Rid obstacle, bool enabled);

Sets if the obstacle uses the 2D avoidance or the 3D avoidance while avoidance is enabled.

public static void ObstacleSetVelocity(Rid obstacle, Vector3 velocity);

Sets velocity of the dynamic obstacle. Allows other agents to better predict the movement of the dynamic obstacle. Only works in combination with the radius of the obstacle.

public static void ObstacleSetVertices(Rid obstacle, Vector3[] vertices);

Sets the outline vertices for the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out.

public static void ObstacleSetVertices(Rid obstacle, ReadOnlySpan<Vector3> vertices);

Sets the outline vertices for the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out.

public static void ParseSourceGeometryData(NavigationMesh navigationMesh, NavigationMeshSourceGeometryData3D sourceGeometryData, Entity rootEntity, Callable callback = default);

Parses the EntityTree for source geometry according to the properties of navigation_mesh. Updates the provided source_geometry_data resource with the resulting data. The resource can then be used to bake a navigation mesh with NavigationServer3D.BakeFromSourceGeometryData. After the process is finished the optional callback will be called. Note: This function needs to run on the main thread or with a deferred call as the EntityTree is not thread-safe. Performance: While convenient, reading data arrays from Mesh resources can affect the frame rate negatively. The data needs to be received from the GPU, stalling the RenderingServer in the process. For performance prefer the use of e.g. collision shapes or creating the data arrays entirely in code.

public static void QueryPath(NavigationPathQueryParameters3D parameters, NavigationPathQueryResult3D result);

Queries a path in a given navigation map. Start and target position and other parameters are defined through NavigationPathQueryParameters3D. Updates the provided NavigationPathQueryResult3D result object with the path among other results requested by the query. After the process is finished the optional callback will be called.

public static void QueryPath(NavigationPathQueryParameters3D parameters, NavigationPathQueryResult3D result, Callable callback = default);

Queries a path in a given navigation map. Start and target position and other parameters are defined through NavigationPathQueryParameters3D. Updates the provided NavigationPathQueryResult3D result object with the path among other results requested by the query. After the process is finished the optional callback will be called.

public static void RegionBakeNavigationMesh(NavigationMesh navigationMesh, Entity rootEntity);

Bakes the navigation_mesh with bake source geometry collected starting from the root_node.

public static Rid RegionCreate();

Creates a new region.

public static Aabb RegionGetBounds(Rid region);

Returns the axis-aligned bounding box for the region's transformed navigation mesh.

public static Vector3 RegionGetClosestPoint(Rid region, Vector3 toPoint);

Returns the navigation mesh surface point closest to the provided to_point on the navigation region.

public static Vector3 RegionGetClosestPointNormal(Rid region, Vector3 toPoint);

Returns the navigation mesh surface normal closest to the provided to_point on the navigation region.

public static Vector3 RegionGetClosestPointToSegment(Rid region, Vector3 start, Vector3 end, bool useCollision = false);

Returns the navigation mesh surface point closest to the provided start and end segment on the navigation region. If use_collision is true, a closest point test is only done when the segment intersects with the navigation mesh surface.

public static Vector3 RegionGetConnectionPathwayEnd(Rid region, int connection);

Returns the ending point of a connection door. connection is an index between 0 and the return value of NavigationServer3D.RegionGetConnectionsCount.

public static Vector3 RegionGetConnectionPathwayStart(Rid region, int connection);

Returns the starting point of a connection door. connection is an index between 0 and the return value of NavigationServer3D.RegionGetConnectionsCount.

public static int RegionGetConnectionsCount(Rid region);

Returns how many connections this region has with other regions in the map.

public static bool RegionGetEnabled(Rid region);

Returns true if the specified region is enabled.

public static float RegionGetEnterCost(Rid region);

Returns the enter cost of this region.

public static uint RegionGetIterationId(Rid region);

Returns the current iteration ID of the navigation region. Every time the navigation region changes and synchronizes, the iteration ID increases. An iteration ID of 0 means the navigation region has never synchronized. Note: The iteration ID will wrap around to 1 after reaching its range limit.

public static Rid RegionGetMap(Rid region);

Returns the navigation map Rid the requested region is currently assigned to.

public static uint RegionGetNavigationLayers(Rid region);

Returns the region's navigation layers.

public static ulong RegionGetOwnerId(Rid region);

Returns the ObjectID of the object which manages this region.

public static Vector3 RegionGetRandomPoint(Rid region, uint navigationLayers, bool uniformly);

Returns a random position picked from all region polygons with matching navigation_layers. If uniformly is true, all region polygons and faces are weighted by their surface area (slower). If uniformly is false, just a random polygon and face is picked (faster).

public static Transform3D RegionGetTransform(Rid region);

Returns the global transformation of this region.

public static float RegionGetTravelCost(Rid region);

Returns the travel cost of this region.

public static bool RegionGetUseAsyncIterations(Rid region);

Returns true if the region uses an async synchronization process that runs on a background thread.

public static bool RegionGetUseEdgeConnections(Rid region);

Returns true if the navigation region is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.

public static bool RegionOwnsPoint(Rid region, Vector3 point);

Returns true if the provided point in world space is currently owned by the provided navigation region. Owned in this context means that one of the region's navigation mesh polygon faces has a possible position at the closest distance to this point compared to all other navigation meshes from other navigation regions that are also registered on the navigation map of the provided region. If multiple navigation meshes have positions at equal distance the navigation region whose polygons are processed first wins the ownership. Polygons are processed in the same order that navigation regions were registered on the NavigationServer. Note: If navigation meshes from different navigation regions overlap (which should be avoided in general) the result might not be what is expected.

public static void RegionSetEnabled(Rid region, bool enabled);

If enabled is true, the specified region will contribute to its current navigation map.

public static void RegionSetEnterCost(Rid region, float enterCost);

Sets the enter_cost for this region.

public static void RegionSetMap(Rid region, Rid map);

Sets the map for the region.

public static void RegionSetNavigationLayers(Rid region, uint navigationLayers);

Set the region's navigation layers. This allows selecting regions from a path request (when using NavigationServer3D.MapGetPath).