NavigationServer2D

package
v0.0.0-...-2b43b64 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 29, 2025 License: MIT Imports: 21 Imported by: 0

Documentation

Overview

Package NavigationServer2D provides methods for working with NavigationServer2D object instances.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Advanced 

func Advanced() class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

func AgentCreate 

func AgentCreate() RID.NavigationAgent2D

Creates the agent.

func AgentGetAvoidanceEnabled 

func AgentGetAvoidanceEnabled(agent RID.NavigationAgent2D) bool

Return [code]true[/code] if the specified [param agent] uses avoidance.

func AgentGetAvoidanceLayers 

func AgentGetAvoidanceLayers(agent RID.NavigationAgent2D) int

Returns the [code]avoidance_layers[/code] bitmask of the specified [param agent].

func AgentGetAvoidanceMask 

func AgentGetAvoidanceMask(agent RID.NavigationAgent2D) int

Returns the [code]avoidance_mask[/code] bitmask of the specified [param agent].

func AgentGetAvoidancePriority 

func AgentGetAvoidancePriority(agent RID.NavigationAgent2D) Float.X

Returns the [code]avoidance_priority[/code] of the specified [param agent].

func AgentGetMap 

func AgentGetMap(agent RID.NavigationAgent2D) RID.NavigationMap2D

Returns the navigation map [RID] the requested [param agent] is currently assigned to.

func AgentGetMaxNeighbors 

func AgentGetMaxNeighbors(agent RID.NavigationAgent2D) int

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

func AgentGetMaxSpeed 

func AgentGetMaxSpeed(agent RID.NavigationAgent2D) Float.X

Returns the maximum speed of the specified [param agent].

func AgentGetNeighborDistance 

func AgentGetNeighborDistance(agent RID.NavigationAgent2D) Float.X

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

func AgentGetPaused 

func AgentGetPaused(agent RID.NavigationAgent2D) bool

Returns [code]true[/code] if the specified [param agent] is paused.

func AgentGetPosition 

func AgentGetPosition(agent RID.NavigationAgent2D) Vector2.XY

Returns the position of the specified [param agent] in world space.

func AgentGetRadius 

func AgentGetRadius(agent RID.NavigationAgent2D) Float.X

Returns the radius of the specified [param agent].

func AgentGetTimeHorizonAgents 

func AgentGetTimeHorizonAgents(agent RID.NavigationAgent2D) Float.X

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

func AgentGetTimeHorizonObstacles 

func AgentGetTimeHorizonObstacles(agent RID.NavigationAgent2D) Float.X

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

func AgentGetVelocity 

func AgentGetVelocity(agent RID.NavigationAgent2D) Vector2.XY

Returns the velocity of the specified [param agent].

func AgentHasAvoidanceCallback 

func AgentHasAvoidanceCallback(agent RID.NavigationAgent2D) bool

Return [code]true[/code] if the specified [param agent] has an avoidance callback.

func AgentIsMapChanged 

func AgentIsMapChanged(agent RID.NavigationAgent2D) bool

Returns true if the map got changed the previous frame.

func AgentSetAvoidanceCallback 

func AgentSetAvoidanceCallback(agent RID.NavigationAgent2D, callback func(velocity Vector2.XY))

Sets the callback [Callable] that gets called after each avoidance processing step for the [param agent]. The calculated [code]safe_velocity[/code] will be dispatched with a signal to the object just before the physics calculations. [b]Note:[/b] Created callbacks are always processed independently of the SceneTree 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 [method agent_set_avoidance_callback] again with an empty [Callable].

func AgentSetAvoidanceEnabled 

func AgentSetAvoidanceEnabled(agent RID.NavigationAgent2D, enabled bool)

If [param enabled] is [code]true[/code], the specified [param agent] uses avoidance.

func AgentSetAvoidanceLayers 

func AgentSetAvoidanceLayers(agent RID.NavigationAgent2D, layers int)

Set the agent's [code]avoidance_layers[/code] bitmask.

func AgentSetAvoidanceMask 

func AgentSetAvoidanceMask(agent RID.NavigationAgent2D, mask int)

