@ringozz/godot 0.1.0

package/gen/classes/NavigationAgent2D.ts

@@ -0,0 +1,361 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R, _G } from '../../src/runtime.ts';
+import { Node } from './Node.ts';
+import type { GodotDictionary, PackedVector2Array, RID, Signal } from '../heap-types/index.ts';
+import type { Color, Vector2 } from '../value-types/index.ts';
+import type { PathMetadataFlags, PathPostProcessing, PathfindingAlgorithm } from './NavigationPathQueryParameters3D.ts';
+import type { NavigationPathQueryResult2D } from './NavigationPathQueryResult2D.ts';
+
+/**
+ * A 2D agent used to pathfind to a position while avoiding static and dynamic obstacles. The calculation can be used by the parent node to dynamically move it along the path. Requires navigation data to work correctly.
+ * Dynamic obstacles are avoided using RVO collision avoidance. Avoidance is computed before physics, so the pathfinding information can be used safely in the physics step.
+ * **Note:** After setting the {@link targetPosition} property, the {@link getNextPathPosition} method must be used once every physics frame to update the internal path logic of the navigation agent. The vector position it returns should be used as the next movement position for the agent's parent node.
+ * **Note:** Several methods of this class, such as {@link getNextPathPosition}, can trigger a new path calculation. Calling these in your callback to an agent's signal, such as {@link waypoint_reached}, can cause infinite recursion. It is recommended to call these methods in the physics step or, alternatively, delay their call until the end of the frame (see {@link Object.callDeferred} or {@link Object.CONNECT_DEFERRED}).
+ */
+export class NavigationAgent2D extends Node {
+    constructor(name = 434) { super(name); }
+
+    /**
+     * Returns the {@link RID} of this agent on the {@link NavigationServer2D}.
+     */
+    getRid(): RID { return _C(this, 6177) as RID; }
+
+    /**
+     * Based on `value`, enables or disables the specified layer in the {@link navigationLayers} bitmask, given a `layerNumber` between 1 and 32.
+     */
+    setNavigationLayerValue(layerNumber: number, value: boolean): void { _C(this, 12118, layerNumber, value); }
+
+    /**
+     * Returns whether or not the specified layer of the {@link navigationLayers} bitmask is enabled, given a `layerNumber` between 1 and 32.
+     */
+    getNavigationLayerValue(layerNumber: number): boolean { return _C(this, 5609, layerNumber) as boolean; }
+
+    /**
+     * Sets the {@link RID} of the navigation map this NavigationAgent node should use and also updates the `agent` on the NavigationServer.
+     */
+    setNavigationMap(navigationMap: RID): void { _C(this, 12120, navigationMap); }
+
+    /**
+     * Returns the {@link RID} of the navigation map for this NavigationAgent node. This function returns always the map set on the NavigationAgent node and not the map of the abstract agent on the NavigationServer. If the agent map is changed directly with the NavigationServer API the NavigationAgent node will not be aware of the map change. Use {@link setNavigationMap} to change the navigation map for the NavigationAgent and also update the agent on the NavigationServer.
+     */
+    getNavigationMap(): RID { return _C(this, 5612) as RID; }
+
+    /**
+     * Returns the length of the currently calculated path. The returned value is `0.0`, if the path is still calculating or no calculation has been requested yet.
+     */
+    getPathLength(): number { return _C(this, 5848) as number; }
+
+    /**
+     * Returns the next position in global coordinates that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. The use of this function once every physics frame is required to update the internal path logic of the NavigationAgent.
+     */
+    getNextPathPosition(): Vector2 { return _C(this, 5629) as Vector2; }
+
+    /**
+     * Replaces the internal velocity in the collision avoidance simulation with `velocity`. 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.
+     */
+    setVelocityForced(velocity: Vector2): void { _C(this, 13281, velocity); }
+
+    /**
+     * Returns the distance to the target position, using the agent's global position. The user must set {@link targetPosition} in order for this to be accurate.
+     */
+    distanceToTarget(): number { return _C(this, 2851) as number; }
+
+    /**
+     * Returns the path query result for the path the agent is currently following.
+     */
+    getCurrentNavigationResult(): NavigationPathQueryResult2D { return _C(this, 4358) as NavigationPathQueryResult2D; }
+
+    /**
+     * Returns this agent's current path from start to finish in global coordinates. The path only updates when the target position is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended {@link getNextPathPosition} once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic.
+     */
+    getCurrentNavigationPath(): PackedVector2Array { return _C(this, 4356) as PackedVector2Array; }
+
+    /**
+     * Returns which index the agent is currently on in the navigation path's {@link PackedVector2Array}.
+     */
+    getCurrentNavigationPathIndex(): number { return _C(this, 4357) as number; }
+
+    /**
+     * Returns `true` if the agent reached the target, i.e. the agent moved within {@link targetDesiredDistance} of the {@link targetPosition}. It may not always be possible to reach the target but it should always be possible to reach the final position. See {@link getFinalPosition}.
+     */
+    isTargetReached(): boolean { return _C(this, 8360) as boolean; }
+
+    /**
+     * Returns `true` if {@link getFinalPosition} is within {@link targetDesiredDistance} of the {@link targetPosition}.
+     */
+    isTargetReachable(): boolean { return _C(this, 8359) as boolean; }
+
+    /**
+     * Returns `true` if the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached.
+     * **Note:** While `true` prefer to stop calling update functions like {@link getNextPathPosition}. This avoids jittering the standing agent due to calling repeated path updates.
+     */
+    isNavigationFinished(): boolean { return _C(this, 8129) as boolean; }
+
+    /**
+     * Returns the reachable final position of the current navigation path in global coordinates. This position can change if the agent needs to update the navigation path which makes the agent emit the {@link path_changed} signal.
+     */
+    getFinalPosition(): Vector2 { return _C(this, 4790) as Vector2; }
+
+    /**
+     * Based on `value`, enables or disables the specified layer in the {@link avoidanceLayers} bitmask, given a `layerNumber` between 1 and 32.
+     */
+    setAvoidanceLayerValue(layerNumber: number, value: boolean): void { _C(this, 10599, layerNumber, value); }
+
+    /**
+     * Returns whether or not the specified layer of the {@link avoidanceLayers} bitmask is enabled, given a `layerNumber` between 1 and 32.
+     */
+    getAvoidanceLayerValue(layerNumber: number): boolean { return _C(this, 3854, layerNumber) as boolean; }
+
+    /**
+     * Based on `value`, enables or disables the specified mask in the {@link avoidanceMask} bitmask, given a `maskNumber` between 1 and 32.
+     */
+    setAvoidanceMaskValue(maskNumber: number, value: boolean): void { _C(this, 10602, maskNumber, value); }
+
+    /**
+     * Returns whether or not the specified mask of the {@link avoidanceMask} bitmask is enabled, given a `maskNumber` between 1 and 32.
+     */
+    getAvoidanceMaskValue(maskNumber: number): boolean { return _C(this, 3857, maskNumber) as boolean; }
+
+    /**
+     * If set, a new navigation path from the current agent position to the {@link targetPosition} is requested from the NavigationServer.
+     */
+    get targetPosition(): Vector2 { return _C(this, 6702) as Vector2; }
+    set targetPosition(v: Vector2) { _C(this, 13007, v); }
+
+    /**
+     * The distance threshold before a path point is considered to be reached. This allows agents to not have to hit a path point on the path exactly, but only to reach its general area. If this value is set too high, the NavigationAgent will skip points on the path, which can lead to it leaving the navigation mesh. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot the distance to the next point on each physics frame update.
+     */
+    get pathDesiredDistance(): number { return _C(this, 5844) as number; }
+    set pathDesiredDistance(v: number) { _C(this, 12275, v); }
+
+    /**
+     * The distance threshold before the target is considered to be reached. On reaching the target, {@link target_reached} is emitted and navigation ends (see {@link isNavigationFinished} and {@link navigation_finished}).
+     * You can make navigation end early by setting this property to a value greater than {@link pathDesiredDistance} (navigation will end before reaching the last waypoint).
+     * You can also make navigation end closer to the target than each individual path position by setting this property to a value lower than {@link pathDesiredDistance} (navigation won't immediately end when reaching the last waypoint). However, if the value set is too low, the agent will be stuck in a repath loop because it will constantly overshoot the distance to the target on each physics frame update.
+     */
+    get targetDesiredDistance(): number { return _C(this, 6698) as number; }
+    set targetDesiredDistance(v: number) { _C(this, 13002, v); }
+
+    /**
+     * The maximum distance the agent is allowed away from the ideal path to the final position. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path.
+     */
+    get pathMaxDistance(): number { return _C(this, 5849) as number; }
+    set pathMaxDistance(v: number) { _C(this, 12282, v); }
+
+    /**
+     * A bitfield determining which navigation layers of navigation regions this agent will use to calculate a path. Changing it during runtime will clear the current navigation path and generate a new one, according to the new navigation layers.
+     */
+    get navigationLayers(): number { return _C(this, 5610) as number; }
+    set navigationLayers(v: number) { _C(this, 12119, v); }
+
+    /**
+     * The pathfinding algorithm used in the path query.
+     */
+    get pathfindingAlgorithm(): PathfindingAlgorithm { return _C(this, 5865) as PathfindingAlgorithm; }
+    set pathfindingAlgorithm(v: PathfindingAlgorithm) { _C(this, 12297, v); }
+
+    /**
+     * The path postprocessing applied to the raw path corridor found by the {@link pathfindingAlgorithm}.
+     */
+    get pathPostprocessing(): PathPostProcessing { return _C(this, 5853) as PathPostProcessing; }
+    set pathPostprocessing(v: PathPostProcessing) { _C(this, 12286, v); }
+
+    /**
+     * Additional information to return with the navigation path.
+     */
+    get pathMetadataFlags(): PathMetadataFlags { return _C(this, 5850) as PathMetadataFlags; }
+    set pathMetadataFlags(v: PathMetadataFlags) { _C(this, 12283, v); }
+
+    /**
+     * If `true` a simplified version of the path will be returned with less critical path points removed. The simplification amount is controlled by {@link simplifyEpsilon}. 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".
+     */
+    get simplifyPath(): boolean { return _C(this, 6394) as boolean; }
+    set simplifyPath(v: boolean) { _C(this, 12749, v); }
+
+    /**
+     * The path simplification amount in worlds units.
+     */
+    get simplifyEpsilon(): number { return _C(this, 6393) as number; }
+    set simplifyEpsilon(v: number) { _C(this, 12748, v); }
+
+    /**
+     * The maximum allowed length of the returned path in world units. A path will be clipped when going over this length.
+     */
+    get pathReturnMaxLength(): number { return _C(this, 5854) as number; }
+    set pathReturnMaxLength(v: number) { _C(this, 12287, v); }
+
+    /**
+     * The maximum allowed radius in world units that the returned path can be from the path start. The path will be clipped when going over this radius. Compared to {@link pathReturnMaxLength}, this allows the agent to go that much further, if they need to walk around a corner.
+     * **Note:** This will perform a sphere clip considering only the actual navigation mesh path points with the first path position being the sphere's center.
+     */
+    get pathReturnMaxRadius(): number { return _C(this, 5855) as number; }
+    set pathReturnMaxRadius(v: number) { _C(this, 12288, v); }
+
+    /**
+     * The maximum number of polygons that are searched before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of `0` or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted.
+     */
+    get pathSearchMaxPolygons(): number { return _C(this, 5860) as number; }
+    set pathSearchMaxPolygons(v: number) { _C(this, 12293, v); }
+
+    /**
+     * The maximum distance a searched polygon can be away from the start polygon before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of `0` or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted.
+     */
+    get pathSearchMaxDistance(): number { return _C(this, 5859) as number; }
+    set pathSearchMaxDistance(v: number) { _C(this, 12292, v); }
+
+    /**
+     * If `true` the agent is registered for an RVO avoidance callback on the {@link NavigationServer2D}. When {@link velocity} is used and the processing is completed a `safe_velocity` Vector2 is received with a signal connection to {@link velocity_computed}. Avoidance processing with many registered agents has a significant performance cost and should only be enabled on agents that currently require it.
+     */
+    get avoidanceEnabled(): boolean { return _C(this, 3853) as boolean; }
+    set avoidanceEnabled(v: boolean) { _C(this, 10598, v); }
+
+    /**
+     * Sets the new wanted velocity for the agent. The avoidance simulation will try to fulfill this velocity if possible but will modify it to avoid collision with other agents and obstacles. When an agent is teleported to a new position, use {@link setVelocityForced} as well to reset the internal simulation velocity.
+     */
+    get velocity(): Vector2 { return _C(this, 7035) as Vector2; }
+    set velocity(v: Vector2) { _C(this, 13279, v); }
+
+    /**
+     * The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by {@link neighborDistance}).
+     * Does not affect normal pathfinding. To change an actor's pathfinding radius bake {@link NavigationPolygon} resources with a different {@link NavigationPolygon.agentRadius} property and use different navigation maps for each actor size.
+     */
+    get radius(): number { return _C(this, 6068) as number; }
+    set radius(v: number) { _C(this, 12467, v); }
+
+    /**
+     * The distance to search for other agents.
+     */
+    get neighborDistance(): number { return _C(this, 5621) as number; }
+    set neighborDistance(v: number) { _C(this, 12129, v); }
+
+    /**
+     * The maximum number of neighbors for the agent to consider.
+     */
+    get maxNeighbors(): number { return _C(this, 5475) as number; }
+    set maxNeighbors(v: number) { _C(this, 11999, v); }
+
+    /**
+     * The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to other agents. The larger the number, the sooner the agent will respond to other agents, but less freedom in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive.
+     */
+    get timeHorizonAgents(): number { return _C(this, 6809) as number; }
+    set timeHorizonAgents(v: number) { _C(this, 13083, v); }
+
+    /**
+     * The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to static avoidance obstacles. The larger the number, the sooner the agent will respond to static avoidance obstacles, but less freedom in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive.
+     */
+    get timeHorizonObstacles(): number { return _C(this, 6810) as number; }
+    set timeHorizonObstacles(v: number) { _C(this, 13084, v); }
+
+    /**
+     * The maximum speed that an agent can move.
+     */
+    get maxSpeed(): number { return _C(this, 5488) as number; }
+    set maxSpeed(v: number) { _C(this, 12010, v); }
+
+    /**
+     * A bitfield determining the avoidance layers for this NavigationAgent. Other agents with a matching bit on the {@link avoidanceMask} will avoid this agent.
+     */
+    get avoidanceLayers(): number { return _C(this, 3855) as number; }
+    set avoidanceLayers(v: number) { _C(this, 10600, v); }
+
+    /**
+     * A bitfield determining what other avoidance agents and obstacles this NavigationAgent will avoid when a bit matches at least one of their {@link avoidanceLayers}.
+     */
+    get avoidanceMask(): number { return _C(this, 3856) as number; }
+    set avoidanceMask(v: number) { _C(this, 10601, v); }
+
+    /**
+     * The agent does not adjust the velocity for other agents that would match the {@link avoidanceMask} but have a lower {@link avoidancePriority}. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent.
+     */
+    get avoidancePriority(): number { return _C(this, 3858) as number; }
+    set avoidancePriority(v: number) { _C(this, 10603, v); }
+
+    /**
+     * If `true` shows debug visuals for this agent.
+     */
+    get debugEnabled(): boolean { return _C(this, 4432) as boolean; }
+    set debugEnabled(v: boolean) { _C(this, 11043, v); }
+
+    /**
+     * If `true` uses the defined {@link debugPathCustomColor} for this agent instead of global color.
+     */
+    get debugUseCustom(): boolean { return _C(this, 4439) as boolean; }
+    set debugUseCustom(v: boolean) { _C(this, 11052, v); }
+
+    /**
+     * If {@link debugUseCustom} is `true` uses this color for this agent instead of global color.
+     */
+    get debugPathCustomColor(): Color { return _C(this, 4434) as Color; }
+    set debugPathCustomColor(v: Color) { _C(this, 11046, v); }
+
+    /**
+     * If {@link debugUseCustom} is `true` uses this rasterized point size for rendering path points for this agent instead of global point size.
+     */
+    get debugPathCustomPointSize(): number { return _C(this, 4436) as number; }
+    set debugPathCustomPointSize(v: number) { _C(this, 11048, v); }
+
+    /**
+     * If {@link debugUseCustom} is `true` uses this line width for rendering paths for this agent instead of global line width.
+     */
+    get debugPathCustomLineWidth(): number { return _C(this, 4435) as number; }
+    set debugPathCustomLineWidth(v: number) { _C(this, 11047, v); }
+
+    /**
+     * Emitted when the agent had to update the loaded path:
+     * - because path was previously empty.
+     * - because navigation map has changed.
+     * - because agent pushed further away from the current path segment than the {@link pathMaxDistance}.
+     */
+    get pathChanged(): Signal<() => void> { return _G(this, 9355) as Signal<() => void>; }
+    set pathChanged(v: (() => void) | null) { _G(this, 9355, v); }
+
+    /**
+     * Signals that the agent reached the target, i.e. the agent moved within {@link targetDesiredDistance} of the {@link targetPosition}. This signal is emitted only once per loaded path.
+     * This signal will be emitted just before {@link navigation_finished} when the target is reachable.
+     * It may not always be possible to reach the target but it should always be possible to reach the final position. See {@link getFinalPosition}.
+     */
+    get targetReached(): Signal<() => void> { return _G(this, 14139) as Signal<() => void>; }
+    set targetReached(v: (() => void) | null) { _G(this, 14139, v); }
+
+    /**
+     * Signals that the agent reached a waypoint. Emitted when the agent moves within {@link pathDesiredDistance} of the next position of the path.
+     * The details dictionary may contain the following keys depending on the value of {@link pathMetadataFlags}:
+     * - `position`: The position of the waypoint that was reached.
+     * - `type`: The type of navigation primitive (region or link) that contains this waypoint.
+     * - `rid`: The {@link RID} of the containing navigation primitive (region or link).
+     * - `owner`: The object which manages the containing navigation primitive (region or link).
+     */
+    get waypointReached(): Signal<(details: GodotDictionary) => void> { return _G(this, 14842) as Signal<(details: GodotDictionary) => void>; }
+    set waypointReached(v: ((details: GodotDictionary) => void) | null) { _G(this, 14842, v); }
+
+    /**
+     * Signals that the agent reached a navigation link. Emitted when the agent moves within {@link pathDesiredDistance} of the next position of the path when that position is a navigation link.
+     * The details dictionary may contain the following keys depending on the value of {@link pathMetadataFlags}:
+     * - `position`: The start position of the link that was reached.
+     * - `type`: Always {@link NavigationPathQueryResult2D.PATH_SEGMENT_TYPE_LINK}.
+     * - `rid`: The {@link RID} of the link.
+     * - `owner`: The object which manages the link (usually {@link NavigationLink2D}).
+     * - `link_entry_position`: If `owner` is available and the owner is a {@link NavigationLink2D}, it will contain the global position of the link's point the agent is entering.
+     * - `link_exit_position`: If `owner` is available and the owner is a {@link NavigationLink2D}, it will contain the global position of the link's point which the agent is exiting.
+     */
+    get linkReached(): Signal<(details: GodotDictionary) => void> { return _G(this, 8649) as Signal<(details: GodotDictionary) => void>; }
+    set linkReached(v: ((details: GodotDictionary) => void) | null) { _G(this, 8649, v); }
+
+    /**
+     * Signals that the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached. This signal is emitted only once per loaded path.
+     * This signal will be emitted just after {@link target_reached} when the target is reachable.
+     */
+    get navigationFinished(): Signal<() => void> { return _G(this, 9053) as Signal<() => void>; }
+    set navigationFinished(v: (() => void) | null) { _G(this, 9053, v); }
+
+    /**
+     * Notifies when the collision avoidance velocity is calculated. Emitted every update as long as {@link avoidanceEnabled} is `true` and the agent has a navigation map.
+     */
+    get velocityComputed(): Signal<(safeVelocity: Vector2) => void> { return _G(this, 14685) as Signal<(safeVelocity: Vector2) => void>; }
+    set velocityComputed(v: ((safeVelocity: Vector2) => void) | null) { _G(this, 14685, v); }
+
+    static readonly name = _R(434, NavigationAgent2D);
+}