Set the agent's [code]avoidance_mask[/code] bitmask.

func AgentSetAvoidancePriority 

func AgentSetAvoidancePriority(agent RID.NavigationAgent2D, priority Float.X)

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

func AgentSetMap 

func AgentSetMap(agent RID.NavigationAgent2D, mapping RID.NavigationMap2D)

Puts the agent in the map.

func AgentSetMaxNeighbors 

func AgentSetMaxNeighbors(agent RID.NavigationAgent2D, count int)

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.

func AgentSetMaxSpeed 

func AgentSetMaxSpeed(agent RID.NavigationAgent2D, max_speed Float.X)

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

func AgentSetNeighborDistance 

func AgentSetNeighborDistance(agent RID.NavigationAgent2D, distance Float.X)

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.

func AgentSetPaused 

func AgentSetPaused(agent RID.NavigationAgent2D, paused bool)

If [param paused] is true the specified [param agent] will not be processed, e.g. calculate avoidance velocities or receive avoidance callbacks.

func AgentSetPosition 

func AgentSetPosition(agent RID.NavigationAgent2D, position Vector2.XY)

Sets the position of the agent in world space.

func AgentSetRadius 

func AgentSetRadius(agent RID.NavigationAgent2D, radius Float.X)

Sets the radius of the agent.

func AgentSetTimeHorizonAgents 

func AgentSetTimeHorizonAgents(agent RID.NavigationAgent2D, time_horizon Float.X)

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 agents movement considerably. Must be positive.

func AgentSetTimeHorizonObstacles 

func AgentSetTimeHorizonObstacles(agent RID.NavigationAgent2D, time_horizon Float.X)

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 agents movement considerably. Must be positive.

func AgentSetVelocity 

func AgentSetVelocity(agent RID.NavigationAgent2D, velocity Vector2.XY)

Sets [param velocity] as the new wanted velocity for the specified [param agent]. The avoidance simulation will try to fulfill this velocity if possible but will modify it to avoid collision with other agent's and obstacles. When an agent is teleported to a new position far away use [method agent_set_velocity_forced] instead to reset the internal velocity state.

func AgentSetVelocityForced 

func AgentSetVelocityForced(agent RID.NavigationAgent2D, velocity Vector2.XY)

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

func BakeFromSourceGeometryData 

func BakeFromSourceGeometryData(navigation_polygon [1]gdclass.NavigationPolygon, source_geometry_data [1]gdclass.NavigationMeshSourceGeometryData2D)

Bakes the provided [param navigation_polygon] with the data from the provided [param source_geometry_data]. After the process is finished the optional [param callback] will be called.

func BakeFromSourceGeometryDataAsync 

func BakeFromSourceGeometryDataAsync(navigation_polygon [1]gdclass.NavigationPolygon, source_geometry_data [1]gdclass.NavigationMeshSourceGeometryData2D)

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

func FreeRid 

func FreeRid(rid RID.Any)

Destroys the given RID.

func GetDebugEnabled 

func GetDebugEnabled() bool

Returns [code]true[/code] when the NavigationServer has debug enabled.

func GetMaps 

func GetMaps() [][]RID.NavigationMap2D

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

func IsBakingNavigationPolygon 

func IsBakingNavigationPolygon(navigation_polygon [1]gdclass.NavigationPolygon) bool

Returns [code]true[/code] when the provided navigation polygon is being baked on a background thread.

func LinkCreate 

func LinkCreate() RID.NavigationLink2D

Create a new link between two positions on a map.

func LinkGetEnabled 

func LinkGetEnabled(link RID.NavigationLink2D) bool

Returns [code]true[/code] if the specified [param link] is enabled.

func LinkGetEndPosition 

func LinkGetEndPosition(link RID.NavigationLink2D) Vector2.XY

Returns the ending position of this [param link].

func LinkGetEnterCost 

func LinkGetEnterCost(link RID.NavigationLink2D) Float.X

Returns the enter cost of this [param link].

func LinkGetMap 

func LinkGetMap(link RID.NavigationLink2D) RID.NavigationMap2D

Returns the navigation map [RID] the requested [param link] is currently assigned to.

func LinkGetNavigationLayers 

func LinkGetNavigationLayers(link RID.NavigationLink2D) int

Returns the navigation layers for this [param link].

func LinkGetOwnerId 

func LinkGetOwnerId(link RID.NavigationLink2D) int

Returns the [code]ObjectID[/code] of the object which manages this link.

func LinkGetStartPosition 

func LinkGetStartPosition(link RID.NavigationLink2D) Vector2.XY

Returns the starting position of this [param link].

func LinkGetTravelCost 

func LinkGetTravelCost(link RID.NavigationLink2D) Float.X

Returns the travel cost of this [param link].

func LinkIsBidirectional 

func LinkIsBidirectional(link RID.NavigationLink2D) bool

Returns whether this [param link] can be travelled in both directions.

func LinkSetBidirectional 

func LinkSetBidirectional(link RID.NavigationLink2D, bidirectional bool)

Sets whether this [param link] can be travelled in both directions.

func LinkSetEnabled 

func LinkSetEnabled(link RID.NavigationLink2D, enabled bool)

If [param enabled] is [code]true[/code], the specified [param link] will contribute to its current navigation map.

func LinkSetEndPosition 

func LinkSetEndPosition(link RID.NavigationLink2D, position Vector2.XY)

Sets the exit position for the [param link].

func LinkSetEnterCost 

func LinkSetEnterCost(link RID.NavigationLink2D, enter_cost Float.X)

Sets the [param enter_cost] for this [param link].

func LinkSetMap 

func LinkSetMap(link RID.NavigationLink2D, mapping RID.NavigationMap2D)

Sets the navigation map [RID] for the link.

func LinkSetNavigationLayers 

func LinkSetNavigationLayers(link RID.NavigationLink2D, navigation_layers int)

Set the links's navigation layers. This allows selecting links from a path request (when using [method NavigationServer2D.map_get_path]).

func LinkSetOwnerId 

func LinkSetOwnerId(link RID.NavigationLink2D, owner_id int)

Set the [code]ObjectID[/code] of the object which manages this link.

func LinkSetStartPosition 

func LinkSetStartPosition(link RID.NavigationLink2D, position Vector2.XY)

Sets the entry position for this [param link].

func LinkSetTravelCost 

func LinkSetTravelCost(link RID.NavigationLink2D, travel_cost Float.X)

Sets the [param travel_cost] for this [param link].

func MapCreate 

func MapCreate() RID.NavigationMap2D

Create a new map.

func MapForceUpdate 

func MapForceUpdate(mapping RID.NavigationMap2D)

This function immediately forces synchronization of the specified navigation [param 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 [code]safe_velocity[/code] signals is unaffected by this function and continues to happen for all maps and agents at the end of the physics frame. [b]Note:[/b] 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.

func MapGetAgents 

func MapGetAgents(mapping RID.NavigationMap2D) [][]RID.NavigationAgent2D

Returns all navigation agents [RID]s that are currently assigned to the requested navigation [param map].

func MapGetCellSize 

func MapGetCellSize(mapping RID.NavigationMap2D) Float.X

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

func MapGetClosestPoint 

func MapGetClosestPoint(mapping RID.NavigationMap2D, to_point Vector2.XY) Vector2.XY

Returns the point closest to the provided [param to_point] on the navigation mesh surface.

func MapGetClosestPointOwner 

func MapGetClosestPointOwner(mapping RID.NavigationMap2D, to_point Vector2.XY) RID.NavigationRegion2D

Returns the owner region RID for the point returned by [method map_get_closest_point].

func MapGetEdgeConnectionMargin 

func MapGetEdgeConnectionMargin(mapping RID.NavigationMap2D) Float.X

Returns the edge connection margin of the map. The edge connection margin is a distance used to connect two regions.

func MapGetIterationId 

func MapGetIterationId(mapping RID.NavigationMap2D) int

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. [b]Note:[/b] The iteration id will wrap back to 1 after reaching its range limit.

func MapGetLinkConnectionRadius 

func MapGetLinkConnectionRadius(mapping RID.NavigationMap2D) Float.X

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. 

func MapGetLinks(mapping RID.NavigationMap2D) [][]RID.NavigationLink2D

Returns all navigation link [RID]s that are currently assigned to the requested navigation [param map].

func MapGetObstacles 

func MapGetObstacles(mapping RID.NavigationMap2D) [][]RID.NavigationObstacle2D

Returns all navigation obstacle [RID]s that are currently assigned to the requested navigation [param map].

func MapGetPath 

func MapGetPath(mapping RID.NavigationMap2D, origin Vector2.XY, destination Vector2.XY, optimize bool) []Vector2.XY

Returns the navigation path to reach the destination from the origin. [param navigation_layers] is a bitmask of all region navigation layers that are allowed to be in the path.

func MapGetRandomPoint 

func MapGetRandomPoint(mapping RID.NavigationMap2D, navigation_layers int, uniformly bool) Vector2.XY

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

func MapGetRegions 

func MapGetRegions(mapping RID.NavigationMap2D) [][]RID.NavigationRegion2D

Returns all navigation regions [RID]s that are currently assigned to the requested navigation [param map].

func MapGetUseEdgeConnections 

func MapGetUseEdgeConnections(mapping RID.NavigationMap2D) bool

Returns whether the navigation [param map] allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.

func MapIsActive 

func MapIsActive(mapping RID.NavigationMap2D) bool

Returns true if the map is active.

func MapSetActive 

func MapSetActive(mapping RID.NavigationMap2D, active bool)

Sets the map active.

func MapSetCellSize 

func MapSetCellSize(mapping RID.NavigationMap2D, cell_size Float.X)

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

func MapSetEdgeConnectionMargin 

func MapSetEdgeConnectionMargin(mapping RID.NavigationMap2D, margin Float.X)

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

func MapSetLinkConnectionRadius 

func MapSetLinkConnectionRadius(mapping RID.NavigationMap2D, radius Float.X)

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

func MapSetUseEdgeConnections 

func MapSetUseEdgeConnections(mapping RID.NavigationMap2D, enabled bool)

Set the navigation [param map] edge connection use. If [param enabled] is [code]true[/code], 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.

func ObstacleCreate 

func ObstacleCreate() RID.NavigationObstacle2D

Creates a new navigation obstacle.

func ObstacleGetAvoidanceEnabled 

func ObstacleGetAvoidanceEnabled(obstacle RID.NavigationObstacle2D) bool

Returns [code]true[/code] if the provided [param obstacle] has avoidance enabled.

func ObstacleGetAvoidanceLayers 

func ObstacleGetAvoidanceLayers(obstacle RID.NavigationObstacle2D) int

Returns the [code]avoidance_layers[/code] bitmask of the specified [param obstacle].

func ObstacleGetMap 

func ObstacleGetMap(obstacle RID.NavigationObstacle2D) RID.NavigationMap2D

Returns the navigation map [RID] the requested [param obstacle] is currently assigned to.

func ObstacleGetPaused 

func ObstacleGetPaused(obstacle RID.NavigationObstacle2D) bool

Returns [code]true[/code] if the specified [param obstacle] is paused.

func ObstacleGetPosition 

func ObstacleGetPosition(obstacle RID.NavigationObstacle2D) Vector2.XY

Returns the position of the specified [param obstacle] in world space.

func ObstacleGetRadius 

func ObstacleGetRadius(obstacle RID.NavigationObstacle2D) Float.X

Returns the radius of the specified dynamic [param obstacle].

func ObstacleGetVelocity 

func ObstacleGetVelocity(obstacle RID.NavigationObstacle2D) Vector2.XY

Returns the velocity of the specified dynamic [param obstacle].

func ObstacleGetVertices 

func ObstacleGetVertices(obstacle RID.NavigationObstacle2D) []Vector2.XY

Returns the outline vertices for the specified [param obstacle].

func ObstacleSetAvoidanceEnabled 

func ObstacleSetAvoidanceEnabled(obstacle RID.NavigationObstacle2D, enabled bool)

If [param enabled] is [code]true[/code], the provided [param obstacle] affects avoidance using agents.

func ObstacleSetAvoidanceLayers 

func ObstacleSetAvoidanceLayers(obstacle RID.NavigationObstacle2D, layers int)

Set the obstacles's [code]avoidance_layers[/code] bitmask.

func ObstacleSetMap 

func ObstacleSetMap(obstacle RID.NavigationObstacle2D, mapping RID.NavigationMap2D)

Sets the navigation map [RID] for the obstacle.

func ObstacleSetPaused 

func ObstacleSetPaused(obstacle RID.NavigationObstacle2D, paused bool)

If [param paused] is true the specified [param obstacle] will not be processed, e.g. affect avoidance velocities.

func ObstacleSetPosition 

func ObstacleSetPosition(obstacle RID.NavigationObstacle2D, position Vector2.XY)

Sets the position of the obstacle in world space.

func ObstacleSetRadius 

func ObstacleSetRadius(obstacle RID.NavigationObstacle2D, radius Float.X)

Sets the radius of the dynamic obstacle.

func ObstacleSetVelocity 

func ObstacleSetVelocity(obstacle RID.NavigationObstacle2D, velocity Vector2.XY)

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

func ObstacleSetVertices 

func ObstacleSetVertices(obstacle RID.NavigationObstacle2D, vertices []Vector2.XY)

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.

func OnMapChanged 

func OnMapChanged(cb func(mapping RID.Any))

func OnNavigationDebugChanged 

func OnNavigationDebugChanged(cb func())

func ParseSourceGeometryData 

func ParseSourceGeometryData(navigation_polygon [1]gdclass.NavigationPolygon, source_geometry_data [1]gdclass.NavigationMeshSourceGeometryData2D, root_node [1]gdclass.Node)

Parses the [SceneTree] for source geometry according to the properties of [param navigation_polygon]. Updates the provided [param source_geometry_data] resource with the resulting data. The resource can then be used to bake a navigation mesh with [method bake_from_source_geometry_data]. After the process is finished the optional [param callback] will be called. [b]Note:[/b] This function needs to run on the main thread or with a deferred call as the SceneTree is not thread-safe. [b]Performance:[/b] 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.

func QueryPath 

func QueryPath(parameters [1]gdclass.NavigationPathQueryParameters2D, result [1]gdclass.NavigationPathQueryResult2D)

Queries a path in a given navigation map. Start and target position and other parameters are defined through [NavigationPathQueryParameters2D]. Updates the provided [NavigationPathQueryResult2D] result object with the path among other results requested by the query.

func RegionCreate 

func RegionCreate() RID.NavigationRegion2D

Creates a new region.

func RegionGetConnectionPathwayEnd 

func RegionGetConnectionPathwayEnd(region RID.NavigationRegion2D, connection int) Vector2.XY

Returns the ending point of a connection door. [param connection] is an index between 0 and the return value of [method region_get_connections_count].

func RegionGetConnectionPathwayStart 

func RegionGetConnectionPathwayStart(region RID.NavigationRegion2D, connection int) Vector2.XY

Returns the starting point of a connection door. [param connection] is an index between 0 and the return value of [method region_get_connections_count].

func RegionGetConnectionsCount 

func RegionGetConnectionsCount(region RID.NavigationRegion2D) int

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

func RegionGetEnabled 

func RegionGetEnabled(region RID.NavigationRegion2D) bool

Returns [code]true[/code] if the specified [param region] is enabled.

func RegionGetEnterCost 

func RegionGetEnterCost(region RID.NavigationRegion2D) Float.X

Returns the enter cost of this [param region].

func RegionGetMap 

func RegionGetMap(region RID.NavigationRegion2D) RID.NavigationMap2D

Returns the navigation map [RID] the requested [param region] is currently assigned to.

func RegionGetNavigationLayers 

func RegionGetNavigationLayers(region RID.NavigationRegion2D) int

Returns the region's navigation layers.

func RegionGetOwnerId 

func RegionGetOwnerId(region RID.NavigationRegion2D) int

Returns the [code]ObjectID[/code] of the object which manages this region.

func RegionGetRandomPoint 

func RegionGetRandomPoint(region RID.NavigationRegion2D, navigation_layers int, uniformly bool) Vector2.XY

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

func RegionGetTransform 

func RegionGetTransform(region RID.NavigationRegion2D) Transform2D.OriginXY

Returns the global transformation of this [param region].

func RegionGetTravelCost 

func RegionGetTravelCost(region RID.NavigationRegion2D) Float.X

Returns the travel cost of this [param region].

func RegionGetUseEdgeConnections 

func RegionGetUseEdgeConnections(region RID.NavigationRegion2D) bool

Returns whether the navigation [param region] is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.

func RegionOwnsPoint 

func RegionOwnsPoint(region RID.NavigationRegion2D, point Vector2.XY) bool

Returns [code]true[/code] if the provided [param point] in world space is currently owned by the provided navigation [param 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. [b]Note:[/b] If navigation meshes from different navigation regions overlap (which should be avoided in general) the result might not be what is expected.

func RegionSetEnabled 

func RegionSetEnabled(region RID.NavigationRegion2D, enabled bool)

If [param enabled] is [code]true[/code] the specified [param region] will contribute to its current navigation map.

func RegionSetEnterCost 

func RegionSetEnterCost(region RID.NavigationRegion2D, enter_cost Float.X)

Sets the [param enter_cost] for this [param region].

func RegionSetMap 

func RegionSetMap(region RID.NavigationRegion2D, mapping RID.NavigationMap2D)

Sets the map for the region.

func RegionSetNavigationLayers 

func RegionSetNavigationLayers(region RID.NavigationRegion2D, navigation_layers int)

Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer2D.map_get_path]).

func RegionSetNavigationPolygon 

func RegionSetNavigationPolygon(region RID.NavigationRegion2D, navigation_polygon [1]gdclass.NavigationPolygon)

Sets the [param navigation_polygon] for the region.

func RegionSetOwnerId 

func RegionSetOwnerId(region RID.NavigationRegion2D, owner_id int)

Set the [code]ObjectID[/code] of the object which manages this region.

func RegionSetTransform 

func RegionSetTransform(region RID.NavigationRegion2D, transform Transform2D.OriginXY)

Sets the global transformation for the region.

func RegionSetTravelCost 

func RegionSetTravelCost(region RID.NavigationRegion2D, travel_cost Float.X)

Sets the [param travel_cost] for this [param region].

func RegionSetUseEdgeConnections 

func RegionSetUseEdgeConnections(region RID.NavigationRegion2D, enabled bool)

If [param enabled] is [code]true[/code], the navigation [param region] will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.

func SetDebugEnabled 

func SetDebugEnabled(enabled bool)

If [code]true[/code] enables debug mode on the NavigationServer.

func SimplifyPath 

func SimplifyPath(path []Vector2.XY, epsilon Float.X) []Vector2.XY

Returns a simplified version of [param path] with less critical path points removed. The simplification amount is in worlds units and controlled by [param epsilon]. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation. Path simplification can be helpful to mitigate various path following issues that can arise with certain agent types and script behaviors. E.g. "steering" agents or avoidance in "open fields".

func SourceGeometryParserCreate 

func SourceGeometryParserCreate() RID.NavigationSourceGeometryParser2D

Creates a new source geometry parser. If a [Callable] is set for the parser with [method source_geometry_parser_set_callback] the callback will be called for every single node that gets parsed whenever [method parse_source_geometry_data] is used.

func SourceGeometryParserSetCallback 

func SourceGeometryParserSetCallback(parser RID.NavigationSourceGeometryParser2D, callback func(navigation_mesh [1]gdclass.NavigationPolygon, source_geometry_data [1]gdclass.NavigationMeshSourceGeometryData2D, node [1]gdclass.Node))

Sets the [param callback] [Callable] for the specific source geometry [param parser]. The [Callable] will receive a call with the following parameters: - [code]navigation_mesh[/code] - The [NavigationPolygon] reference used to define the parse settings. Do NOT edit or add directly to the navigation mesh. - [code]source_geometry_data[/code] - The [NavigationMeshSourceGeometryData2D] reference. Add custom source geometry for navigation mesh baking to this object. - [code]node[/code] - The [Node] that is parsed.

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.