From 534ade7282f9567972795dc59a9840ee041d5cf5 Mon Sep 17 00:00:00 2001 From: Nathan Lovato Date: Tue, 11 Feb 2020 13:41:34 -0600 Subject: [PATCH] Update code reference for the 2.0.0 release. --- project/reference.json | 4944 ++++++++++++++++++++-------------------- 1 file changed, 2472 insertions(+), 2472 deletions(-) diff --git a/project/reference.json b/project/reference.json index d65c7d4..6fae0f7 100644 --- a/project/reference.json +++ b/project/reference.json @@ -1,14 +1,268 @@ [ { - "name": "GSTUtils", - "path": "res://src/GSTUtils.gd", + "name": "GSAISteeringBehavior", + "path": "res://src/GSAISteeringBehavior.gd", "extends_class": [ ], "extends_file": "", "icon": "", - "signature": "class GSTUtils", - "description": " Math and vector utility functions.\n", + "signature": "class GSAISteeringBehavior", + "description": " Base class for all steering behaviors.\n\n Steering behaviors calculate the linear and the angular acceleration to be\n to the agent that owns them.\n\n The `calculate_steering` function is the entry point for all behaviors.\n Individual steering behaviors encapsulate the steering logic.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "is_enabled", + "data_type": "bool", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var is_enabled: bool", + "description": " If `false`, all calculations return zero amounts of acceleration.\n" + }, + { + "name": "agent", + "data_type": "GSAISteeringAgent", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var agent: GSAISteeringAgent", + "description": " The AI agent on which the steering behavior bases its calculations.\n" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(_agent: GSAISteeringAgent) -> null", + "description": "", + "arguments": [ + { + "name": "_agent", + "type": "GSAISteeringAgent" + } + ] + }, + { + "name": "calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func calculate_steering(acceleration: GSAITargetAcceleration) -> null", + "description": " Sets the `acceleration` with the behavior's desired amount of acceleration.\n", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + } + ] + }, + { + "name": "_calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _calculate_steering(acceleration: GSAITargetAcceleration) -> null", + "description": "", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIRadiusProximity", + "path": "res://src/Proximities/GSAIRadiusProximity.gd", + "extends_class": [ + "GSAIProximity" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIRadiusProximity", + "description": " Determines any agent that is in the specified list as being neighbors with the owner agent if\n they lie within the specified radius.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "radius", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var radius: float", + "description": " The radius around the owning agent to find neighbors in\n" + }, + { + "name": "_last_frame", + "data_type": "int", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _last_frame: int", + "description": "" + }, + { + "name": "_scene_tree", + "data_type": "SceneTree", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _scene_tree: SceneTree", + "description": "" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent, agents: Array, _radius: float) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + }, + { + "name": "agents", + "type": "Array" + }, + { + "name": "_radius", + "type": "float" + } + ] + }, + { + "name": "_find_neighbors", + "return_type": "int", + "rpc_mode": 0, + "signature": "func _find_neighbors(callback: FuncRef) -> int", + "description": " Returns a number of neighbors based on a `callback` function.\n\n `_find_neighbors` calls `callback` for each agent in the `agents` array that lie within\n the radius around the owning agent and adds one to the count if its `callback` returns true.\n tags: virtual\n", + "arguments": [ + { + "name": "callback", + "type": "FuncRef" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIProximity", + "path": "res://src/Proximities/GSAIProximity.gd", + "extends_class": [ + "Reference" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIProximity", + "description": " Base container type that stores data to find the neighbors of an agent.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "agent", + "data_type": "GSAISteeringAgent", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var agent: GSAISteeringAgent", + "description": " The owning agent whose neighbors are found in the group\n" + }, + { + "name": "agents", + "data_type": "Array", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var agents: Array", + "description": " The agents who are part of this group and could be potential neighbors\n" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(_agent: GSAISteeringAgent, _agents: Array) -> null", + "description": "", + "arguments": [ + { + "name": "_agent", + "type": "GSAISteeringAgent" + }, + { + "name": "_agents", + "type": "Array" + } + ] + }, + { + "name": "_find_neighbors", + "return_type": "int", + "rpc_mode": 0, + "signature": "func _find_neighbors(_callback: FuncRef) -> int", + "description": " Returns a number of neighbors based on a `callback` function.\n\n `_find_neighbors` calls `callback` for each agent in the `agents` array and\n adds one to the count if its `callback` returns true.\n tags: virtual\n", + "arguments": [ + { + "name": "_callback", + "type": "FuncRef" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIInfiniteProximity", + "path": "res://src/Proximities/GSAIInfiniteProximity.gd", + "extends_class": [ + "GSAIProximity" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIInfiniteProximity", + "description": " Determines any agent that is in the specified list as being neighbors with the\n owner agent, regardless of distance.\n", "sub_classes": [ ], @@ -22,100 +276,138 @@ ], "methods": [ - - ], - "static_functions": [ { - "name": "clampedv3", - "return_type": "Vector3", + "name": "_init", + "return_type": "null", "rpc_mode": 0, - "signature": "func clampedv3(vector: Vector3, limit: float) -> Vector3", - "description": " Returns the `vector` with its length capped to `limit`.\n", + "signature": "func _init(agent: GSAISteeringAgent, agents: Array) -> null", + "description": "", "arguments": [ { - "name": "vector", - "type": "Vector3" + "name": "agent", + "type": "GSAISteeringAgent" }, { - "name": "limit", - "type": "float" + "name": "agents", + "type": "Array" } ] }, { - "name": "vector3_to_angle", - "return_type": "float", + "name": "_find_neighbors", + "return_type": "int", "rpc_mode": 0, - "signature": "func vector3_to_angle(vector: Vector3) -> float", - "description": " Returns an angle in radians between the positive X axis and the `vector`.\n\n This assumes orientation for 2D agents or 3D agents that are upright and\n rotate around the Y axis.\n", + "signature": "func _find_neighbors(callback: FuncRef) -> int", + "description": " Returns a number of neighbors based on a `callback` function.\n\n `_find_neighbors` calls `callback` for each agent in the `agents` array and\n adds one to the count if its `callback` returns true.\n tags: virtual\n", "arguments": [ { - "name": "vector", - "type": "Vector3" - } - ] - }, - { - "name": "angle_to_vector2", - "return_type": "Vector2", - "rpc_mode": 0, - "signature": "func angle_to_vector2(angle: float) -> Vector2", - "description": " Returns a directional vector from the given orientation angle.\n \n This assumes orientation for 2D agents or 3D agents that are upright and\n rotate around the Y axis.\n", - "arguments": [ - { - "name": "angle", - "type": "float" - } - ] - }, - { - "name": "to_vector2", - "return_type": "Vector2", - "rpc_mode": 0, - "signature": "func to_vector2(vector: Vector3) -> Vector2", - "description": " Returns a vector2 with `vector`'s x and y components.\n", - "arguments": [ - { - "name": "vector", - "type": "Vector3" - } - ] - }, - { - "name": "to_vector3", - "return_type": "Vector3", - "rpc_mode": 0, - "signature": "func to_vector3(vector: Vector2) -> Vector3", - "description": " Returns a vector3 with `vector`'s x and y components and 0 in z.\n", - "arguments": [ - { - "name": "vector", - "type": "Vector2" + "name": "callback", + "type": "FuncRef" } ] } + ], + "static_functions": [ + ] }, { - "name": "GSTPath", - "path": "res://src/GSTPath.gd", + "name": "GSAIGroupBehavior", + "path": "res://src/GSAIGroupBehavior.gd", + "extends_class": [ + "GSAISteeringBehavior" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIGroupBehavior", + "description": " Base type for group-based steering behaviors.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "proximity", + "data_type": "GSAIProximity", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var proximity: GSAIProximity", + "description": " Container to find neighbors of the agent and calculate group behavior.\n" + }, + { + "name": "_callback", + "data_type": "FuncRef", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _callback: FuncRef", + "description": "" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent, _proximity: GSAIProximity) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + }, + { + "name": "_proximity", + "type": "GSAIProximity" + } + ] + }, + { + "name": "_report_neighbor", + "return_type": "bool", + "rpc_mode": 0, + "signature": "func _report_neighbor(_neighbor: GSAISteeringAgent) -> bool", + "description": " Internal callback for the behavior to define whether or not a member is\n relevant\n tags: virtual\n", + "arguments": [ + { + "name": "_neighbor", + "type": "GSAISteeringAgent" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIPath", + "path": "res://src/GSAIPath.gd", "extends_class": [ "Reference" ], "extends_file": "", "icon": "", - "signature": "class GSTPath", + "signature": "class GSAIPath", "description": " Represents a path made up of Vector3 waypoints, split into segments path\n follow behaviors can use.\n", "sub_classes": [ { - "name": "GSTSegment", - "path": "res://src/GSTPath.gd", + "name": "GSAISegment", + "path": "res://src/GSAIPath.gd", "extends_class": [ ], "extends_file": "", "icon": "", - "signature": "class GSTSegment", + "signature": "class GSAISegment", "description": "", "sub_classes": [ @@ -173,15 +465,15 @@ "name": "_init", "return_type": "null", "rpc_mode": 0, - "signature": "func _init(begin: Vector3, end: Vector3) -> null", + "signature": "func _init(_begin: Vector3, _end: Vector3) -> null", "description": "", "arguments": [ { - "name": "begin", + "name": "_begin", "type": "Vector3" }, { - "name": "end", + "name": "_end", "type": "Vector3" } ] @@ -255,7 +547,7 @@ "name": "_init", "return_type": "null", "rpc_mode": 0, - "signature": "func _init(waypoints: Array, is_open: bool = false) -> null", + "signature": "func _init(waypoints: Array, _is_open: bool = false) -> null", "description": "", "arguments": [ { @@ -263,7 +555,7 @@ "type": "Array" }, { - "name": "is_open", + "name": "_is_open", "type": "bool", "default_value": false } @@ -355,15 +647,15 @@ ] }, { - "name": "GSTProximity", - "path": "res://src/Proximities/GSTProximity.gd", + "name": "GSAIFollowPath", + "path": "res://src/Behaviors/GSAIFollowPath.gd", "extends_class": [ - "Reference" + "GSAIArrive" ], "extends_file": "", "icon": "", - "signature": "class GSTProximity", - "description": " Base container type that stores data to find the neighbors of an agent.\n", + "signature": "class GSAIFollowPath", + "description": " Produces a linear acceleration that moves the agent along the specified path.\n", "sub_classes": [ ], @@ -372,168 +664,130 @@ ], "members": [ { - "name": "agent", - "data_type": "GSTSteeringAgent", + "name": "path", + "data_type": "GSAIPath", "default_value": null, "setter": "", "getter": "", "export": false, - "signature": "var agent: GSTSteeringAgent", - "description": " The owning agent whose neighbors are found in the group\n" + "signature": "var path: GSAIPath", + "description": " The path to follow and travel along.\n" }, { - "name": "agents", - "data_type": "Array", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var agents: Array", - "description": " The agents who are part of this group and could be potential neighbors\n" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, agents: Array) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "agents", - "type": "Array" - } - ] - }, - { - "name": "_find_neighbors", - "return_type": "int", - "rpc_mode": 0, - "signature": "func _find_neighbors(callback: FuncRef) -> int", - "description": " Returns a number of neighbors based on a `callback` function.\n\n `_find_neighbors` calls `callback` for each agent in the `agents` array and\n adds one to the count if its `callback` returns true.\n tags: virtual\n", - "arguments": [ - { - "name": "callback", - "type": "FuncRef" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTInfiniteProximity", - "path": "res://src/Proximities/GSTInfiniteProximity.gd", - "extends_class": [ - "GSTProximity" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTInfiniteProximity", - "description": " Determines any agent that is in the specified list as being neighbors with the\n owner agent, regardless of distance.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, agents: Array) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "agents", - "type": "Array" - } - ] - }, - { - "name": "_find_neighbors", - "return_type": "int", - "rpc_mode": 0, - "signature": "func _find_neighbors(callback: FuncRef) -> int", - "description": " Returns a number of neighbors based on a `callback` function.\n\n `_find_neighbors` calls `callback` for each agent in the `agents` array and\n adds one to the count if its `callback` returns true.\n tags: virtual\n", - "arguments": [ - { - "name": "callback", - "type": "FuncRef" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTRadiusProximity", - "path": "res://src/Proximities/GSTRadiusProximity.gd", - "extends_class": [ - "GSTProximity" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTRadiusProximity", - "description": " Determines any agent that is in the specified list as being neighbors with the owner agent if\n they lie within the specified radius.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "radius", + "name": "path_offset", "data_type": "float", "default_value": null, "setter": "", "getter": "", "export": false, - "signature": "var radius: float", - "description": " The radius around the owning agent to find neighbors in\n" + "signature": "var path_offset: float", + "description": " The distance along the path to generate the next target position.\n" }, { - "name": "_last_frame", - "data_type": "int", + "name": "is_arrive_enabled", + "data_type": "bool", "default_value": null, "setter": "", "getter": "", "export": false, - "signature": "var _last_frame: int", - "description": "" + "signature": "var is_arrive_enabled: bool", + "description": " Whether to use `GSAIArrive` behavior on an open path.\n" }, { - "name": "_scene_tree", - "data_type": "SceneTree", + "name": "prediction_time", + "data_type": "float", "default_value": null, "setter": "", "getter": "", "export": false, - "signature": "var _scene_tree: SceneTree", + "signature": "var prediction_time: float", + "description": " The amount of time in the future to predict the owning agent's position along\n the path. Setting it to 0.0 will force non-predictive path following.\n" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent, _path: GSAIPath, _path_offset: float = 0, _prediction_time: float = 0) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + }, + { + "name": "_path", + "type": "GSAIPath" + }, + { + "name": "_path_offset", + "type": "float", + "default_value": 0 + }, + { + "name": "_prediction_time", + "type": "float", + "default_value": 0 + } + ] + }, + { + "name": "_calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _calculate_steering(acceleration: GSAITargetAcceleration) -> null", + "description": "", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAISeparation", + "path": "res://src/Behaviors/GSAISeparation.gd", + "extends_class": [ + "GSAIGroupBehavior" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAISeparation", + "description": " Calculates an acceleration that repels the agent from its neighbors in the\n given `GSAIProximity`.\n\n The acceleration is an average based on all neighbors, multiplied by a\n strength decreasing by the inverse square law in relation to distance, and it\n accumulates.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "decay_coefficient", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var decay_coefficient: float", + "description": " The coefficient to calculate how fast the separation strength decays with distance.\n" + }, + { + "name": "_acceleration", + "data_type": "GSAITargetAcceleration", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _acceleration: GSAITargetAcceleration", "description": "" } ], @@ -545,33 +799,42 @@ "name": "_init", "return_type": "null", "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, agents: Array, radius: float) -> null", + "signature": "func _init(agent: GSAISteeringAgent, proximity: GSAIProximity) -> null", "description": "", "arguments": [ { "name": "agent", - "type": "GSTSteeringAgent" + "type": "GSAISteeringAgent" }, { - "name": "agents", - "type": "Array" - }, - { - "name": "radius", - "type": "float" + "name": "proximity", + "type": "GSAIProximity" } ] }, { - "name": "_find_neighbors", - "return_type": "int", + "name": "_calculate_steering", + "return_type": "null", "rpc_mode": 0, - "signature": "func _find_neighbors(callback: FuncRef) -> int", - "description": " Returns a number of neighbors based on a `callback` function.\n\n `_find_neighbors` calls `callback` for each agent in the `agents` array that lie within\n the radius around the owning agent and adds one to the count if its `callback` returns true.\n tags: virtual\n", + "signature": "func _calculate_steering(acceleration: GSAITargetAcceleration) -> null", + "description": "", "arguments": [ { - "name": "callback", - "type": "FuncRef" + "name": "acceleration", + "type": "GSAITargetAcceleration" + } + ] + }, + { + "name": "_report_neighbor", + "return_type": "bool", + "rpc_mode": 0, + "signature": "func _report_neighbor(neighbor: GSAISteeringAgent) -> bool", + "description": " Callback for the proximity to call when finding neighbors. Determines the amount of\n acceleration that `neighbor` imposes based on its distance from the owner agent.\n tags: virtual\n", + "arguments": [ + { + "name": "neighbor", + "type": "GSAISteeringAgent" } ] } @@ -581,15 +844,1987 @@ ] }, { - "name": "GSTSteeringAgent", - "path": "res://src/GSTSteeringAgent.gd", + "name": "GSAIMatchOrientation", + "path": "res://src/Behaviors/GSAIMatchOrientation.gd", "extends_class": [ - "GSTAgentLocation" + "GSAISteeringBehavior" ], "extends_file": "", "icon": "", - "signature": "class GSTSteeringAgent", - "description": " Adds velocity, speed, and size data to `GSTAgentLocation`.\n\n It is the character's responsibility to keep this information up to date for\n the steering toolkit to work correctly.\n", + "signature": "class GSAIMatchOrientation", + "description": " Calculates an angular acceleration to match an agent's orientation to that of\n its target. Attempts to make the agent arrive with zero remaining angular\n velocity.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "target", + "data_type": "GSAIAgentLocation", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var target: GSAIAgentLocation", + "description": " The target orientation for the behavior to try and match rotations to.\n" + }, + { + "name": "alignment_tolerance", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var alignment_tolerance: float", + "description": " The amount of distance in radians for the behavior to consider itself close\n enough to be matching the target agent's rotation.\n" + }, + { + "name": "deceleration_radius", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var deceleration_radius: float", + "description": " The amount of distance in radians from the goal to start slowing down.\n" + }, + { + "name": "time_to_reach", + "data_type": "float", + "default_value": 0.1, + "setter": "", + "getter": "", + "export": false, + "signature": "var time_to_reach: float = 0.1", + "description": " The amount of time to reach the target velocity\n" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent, _target: GSAIAgentLocation) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + }, + { + "name": "_target", + "type": "GSAIAgentLocation" + } + ] + }, + { + "name": "_match_orientation", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _match_orientation(acceleration: GSAITargetAcceleration, desired_orientation: float) -> null", + "description": "", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + }, + { + "name": "desired_orientation", + "type": "float" + } + ] + }, + { + "name": "_calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _calculate_steering(acceleration: GSAITargetAcceleration) -> null", + "description": "", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIFlee", + "path": "res://src/Behaviors/GSAIFlee.gd", + "extends_class": [ + "GSAISeek" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIFlee", + "description": " Calculates acceleration to take an agent directly away from a target agent.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent, target: GSAIAgentLocation) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + }, + { + "name": "target", + "type": "GSAIAgentLocation" + } + ] + }, + { + "name": "_calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _calculate_steering(acceleration: GSAITargetAcceleration) -> null", + "description": "", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAICohesion", + "path": "res://src/Behaviors/GSAICohesion.gd", + "extends_class": [ + "GSAIGroupBehavior" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAICohesion", + "description": " Calculates an acceleration that attempts to move the agent towards the center\n of mass of the agents in the area defined by the `GSAIProximity`.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "_center_of_mass", + "data_type": "Vector3", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _center_of_mass: Vector3", + "description": "" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent, proximity: GSAIProximity) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + }, + { + "name": "proximity", + "type": "GSAIProximity" + } + ] + }, + { + "name": "_calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _calculate_steering(acceleration: GSAITargetAcceleration) -> null", + "description": "", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + } + ] + }, + { + "name": "_report_neighbor", + "return_type": "bool", + "rpc_mode": 0, + "signature": "func _report_neighbor(neighbor: GSAISteeringAgent) -> bool", + "description": " Callback for the proximity to call when finding neighbors. Adds `neighbor`'s position\n to the center of mass of the group.\n tags: virtual\n", + "arguments": [ + { + "name": "neighbor", + "type": "GSAISteeringAgent" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAILookWhereYouGo", + "path": "res://src/Behaviors/GSAILookWhereYouGo.gd", + "extends_class": [ + "GSAIMatchOrientation" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAILookWhereYouGo", + "description": " Calculates an angular acceleration to match an agent's orientation to its\n direction of travel.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + } + ] + }, + { + "name": "_calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _calculate_steering(accel: GSAITargetAcceleration) -> null", + "description": "", + "arguments": [ + { + "name": "accel", + "type": "GSAITargetAcceleration" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIArrive", + "path": "res://src/Behaviors/GSAIArrive.gd", + "extends_class": [ + "GSAISteeringBehavior" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIArrive", + "description": " Calculates acceleration to take an agent to its target's location. The\n calculation attempts to arrive with zero remaining velocity.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "target", + "data_type": "GSAIAgentLocation", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var target: GSAIAgentLocation", + "description": " Target agent to arrive to.\n" + }, + { + "name": "arrival_tolerance", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var arrival_tolerance: float", + "description": " Distance from the target for the agent to be considered successfully\n arrived.\n" + }, + { + "name": "deceleration_radius", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var deceleration_radius: float", + "description": " Distance from the target for the agent to begin slowing down.\n" + }, + { + "name": "time_to_reach", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var time_to_reach: float", + "description": " Represents the time it takes to change acceleration.\n" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent, _target: GSAIAgentLocation) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + }, + { + "name": "_target", + "type": "GSAIAgentLocation" + } + ] + }, + { + "name": "_arrive", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _arrive(acceleration: GSAITargetAcceleration, target_position: Vector3) -> null", + "description": "", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + }, + { + "name": "target_position", + "type": "Vector3" + } + ] + }, + { + "name": "_calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _calculate_steering(acceleration: GSAITargetAcceleration) -> null", + "description": "", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIBlend", + "path": "res://src/Behaviors/GSAIBlend.gd", + "extends_class": [ + "GSAISteeringBehavior" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIBlend", + "description": " Blends multiple steering behaviors into one, and returns a weighted\n acceleration from their calculations.\n\n Stores the behaviors internally as dictionaries of the form\n {\n \tbehavior : GSAISteeringBehavior,\n \tweight : float\n }\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "_behaviors", + "data_type": "Array", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _behaviors: Array", + "description": "" + }, + { + "name": "_accel", + "data_type": "GSAITargetAcceleration", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _accel: GSAITargetAcceleration", + "description": "" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + } + ] + }, + { + "name": "add", + "return_type": "null", + "rpc_mode": 0, + "signature": "func add(behavior: GSAISteeringBehavior, weight: float) -> null", + "description": " Appends a behavior to the internal array along with its `weight`.\n", + "arguments": [ + { + "name": "behavior", + "type": "GSAISteeringBehavior" + }, + { + "name": "weight", + "type": "float" + } + ] + }, + { + "name": "get_behavior_at", + "return_type": "Dictionary", + "rpc_mode": 0, + "signature": "func get_behavior_at(index: int) -> Dictionary", + "description": " Returns the behavior at the specified `index`, or an empty `Dictionary` if\n none was found.\n", + "arguments": [ + { + "name": "index", + "type": "int" + } + ] + }, + { + "name": "_calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _calculate_steering(blended_accel: GSAITargetAcceleration) -> null", + "description": "", + "arguments": [ + { + "name": "blended_accel", + "type": "GSAITargetAcceleration" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIEvade", + "path": "res://src/Behaviors/GSAIEvade.gd", + "extends_class": [ + "GSAIPursue" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIEvade", + "description": " Calculates acceleration to take an agent away from where a target agent is\n moving.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "var", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent, target: GSAISteeringAgent, predict_time_max: float = 1)", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + }, + { + "name": "target", + "type": "GSAISteeringAgent" + }, + { + "name": "predict_time_max", + "type": "float", + "default_value": 1 + } + ] + }, + { + "name": "_get_modified_acceleration", + "return_type": "float", + "rpc_mode": 0, + "signature": "func _get_modified_acceleration() -> float", + "description": "", + "arguments": [ + + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIPriority", + "path": "res://src/Behaviors/GSAIPriority.gd", + "extends_class": [ + "GSAISteeringBehavior" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIPriority", + "description": " Container for multiple behaviors that returns the result of the first child\n behavior with non-zero acceleration.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "_behaviors", + "data_type": "Array", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _behaviors: Array", + "description": "" + }, + { + "name": "last_selected_index", + "data_type": "int", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var last_selected_index: int", + "description": " The index of the last behavior the container prioritized.\n" + }, + { + "name": "zero_threshold", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var zero_threshold: float", + "description": " If a behavior's acceleration is lower than this threshold, the container\n considers it has an acceleration of zero.\n" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent, _zero_threshold: float = 0.001) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + }, + { + "name": "_zero_threshold", + "type": "float", + "default_value": 0.001 + } + ] + }, + { + "name": "add", + "return_type": "null", + "rpc_mode": 0, + "signature": "func add(behavior: GSAISteeringBehavior) -> null", + "description": " Appends a steering behavior as a child of this container.\n", + "arguments": [ + { + "name": "behavior", + "type": "GSAISteeringBehavior" + } + ] + }, + { + "name": "get_behavior_at", + "return_type": "GSAISteeringBehavior", + "rpc_mode": 0, + "signature": "func get_behavior_at(index: int) -> GSAISteeringBehavior", + "description": " Returns the behavior at the position in the pool referred to by `index`, or\n `null` if no behavior was found.\n", + "arguments": [ + { + "name": "index", + "type": "int" + } + ] + }, + { + "name": "_calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _calculate_steering(accel: GSAITargetAcceleration) -> null", + "description": "", + "arguments": [ + { + "name": "accel", + "type": "GSAITargetAcceleration" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAISeek", + "path": "res://src/Behaviors/GSAISeek.gd", + "extends_class": [ + "GSAISteeringBehavior" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAISeek", + "description": " Calculates an acceleration to take an agent to a target agent's position\n directly.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "target", + "data_type": "GSAIAgentLocation", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var target: GSAIAgentLocation", + "description": " The target that the behavior aims to move the agent to.\n" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent, _target: GSAIAgentLocation) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + }, + { + "name": "_target", + "type": "GSAIAgentLocation" + } + ] + }, + { + "name": "_calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _calculate_steering(acceleration: GSAITargetAcceleration) -> null", + "description": "", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIFace", + "path": "res://src/Behaviors/GSAIFace.gd", + "extends_class": [ + "GSAIMatchOrientation" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIFace", + "description": " Calculates angular acceleration to rotate a target to face its target's\n position. The behavior attemps to arrive with zero remaining angular velocity.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent, target: GSAIAgentLocation) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + }, + { + "name": "target", + "type": "GSAIAgentLocation" + } + ] + }, + { + "name": "_face", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _face(acceleration: GSAITargetAcceleration, target_position: Vector3) -> null", + "description": "", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + }, + { + "name": "target_position", + "type": "Vector3" + } + ] + }, + { + "name": "_calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _calculate_steering(acceleration: GSAITargetAcceleration) -> null", + "description": "", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIAvoidCollisions", + "path": "res://src/Behaviors/GSAIAvoidCollisions.gd", + "extends_class": [ + "GSAIGroupBehavior" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIAvoidCollisions", + "description": " Steers the agent to avoid obstacles in its path. Approximates obstacles as\n spheres.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "_first_neighbor", + "data_type": "GSAISteeringAgent", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _first_neighbor: GSAISteeringAgent", + "description": "" + }, + { + "name": "_shortest_time", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _shortest_time: float", + "description": "" + }, + { + "name": "_first_minimum_separation", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _first_minimum_separation: float", + "description": "" + }, + { + "name": "_first_distance", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _first_distance: float", + "description": "" + }, + { + "name": "_first_relative_position", + "data_type": "Vector3", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _first_relative_position: Vector3", + "description": "" + }, + { + "name": "_first_relative_velocity", + "data_type": "Vector3", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _first_relative_velocity: Vector3", + "description": "" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent, proximity: GSAIProximity) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + }, + { + "name": "proximity", + "type": "GSAIProximity" + } + ] + }, + { + "name": "_calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _calculate_steering(acceleration: GSAITargetAcceleration) -> null", + "description": "", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + } + ] + }, + { + "name": "_report_neighbor", + "return_type": "bool", + "rpc_mode": 0, + "signature": "func _report_neighbor(neighbor: GSAISteeringAgent) -> bool", + "description": " Callback for the proximity to call when finding neighbors. Keeps track of every `neighbor`\n that was found but only keeps the one the owning agent will most likely collide with.\n tags: virtual\n", + "arguments": [ + { + "name": "neighbor", + "type": "GSAISteeringAgent" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIPursue", + "path": "res://src/Behaviors/GSAIPursue.gd", + "extends_class": [ + "GSAISteeringBehavior" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIPursue", + "description": " Calculates an acceleration to make an agent intercept another based on the\n target agent's movement.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "target", + "data_type": "GSAISteeringAgent", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var target: GSAISteeringAgent", + "description": " The target agent that the behavior is trying to intercept.\n" + }, + { + "name": "predict_time_max", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var predict_time_max: float", + "description": " The maximum amount of time in the future the behavior predicts the target's\n location.\n" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _init(agent: GSAISteeringAgent, _target: GSAISteeringAgent, _predict_time_max: float = 1) -> null", + "description": "", + "arguments": [ + { + "name": "agent", + "type": "GSAISteeringAgent" + }, + { + "name": "_target", + "type": "GSAISteeringAgent" + }, + { + "name": "_predict_time_max", + "type": "float", + "default_value": 1 + } + ] + }, + { + "name": "_calculate_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _calculate_steering(acceleration: GSAITargetAcceleration) -> null", + "description": "", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + } + ] + }, + { + "name": "_get_modified_acceleration", + "return_type": "float", + "rpc_mode": 0, + "signature": "func _get_modified_acceleration() -> float", + "description": "", + "arguments": [ + + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAITargetAcceleration", + "path": "res://src/GSAITargetAcceleration.gd", + "extends_class": [ + + ], + "extends_file": "", + "icon": "", + "signature": "class GSAITargetAcceleration", + "description": " A desired linear and angular amount of acceleration requested by the steering\n system.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "linear", + "data_type": "Vector3", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var linear: Vector3", + "description": " Linear acceleration\n" + }, + { + "name": "angular", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var angular: float", + "description": " Angular acceleration\n" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "set_zero", + "return_type": "null", + "rpc_mode": 0, + "signature": "func set_zero() -> null", + "description": " Sets the linear and angular components to 0.\n", + "arguments": [ + + ] + }, + { + "name": "add_scaled_accel", + "return_type": "null", + "rpc_mode": 0, + "signature": "func add_scaled_accel(accel: GSAITargetAcceleration, scalar: float) -> null", + "description": " Adds `accel`'s components, multiplied by `scalar`, to this one.\n", + "arguments": [ + { + "name": "accel", + "type": "GSAITargetAcceleration" + }, + { + "name": "scalar", + "type": "float" + } + ] + }, + { + "name": "get_magnitude_squared", + "return_type": "float", + "rpc_mode": 0, + "signature": "func get_magnitude_squared() -> float", + "description": " Returns the squared magnitude of the linear and angular components.\n", + "arguments": [ + + ] + }, + { + "name": "get_magnitude", + "return_type": "float", + "rpc_mode": 0, + "signature": "func get_magnitude() -> float", + "description": " Returns the magnitude of the linear and angular components.\n", + "arguments": [ + + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIRigidBody2DAgent", + "path": "res://src/Agents/GSAIRigidBody2DAgent.gd", + "extends_class": [ + "GSAISpecializedAgent" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIRigidBody2DAgent", + "description": " A specialized steering agent that updates itself every frame so the user does\n not have to using a RigidBody2D\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "body", + "data_type": "RigidBody2D", + "default_value": null, + "setter": "_set_body", + "getter": "", + "export": false, + "signature": "var body: RigidBody2D", + "description": " The RigidBody2D to keep track of\n" + }, + { + "name": "_last_position", + "data_type": "Vector2", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _last_position: Vector2", + "description": "" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "var", + "rpc_mode": 0, + "signature": "func _init(_body: RigidBody2D) -> var", + "description": "", + "arguments": [ + { + "name": "_body", + "type": "RigidBody2D" + } + ] + }, + { + "name": "_apply_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _apply_steering(acceleration: GSAITargetAcceleration, _delta: float) -> null", + "description": " Moves the agent's `body` by target `acceleration`.\n tags: virtual\n", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + }, + { + "name": "_delta", + "type": "float" + } + ] + }, + { + "name": "_set_body", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _set_body(value: RigidBody2D) -> null", + "description": "", + "arguments": [ + { + "name": "value", + "type": "RigidBody2D" + } + ] + }, + { + "name": "_on_body_ready", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _on_body_ready() -> null", + "description": "", + "arguments": [ + + ] + }, + { + "name": "_on_SceneTree_frame", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _on_SceneTree_frame() -> null", + "description": "", + "arguments": [ + + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIKinematicBody3DAgent", + "path": "res://src/Agents/GSAIKinematicBody3DAgent.gd", + "extends_class": [ + "GSAISpecializedAgent" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIKinematicBody3DAgent", + "description": " A specialized steering agent that updates itself every frame so the user does\n not have to using a KinematicBody\n", + "sub_classes": [ + + ], + "constants": [ + { + "name": "MovementType", + "value": { + "SLIDE": 0, + "COLLIDE": 1, + "POSITION": 2 + }, + "data_type": "Dictionary", + "signature": "const MovementType: Dictionary = {\"COLLIDE\":1,\"POSITION\":2,\"SLIDE\":0}", + "description": "" + } + ], + "members": [ + { + "name": "body", + "data_type": "KinematicBody", + "default_value": null, + "setter": "_set_body", + "getter": "", + "export": false, + "signature": "var body: KinematicBody", + "description": " The KinematicBody to keep track of\n" + }, + { + "name": "movement_type", + "data_type": "int", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var movement_type: int", + "description": " The type of movement the body executes\n" + }, + { + "name": "_last_position", + "data_type": "Vector3", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _last_position: Vector3", + "description": "" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "var", + "rpc_mode": 0, + "signature": "func _init(_body: KinematicBody, _movement_type: int) -> var", + "description": "", + "arguments": [ + { + "name": "_body", + "type": "KinematicBody" + }, + { + "name": "_movement_type", + "type": "int" + } + ] + }, + { + "name": "_apply_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _apply_steering(acceleration: GSAITargetAcceleration, delta: float) -> null", + "description": " Moves the agent's `body` by target `acceleration`.\n tags: virtual\n", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + }, + { + "name": "delta", + "type": "float" + } + ] + }, + { + "name": "_apply_sliding_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _apply_sliding_steering(accel: Vector3) -> null", + "description": "", + "arguments": [ + { + "name": "accel", + "type": "Vector3" + } + ] + }, + { + "name": "_apply_collide_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _apply_collide_steering(accel: Vector3, delta: float) -> null", + "description": "", + "arguments": [ + { + "name": "accel", + "type": "Vector3" + }, + { + "name": "delta", + "type": "float" + } + ] + }, + { + "name": "_apply_position_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _apply_position_steering(accel: Vector3, delta: float) -> null", + "description": "", + "arguments": [ + { + "name": "accel", + "type": "Vector3" + }, + { + "name": "delta", + "type": "float" + } + ] + }, + { + "name": "_apply_orientation_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _apply_orientation_steering(angular_acceleration: float, delta: float) -> null", + "description": "", + "arguments": [ + { + "name": "angular_acceleration", + "type": "float" + }, + { + "name": "delta", + "type": "float" + } + ] + }, + { + "name": "_set_body", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _set_body(value: KinematicBody) -> null", + "description": "", + "arguments": [ + { + "name": "value", + "type": "KinematicBody" + } + ] + }, + { + "name": "_on_SceneTree_physics_frame", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _on_SceneTree_physics_frame() -> null", + "description": "", + "arguments": [ + + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAISpecializedAgent", + "path": "res://src/Agents/GSAISpecializedAgent.gd", + "extends_class": [ + "GSAISteeringAgent" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAISpecializedAgent", + "description": " A base class for a specialized steering agent that updates itself every frame\n so the user does not have to. All other specialized agents derive from this.\n tags: abstract\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "calculate_velocities", + "data_type": "bool", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var calculate_velocities: bool", + "description": " If `true`, calculates linear and angular velocities based on the previous\n frame. When `false`, the user must keep those values updated.\n" + }, + { + "name": "apply_linear_drag", + "data_type": "bool", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var apply_linear_drag: bool", + "description": " If `true`, interpolates the current linear velocity towards 0 by the \n `linear_drag_percentage` value.\n Does not apply to `RigidBody` and `RigidBody2D` nodes.\n" + }, + { + "name": "apply_angular_drag", + "data_type": "bool", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var apply_angular_drag: bool", + "description": " If `true`, interpolates the current angular velocity towards 0 by the\n `angular_drag_percentage` value.\n Does not apply to `RigidBody` and `RigidBody2D` nodes.\n" + }, + { + "name": "linear_drag_percentage", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var linear_drag_percentage: float", + "description": " The percentage between the current linear velocity and 0 to interpolate by if\n `apply_linear_drag` is true.\n Does not apply to `RigidBody` and `RigidBody2D` nodes.\n" + }, + { + "name": "angular_drag_percentage", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var angular_drag_percentage: float", + "description": " The percentage between the current angular velocity and 0 to interpolate by if\n `apply_angular_drag` is true.\n Does not apply to `RigidBody` and `RigidBody2D` nodes.\n" + }, + { + "name": "_last_orientation", + "data_type": "float", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _last_orientation: float", + "description": "" + }, + { + "name": "_body_type", + "data_type": "int", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _body_type: int", + "description": "" + }, + { + "name": "_applied_steering", + "data_type": "bool", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _applied_steering: bool", + "description": "" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_apply_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _apply_steering(_acceleration: GSAITargetAcceleration, _delta: float) -> null", + "description": " Moves the agent's body by target `acceleration`.\n tags: virtual\n", + "arguments": [ + { + "name": "_acceleration", + "type": "GSAITargetAcceleration" + }, + { + "name": "_delta", + "type": "float" + } + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIRigidBody3DAgent", + "path": "res://src/Agents/GSAIRigidBody3DAgent.gd", + "extends_class": [ + "GSAISpecializedAgent" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIRigidBody3DAgent", + "description": " A specialized steering agent that updates itself every frame so the user does\n not have to using a RigidBody\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + { + "name": "body", + "data_type": "RigidBody", + "default_value": null, + "setter": "_set_body", + "getter": "", + "export": false, + "signature": "var body: RigidBody", + "description": " The RigidBody to keep track of\n" + }, + { + "name": "_last_position", + "data_type": "Vector3", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _last_position: Vector3", + "description": "" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "var", + "rpc_mode": 0, + "signature": "func _init(_body: RigidBody) -> var", + "description": "", + "arguments": [ + { + "name": "_body", + "type": "RigidBody" + } + ] + }, + { + "name": "_apply_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _apply_steering(acceleration: GSAITargetAcceleration, _delta: float) -> null", + "description": " Moves the agent's `body` by target `acceleration`.\n tags: virtual\n", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + }, + { + "name": "_delta", + "type": "float" + } + ] + }, + { + "name": "_set_body", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _set_body(value: RigidBody) -> null", + "description": "", + "arguments": [ + { + "name": "value", + "type": "RigidBody" + } + ] + }, + { + "name": "_on_body_ready", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _on_body_ready() -> null", + "description": "", + "arguments": [ + + ] + }, + { + "name": "_on_SceneTree_frame", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _on_SceneTree_frame() -> null", + "description": "", + "arguments": [ + + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIKinematicBody2DAgent", + "path": "res://src/Agents/GSAIKinematicBody2DAgent.gd", + "extends_class": [ + "GSAISpecializedAgent" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIKinematicBody2DAgent", + "description": " A specialized steering agent that updates itself every frame so the user does\n not have to using a KinematicBody2D\n", + "sub_classes": [ + + ], + "constants": [ + { + "name": "MovementType", + "value": { + "SLIDE": 0, + "COLLIDE": 1, + "POSITION": 2 + }, + "data_type": "Dictionary", + "signature": "const MovementType: Dictionary = {\"COLLIDE\":1,\"POSITION\":2,\"SLIDE\":0}", + "description": "" + } + ], + "members": [ + { + "name": "body", + "data_type": "KinematicBody2D", + "default_value": null, + "setter": "_set_body", + "getter": "", + "export": false, + "signature": "var body: KinematicBody2D", + "description": " The KinematicBody2D to keep track of\n" + }, + { + "name": "movement_type", + "data_type": "int", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var movement_type: int", + "description": " The type of movement the body executes\n" + }, + { + "name": "_last_position", + "data_type": "Vector2", + "default_value": null, + "setter": "", + "getter": "", + "export": false, + "signature": "var _last_position: Vector2", + "description": "" + } + ], + "signals": [ + + ], + "methods": [ + { + "name": "_init", + "return_type": "var", + "rpc_mode": 0, + "signature": "func _init(_body: KinematicBody2D, _movement_type: int) -> var", + "description": "", + "arguments": [ + { + "name": "_body", + "type": "KinematicBody2D" + }, + { + "name": "_movement_type", + "type": "int" + } + ] + }, + { + "name": "_apply_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _apply_steering(acceleration: GSAITargetAcceleration, delta: float) -> null", + "description": " Moves the agent's `body` by target `acceleration`.\n tags: virtual\n", + "arguments": [ + { + "name": "acceleration", + "type": "GSAITargetAcceleration" + }, + { + "name": "delta", + "type": "float" + } + ] + }, + { + "name": "_apply_sliding_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _apply_sliding_steering(accel: Vector3) -> null", + "description": "", + "arguments": [ + { + "name": "accel", + "type": "Vector3" + } + ] + }, + { + "name": "_apply_collide_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _apply_collide_steering(accel: Vector3, delta: float) -> null", + "description": "", + "arguments": [ + { + "name": "accel", + "type": "Vector3" + }, + { + "name": "delta", + "type": "float" + } + ] + }, + { + "name": "_apply_position_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _apply_position_steering(accel: Vector3, delta: float) -> null", + "description": "", + "arguments": [ + { + "name": "accel", + "type": "Vector3" + }, + { + "name": "delta", + "type": "float" + } + ] + }, + { + "name": "_apply_orientation_steering", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _apply_orientation_steering(angular_acceleration: float, delta: float) -> null", + "description": "", + "arguments": [ + { + "name": "angular_acceleration", + "type": "float" + }, + { + "name": "delta", + "type": "float" + } + ] + }, + { + "name": "_set_body", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _set_body(value: KinematicBody2D) -> null", + "description": "", + "arguments": [ + { + "name": "value", + "type": "KinematicBody2D" + } + ] + }, + { + "name": "_on_SceneTree_physics_frame", + "return_type": "null", + "rpc_mode": 0, + "signature": "func _on_SceneTree_physics_frame() -> null", + "description": "", + "arguments": [ + + ] + } + ], + "static_functions": [ + + ] + }, + { + "name": "GSAIUtils", + "path": "res://src/GSAIUtils.gd", + "extends_class": [ + + ], + "extends_file": "", + "icon": "", + "signature": "class GSAIUtils", + "description": " Math and vector utility functions.\n", + "sub_classes": [ + + ], + "constants": [ + + ], + "members": [ + + ], + "signals": [ + + ], + "methods": [ + + ], + "static_functions": [ + { + "name": "clampedv3", + "return_type": "Vector3", + "rpc_mode": 0, + "signature": "func clampedv3(vector: Vector3, limit: float) -> Vector3", + "description": " Returns the `vector` with its length capped to `limit`.\n", + "arguments": [ + { + "name": "vector", + "type": "Vector3" + }, + { + "name": "limit", + "type": "float" + } + ] + }, + { + "name": "vector3_to_angle", + "return_type": "float", + "rpc_mode": 0, + "signature": "func vector3_to_angle(vector: Vector3) -> float", + "description": " Returns an angle in radians between the positive X axis and the `vector`.\n\n This assumes orientation for 2D agents or 3D agents that are upright and\n rotate around the Y axis.\n", + "arguments": [ + { + "name": "vector", + "type": "Vector3" + } + ] + }, + { + "name": "angle_to_vector2", + "return_type": "Vector2", + "rpc_mode": 0, + "signature": "func angle_to_vector2(angle: float) -> Vector2", + "description": " Returns a directional vector from the given orientation angle.\n \n This assumes orientation for 2D agents or 3D agents that are upright and\n rotate around the Y axis.\n", + "arguments": [ + { + "name": "angle", + "type": "float" + } + ] + }, + { + "name": "to_vector2", + "return_type": "Vector2", + "rpc_mode": 0, + "signature": "func to_vector2(vector: Vector3) -> Vector2", + "description": " Returns a vector2 with `vector`'s x and y components.\n", + "arguments": [ + { + "name": "vector", + "type": "Vector3" + } + ] + }, + { + "name": "to_vector3", + "return_type": "Vector3", + "rpc_mode": 0, + "signature": "func to_vector3(vector: Vector2) -> Vector3", + "description": " Returns a vector3 with `vector`'s x and y components and 0 in z.\n", + "arguments": [ + { + "name": "vector", + "type": "Vector2" + } + ] + } + ] + }, + { + "name": "GSAISteeringAgent", + "path": "res://src/GSAISteeringAgent.gd", + "extends_class": [ + "GSAIAgentLocation" + ], + "extends_file": "", + "icon": "", + "signature": "class GSAISteeringAgent", + "description": " Adds velocity, speed, and size data to `GSAIAgentLocation`.\n\n It is the character's responsibility to keep this information up to date for\n the steering toolkit to work correctly.\n", "sub_classes": [ ], @@ -699,2155 +2934,14 @@ ] }, { - "name": "GSTFollowPath", - "path": "res://src/Behaviors/GSTFollowPath.gd", - "extends_class": [ - "GSTArrive" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTFollowPath", - "description": " Produces a linear acceleration that moves the agent along the specified path.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "path", - "data_type": "GSTPath", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var path: GSTPath", - "description": " The path to follow and travel along.\n" - }, - { - "name": "path_offset", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var path_offset: float", - "description": " The distance along the path to generate the next target position.\n" - }, - { - "name": "is_arrive_enabled", - "data_type": "bool", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var is_arrive_enabled: bool", - "description": " Whether to use `GSTArrive` behavior on an open path.\n" - }, - { - "name": "prediction_time", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var prediction_time: float", - "description": " The amount of time in the future to predict the owning agent's position along\n the path. Setting it to 0.0 will force non-predictive path following.\n" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, path: GSTPath, path_offset: float = 0, prediction_time: float = 0) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "path", - "type": "GSTPath" - }, - { - "name": "path_offset", - "type": "float", - "default_value": 0 - }, - { - "name": "prediction_time", - "type": "float", - "default_value": 0 - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(acceleration: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTEvade", - "path": "res://src/Behaviors/GSTEvade.gd", - "extends_class": [ - "GSTPursue" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTEvade", - "description": " Calculates acceleration to take an agent away from where a target agent is\n moving.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "var", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, target: GSTSteeringAgent, predict_time_max: float = 1)", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "target", - "type": "GSTSteeringAgent" - }, - { - "name": "predict_time_max", - "type": "float", - "default_value": 1 - } - ] - }, - { - "name": "_get_modified_acceleration", - "return_type": "float", - "rpc_mode": 0, - "signature": "func _get_modified_acceleration() -> float", - "description": "", - "arguments": [ - - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTAvoidCollisions", - "path": "res://src/Behaviors/GSTAvoidCollisions.gd", - "extends_class": [ - "GSTGroupBehavior" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTAvoidCollisions", - "description": " Steers the agent to avoid obstacles in its path. Approximates obstacles as\n spheres.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "_first_neighbor", - "data_type": "GSTSteeringAgent", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _first_neighbor: GSTSteeringAgent", - "description": "" - }, - { - "name": "_shortest_time", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _shortest_time: float", - "description": "" - }, - { - "name": "_first_minimum_separation", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _first_minimum_separation: float", - "description": "" - }, - { - "name": "_first_distance", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _first_distance: float", - "description": "" - }, - { - "name": "_first_relative_position", - "data_type": "Vector3", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _first_relative_position: Vector3", - "description": "" - }, - { - "name": "_first_relative_velocity", - "data_type": "Vector3", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _first_relative_velocity: Vector3", - "description": "" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, proximity: GSTProximity) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "proximity", - "type": "GSTProximity" - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(acceleration: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - } - ] - }, - { - "name": "_report_neighbor", - "return_type": "bool", - "rpc_mode": 0, - "signature": "func _report_neighbor(neighbor: GSTSteeringAgent) -> bool", - "description": " Callback for the proximity to call when finding neighbors. Keeps track of every `neighbor`\n that was found but only keeps the one the owning agent will most likely collide with.\n tags: virtual\n", - "arguments": [ - { - "name": "neighbor", - "type": "GSTSteeringAgent" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTCohesion", - "path": "res://src/Behaviors/GSTCohesion.gd", - "extends_class": [ - "GSTGroupBehavior" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTCohesion", - "description": " Calculates an acceleration that attempts to move the agent towards the center\n of mass of the agents in the area defined by the `GSTProximity`.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "_center_of_mass", - "data_type": "Vector3", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _center_of_mass: Vector3", - "description": "" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, proximity: GSTProximity) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "proximity", - "type": "GSTProximity" - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(acceleration: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - } - ] - }, - { - "name": "_report_neighbor", - "return_type": "bool", - "rpc_mode": 0, - "signature": "func _report_neighbor(neighbor: GSTSteeringAgent) -> bool", - "description": " Callback for the proximity to call when finding neighbors. Adds `neighbor`'s position\n to the center of mass of the group.\n tags: virtual\n", - "arguments": [ - { - "name": "neighbor", - "type": "GSTSteeringAgent" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTSeparation", - "path": "res://src/Behaviors/GSTSeparation.gd", - "extends_class": [ - "GSTGroupBehavior" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTSeparation", - "description": " Calculates an acceleration that repels the agent from its neighbors in the\n given `GSTProximity`.\n\n The acceleration is an average based on all neighbors, multiplied by a\n strength decreasing by the inverse square law in relation to distance, and it\n accumulates.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "decay_coefficient", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var decay_coefficient: float", - "description": " The coefficient to calculate how fast the separation strength decays with distance.\n" - }, - { - "name": "_acceleration", - "data_type": "GSTTargetAcceleration", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _acceleration: GSTTargetAcceleration", - "description": "" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, proximity: GSTProximity) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "proximity", - "type": "GSTProximity" - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(acceleration: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - } - ] - }, - { - "name": "_report_neighbor", - "return_type": "bool", - "rpc_mode": 0, - "signature": "func _report_neighbor(neighbor: GSTSteeringAgent) -> bool", - "description": " Callback for the proximity to call when finding neighbors. Determines the amount of\n acceleration that `neighbor` imposes based on its distance from the owner agent.\n tags: virtual\n", - "arguments": [ - { - "name": "neighbor", - "type": "GSTSteeringAgent" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTBlend", - "path": "res://src/Behaviors/GSTBlend.gd", - "extends_class": [ - "GSTSteeringBehavior" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTBlend", - "description": " Blends multiple steering behaviors into one, and returns a weighted\n acceleration from their calculations.\n\n Stores the behaviors internally as dictionaries of the form\n {\n \tbehavior : GSTSteeringBehavior,\n \tweight : float\n }\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "_behaviors", - "data_type": "Array", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _behaviors: Array", - "description": "" - }, - { - "name": "_accel", - "data_type": "GSTTargetAcceleration", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _accel: GSTTargetAcceleration", - "description": "" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - } - ] - }, - { - "name": "add", - "return_type": "null", - "rpc_mode": 0, - "signature": "func add(behavior: GSTSteeringBehavior, weight: float) -> null", - "description": " Appends a behavior to the internal array along with its `weight`.\n", - "arguments": [ - { - "name": "behavior", - "type": "GSTSteeringBehavior" - }, - { - "name": "weight", - "type": "float" - } - ] - }, - { - "name": "get_behavior_at", - "return_type": "Dictionary", - "rpc_mode": 0, - "signature": "func get_behavior_at(index: int) -> Dictionary", - "description": " Returns the behavior at the specified `index`, or an empty `Dictionary` if\n none was found.\n", - "arguments": [ - { - "name": "index", - "type": "int" - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(blended_accel: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "blended_accel", - "type": "GSTTargetAcceleration" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTPriority", - "path": "res://src/Behaviors/GSTPriority.gd", - "extends_class": [ - "GSTSteeringBehavior" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTPriority", - "description": " Container for multiple behaviors that returns the result of the first child\n behavior with non-zero acceleration.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "_behaviors", - "data_type": "Array", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _behaviors: Array", - "description": "" - }, - { - "name": "last_selected_index", - "data_type": "int", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var last_selected_index: int", - "description": " The index of the last behavior the container prioritized.\n" - }, - { - "name": "zero_threshold", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var zero_threshold: float", - "description": " If a behavior's acceleration is lower than this threshold, the container\n considers it has an acceleration of zero.\n" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, zero_threshold: float = 0.001) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "zero_threshold", - "type": "float", - "default_value": 0.001 - } - ] - }, - { - "name": "add", - "return_type": "null", - "rpc_mode": 0, - "signature": "func add(behavior: GSTSteeringBehavior) -> null", - "description": " Appends a steering behavior as a child of this container.\n", - "arguments": [ - { - "name": "behavior", - "type": "GSTSteeringBehavior" - } - ] - }, - { - "name": "get_behavior_at", - "return_type": "GSTSteeringBehavior", - "rpc_mode": 0, - "signature": "func get_behavior_at(index: int) -> GSTSteeringBehavior", - "description": " Returns the behavior at the position in the pool referred to by `index`, or\n `null` if no behavior was found.\n", - "arguments": [ - { - "name": "index", - "type": "int" - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(accel: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "accel", - "type": "GSTTargetAcceleration" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTPursue", - "path": "res://src/Behaviors/GSTPursue.gd", - "extends_class": [ - "GSTSteeringBehavior" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTPursue", - "description": " Calculates an acceleration to make an agent intercept another based on the\n target agent's movement.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "target", - "data_type": "GSTSteeringAgent", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var target: GSTSteeringAgent", - "description": " The target agent that the behavior is trying to intercept.\n" - }, - { - "name": "predict_time_max", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var predict_time_max: float", - "description": " The maximum amount of time in the future the behavior predicts the target's\n location.\n" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, target: GSTSteeringAgent, predict_time_max: float = 1) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "target", - "type": "GSTSteeringAgent" - }, - { - "name": "predict_time_max", - "type": "float", - "default_value": 1 - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(acceleration: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - } - ] - }, - { - "name": "_get_modified_acceleration", - "return_type": "float", - "rpc_mode": 0, - "signature": "func _get_modified_acceleration() -> float", - "description": "", - "arguments": [ - - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTLookWhereYouGo", - "path": "res://src/Behaviors/GSTLookWhereYouGo.gd", - "extends_class": [ - "GSTMatchOrientation" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTLookWhereYouGo", - "description": " Calculates an angular acceleration to match an agent's orientation to its\n direction of travel.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(accel: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "accel", - "type": "GSTTargetAcceleration" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTFace", - "path": "res://src/Behaviors/GSTFace.gd", - "extends_class": [ - "GSTMatchOrientation" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTFace", - "description": " Calculates angular acceleration to rotate a target to face its target's\n position. The behavior attemps to arrive with zero remaining angular velocity.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, target: GSTAgentLocation) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "target", - "type": "GSTAgentLocation" - } - ] - }, - { - "name": "_face", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _face(acceleration: GSTTargetAcceleration, target_position: Vector3) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - }, - { - "name": "target_position", - "type": "Vector3" - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(acceleration: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTMatchOrientation", - "path": "res://src/Behaviors/GSTMatchOrientation.gd", - "extends_class": [ - "GSTSteeringBehavior" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTMatchOrientation", - "description": " Calculates an angular acceleration to match an agent's orientation to that of\n its target. Attempts to make the agent arrive with zero remaining angular\n velocity.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "target", - "data_type": "GSTAgentLocation", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var target: GSTAgentLocation", - "description": " The target orientation for the behavior to try and match rotations to.\n" - }, - { - "name": "alignment_tolerance", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var alignment_tolerance: float", - "description": " The amount of distance in radians for the behavior to consider itself close\n enough to be matching the target agent's rotation.\n" - }, - { - "name": "deceleration_radius", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var deceleration_radius: float", - "description": " The amount of distance in radians from the goal to start slowing down.\n" - }, - { - "name": "time_to_reach", - "data_type": "float", - "default_value": 0.1, - "setter": "", - "getter": "", - "export": false, - "signature": "var time_to_reach: float = 0.1", - "description": " The amount of time to reach the target velocity\n" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, target: GSTAgentLocation) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "target", - "type": "GSTAgentLocation" - } - ] - }, - { - "name": "_match_orientation", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _match_orientation(acceleration: GSTTargetAcceleration, desired_orientation: float) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - }, - { - "name": "desired_orientation", - "type": "float" - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(acceleration: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTArrive", - "path": "res://src/Behaviors/GSTArrive.gd", - "extends_class": [ - "GSTSteeringBehavior" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTArrive", - "description": " Calculates acceleration to take an agent to its target's location. The\n calculation attempts to arrive with zero remaining velocity.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "target", - "data_type": "GSTAgentLocation", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var target: GSTAgentLocation", - "description": " Target agent to arrive to.\n" - }, - { - "name": "arrival_tolerance", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var arrival_tolerance: float", - "description": " Distance from the target for the agent to be considered successfully\n arrived.\n" - }, - { - "name": "deceleration_radius", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var deceleration_radius: float", - "description": " Distance from the target for the agent to begin slowing down.\n" - }, - { - "name": "time_to_reach", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var time_to_reach: float", - "description": " Represents the time it takes to change acceleration.\n" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, target: GSTAgentLocation) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "target", - "type": "GSTAgentLocation" - } - ] - }, - { - "name": "_arrive", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _arrive(acceleration: GSTTargetAcceleration, target_position: Vector3) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - }, - { - "name": "target_position", - "type": "Vector3" - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(acceleration: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTFlee", - "path": "res://src/Behaviors/GSTFlee.gd", - "extends_class": [ - "GSTSeek" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTFlee", - "description": " Calculates acceleration to take an agent directly away from a target agent.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, target: GSTAgentLocation) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "target", - "type": "GSTAgentLocation" - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(acceleration: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTSeek", - "path": "res://src/Behaviors/GSTSeek.gd", - "extends_class": [ - "GSTSteeringBehavior" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTSeek", - "description": " Calculates an acceleration to take an agent to a target agent's position\n directly.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "target", - "data_type": "GSTAgentLocation", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var target: GSTAgentLocation", - "description": " The target that the behavior aims to move the agent to.\n" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, target: GSTAgentLocation) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "target", - "type": "GSTAgentLocation" - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(acceleration: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTSteeringBehavior", - "path": "res://src/GSTSteeringBehavior.gd", + "name": "GSAIAgentLocation", + "path": "res://src/GSAIAgentLocation.gd", "extends_class": [ ], "extends_file": "", "icon": "", - "signature": "class GSTSteeringBehavior", - "description": " Base class for all steering behaviors.\n\n Steering behaviors calculate the linear and the angular acceleration to be\n to the agent that owns them.\n\n The `calculate_steering` function is the entry point for all behaviors.\n Individual steering behaviors encapsulate the steering logic.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "is_enabled", - "data_type": "bool", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var is_enabled: bool", - "description": " If `false`, all calculations return zero amounts of acceleration.\n" - }, - { - "name": "agent", - "data_type": "GSTSteeringAgent", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var agent: GSTSteeringAgent", - "description": " The AI agent on which the steering behavior bases its calculations.\n" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - } - ] - }, - { - "name": "calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func calculate_steering(acceleration: GSTTargetAcceleration) -> null", - "description": " Sets the `acceleration` with the behavior's desired amount of acceleration.\n", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - } - ] - }, - { - "name": "_calculate_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _calculate_steering(acceleration: GSTTargetAcceleration) -> null", - "description": "", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTRigidBodyAgent", - "path": "res://src/Agents/GSTRigidBodyAgent.gd", - "extends_class": [ - "GSTSpecializedAgent" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTRigidBodyAgent", - "description": " A specialized steering agent that updates itself every frame so the user does\n not have to using a RigidBody\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "body", - "data_type": "RigidBody", - "default_value": null, - "setter": "_set_body", - "getter": "", - "export": false, - "signature": "var body: RigidBody", - "description": " The RigidBody to keep track of\n" - }, - { - "name": "_last_position", - "data_type": "Vector3", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _last_position: Vector3", - "description": "" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "var", - "rpc_mode": 0, - "signature": "func _init(body: RigidBody) -> var", - "description": "", - "arguments": [ - { - "name": "body", - "type": "RigidBody" - } - ] - }, - { - "name": "_apply_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _apply_steering(acceleration: GSTTargetAcceleration, delta: float) -> null", - "description": " Moves the agent's `body` by target `acceleration`.\n tags: virtual\n", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - }, - { - "name": "delta", - "type": "float" - } - ] - }, - { - "name": "_set_body", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _set_body(value: RigidBody) -> null", - "description": "", - "arguments": [ - { - "name": "value", - "type": "RigidBody" - } - ] - }, - { - "name": "_on_body_ready", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _on_body_ready() -> null", - "description": "", - "arguments": [ - - ] - }, - { - "name": "_on_SceneTree_frame", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _on_SceneTree_frame() -> null", - "description": "", - "arguments": [ - - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTKinematicBodyAgent", - "path": "res://src/Agents/GSTKinematicBodyAgent.gd", - "extends_class": [ - "GSTSpecializedAgent" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTKinematicBodyAgent", - "description": " A specialized steering agent that updates itself every frame so the user does\n not have to using a KinematicBody\n", - "sub_classes": [ - - ], - "constants": [ - { - "name": "MovementType", - "value": { - "SLIDE": 0, - "COLLIDE": 1, - "POSITION": 2 - }, - "data_type": "Dictionary", - "signature": "const MovementType: Dictionary = {\"COLLIDE\":1,\"POSITION\":2,\"SLIDE\":0}", - "description": "" - } - ], - "members": [ - { - "name": "body", - "data_type": "KinematicBody", - "default_value": null, - "setter": "_set_body", - "getter": "", - "export": false, - "signature": "var body: KinematicBody", - "description": " The KinematicBody to keep track of\n" - }, - { - "name": "movement_type", - "data_type": "int", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var movement_type: int", - "description": " The type of movement the body executes\n" - }, - { - "name": "_last_position", - "data_type": "Vector3", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _last_position: Vector3", - "description": "" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "var", - "rpc_mode": 0, - "signature": "func _init(body: KinematicBody, movement_type: int) -> var", - "description": "", - "arguments": [ - { - "name": "body", - "type": "KinematicBody" - }, - { - "name": "movement_type", - "type": "int" - } - ] - }, - { - "name": "_apply_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _apply_steering(acceleration: GSTTargetAcceleration, delta: float) -> null", - "description": " Moves the agent's `body` by target `acceleration`.\n tags: virtual\n", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - }, - { - "name": "delta", - "type": "float" - } - ] - }, - { - "name": "_apply_sliding_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _apply_sliding_steering(accel: Vector3) -> null", - "description": "", - "arguments": [ - { - "name": "accel", - "type": "Vector3" - } - ] - }, - { - "name": "_apply_collide_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _apply_collide_steering(accel: Vector3, delta: float) -> null", - "description": "", - "arguments": [ - { - "name": "accel", - "type": "Vector3" - }, - { - "name": "delta", - "type": "float" - } - ] - }, - { - "name": "_apply_position_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _apply_position_steering(accel: Vector3, delta: float) -> null", - "description": "", - "arguments": [ - { - "name": "accel", - "type": "Vector3" - }, - { - "name": "delta", - "type": "float" - } - ] - }, - { - "name": "_apply_orientation_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _apply_orientation_steering(angular_acceleration: float, delta: float) -> null", - "description": "", - "arguments": [ - { - "name": "angular_acceleration", - "type": "float" - }, - { - "name": "delta", - "type": "float" - } - ] - }, - { - "name": "_set_body", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _set_body(value: KinematicBody) -> null", - "description": "", - "arguments": [ - { - "name": "value", - "type": "KinematicBody" - } - ] - }, - { - "name": "_on_SceneTree_physics_frame", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _on_SceneTree_physics_frame() -> null", - "description": "", - "arguments": [ - - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTSpecializedAgent", - "path": "res://src/Agents/GSTSpecializedAgent.gd", - "extends_class": [ - "GSTSteeringAgent" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTSpecializedAgent", - "description": " A base class for a specialized steering agent that updates itself every frame\n so the user does not have to. All other specialized agents derive from this.\n tags: abstract\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "calculate_velocities", - "data_type": "bool", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var calculate_velocities: bool", - "description": " If `true`, calculates linear and angular velocities based on the previous\n frame. When `false`, the user must keep those values updated.\n" - }, - { - "name": "apply_linear_drag", - "data_type": "bool", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var apply_linear_drag: bool", - "description": " If `true` and `calculate_velocities` is true, interpolates\n the current linear velocity towards 0 by the `linear_drag_percentage` value.\n Does not apply to `RigidBody` and `RigidBody2D` nodes.\n" - }, - { - "name": "apply_angular_drag", - "data_type": "bool", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var apply_angular_drag: bool", - "description": " If `true` and `calculate_velocities` is true, interpolates\n the current angular velocity towards 0 by the `angular_drag_percentage` value.\n Does not apply to `RigidBody` and `RigidBody2D` nodes.\n" - }, - { - "name": "linear_drag_percentage", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var linear_drag_percentage: float", - "description": " The percentage between the current linear velocity and 0 to interpolate by if\n `calculate_velocities` and `apply_linear_drag` are true.\n Does not apply to `RigidBody` and `RigidBody2D` nodes.\n" - }, - { - "name": "angular_drag_percentage", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var angular_drag_percentage: float", - "description": " The percentage between the current angular velocity and 0 to interpolate by if\n `calculate_velocities` and `apply_angular_drag` are true.\n Does not apply to `RigidBody` and `RigidBody2D` nodes.\n" - }, - { - "name": "_last_orientation", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _last_orientation: float", - "description": "" - }, - { - "name": "_body_type", - "data_type": "int", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _body_type: int", - "description": "" - }, - { - "name": "_applied_steering", - "data_type": "bool", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _applied_steering: bool", - "description": "" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_apply_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _apply_steering(acceleration: GSTTargetAcceleration, delta: float) -> null", - "description": " Moves the agent's body by target `acceleration`.\n tags: virtual\n", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - }, - { - "name": "delta", - "type": "float" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTRigidBody2DAgent", - "path": "res://src/Agents/GSTRigidBody2DAgent.gd", - "extends_class": [ - "GSTSpecializedAgent" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTRigidBody2DAgent", - "description": " A specialized steering agent that updates itself every frame so the user does\n not have to using a RigidBody2D\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "body", - "data_type": "RigidBody2D", - "default_value": null, - "setter": "_set_body", - "getter": "", - "export": false, - "signature": "var body: RigidBody2D", - "description": " The RigidBody2D to keep track of\n" - }, - { - "name": "_last_position", - "data_type": "Vector2", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _last_position: Vector2", - "description": "" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "var", - "rpc_mode": 0, - "signature": "func _init(body: RigidBody2D) -> var", - "description": "", - "arguments": [ - { - "name": "body", - "type": "RigidBody2D" - } - ] - }, - { - "name": "_apply_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _apply_steering(acceleration: GSTTargetAcceleration, delta: float) -> null", - "description": " Moves the agent's `body` by target `acceleration`.\n tags: virtual\n", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - }, - { - "name": "delta", - "type": "float" - } - ] - }, - { - "name": "_set_body", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _set_body(value: RigidBody2D) -> null", - "description": "", - "arguments": [ - { - "name": "value", - "type": "RigidBody2D" - } - ] - }, - { - "name": "_on_body_ready", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _on_body_ready() -> null", - "description": "", - "arguments": [ - - ] - }, - { - "name": "_on_SceneTree_frame", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _on_SceneTree_frame() -> null", - "description": "", - "arguments": [ - - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTKinematicBody2DAgent", - "path": "res://src/Agents/GSTKinematicBody2DAgent.gd", - "extends_class": [ - "GSTSpecializedAgent" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTKinematicBody2DAgent", - "description": " A specialized steering agent that updates itself every frame so the user does\n not have to using a KinematicBody2D\n", - "sub_classes": [ - - ], - "constants": [ - { - "name": "MovementType", - "value": { - "SLIDE": 0, - "COLLIDE": 1, - "POSITION": 2 - }, - "data_type": "Dictionary", - "signature": "const MovementType: Dictionary = {\"COLLIDE\":1,\"POSITION\":2,\"SLIDE\":0}", - "description": "" - } - ], - "members": [ - { - "name": "body", - "data_type": "KinematicBody2D", - "default_value": null, - "setter": "_set_body", - "getter": "", - "export": false, - "signature": "var body: KinematicBody2D", - "description": " The KinematicBody2D to keep track of\n" - }, - { - "name": "movement_type", - "data_type": "int", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var movement_type: int", - "description": " The type of movement the body executes\n" - }, - { - "name": "_last_position", - "data_type": "Vector2", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _last_position: Vector2", - "description": "" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "var", - "rpc_mode": 0, - "signature": "func _init(body: KinematicBody2D, movement_type: int) -> var", - "description": "", - "arguments": [ - { - "name": "body", - "type": "KinematicBody2D" - }, - { - "name": "movement_type", - "type": "int" - } - ] - }, - { - "name": "_apply_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _apply_steering(acceleration: GSTTargetAcceleration, delta: float) -> null", - "description": " Moves the agent's `body` by target `acceleration`.\n tags: virtual\n", - "arguments": [ - { - "name": "acceleration", - "type": "GSTTargetAcceleration" - }, - { - "name": "delta", - "type": "float" - } - ] - }, - { - "name": "_apply_sliding_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _apply_sliding_steering(accel: Vector3) -> null", - "description": "", - "arguments": [ - { - "name": "accel", - "type": "Vector3" - } - ] - }, - { - "name": "_apply_collide_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _apply_collide_steering(accel: Vector3, delta: float) -> null", - "description": "", - "arguments": [ - { - "name": "accel", - "type": "Vector3" - }, - { - "name": "delta", - "type": "float" - } - ] - }, - { - "name": "_apply_position_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _apply_position_steering(accel: Vector3, delta: float) -> null", - "description": "", - "arguments": [ - { - "name": "accel", - "type": "Vector3" - }, - { - "name": "delta", - "type": "float" - } - ] - }, - { - "name": "_apply_orientation_steering", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _apply_orientation_steering(angular_acceleration: float, delta: float) -> null", - "description": "", - "arguments": [ - { - "name": "angular_acceleration", - "type": "float" - }, - { - "name": "delta", - "type": "float" - } - ] - }, - { - "name": "_set_body", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _set_body(value: KinematicBody2D) -> null", - "description": "", - "arguments": [ - { - "name": "value", - "type": "KinematicBody2D" - } - ] - }, - { - "name": "_on_SceneTree_physics_frame", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _on_SceneTree_physics_frame() -> null", - "description": "", - "arguments": [ - - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTGroupBehavior", - "path": "res://src/GSTGroupBehavior.gd", - "extends_class": [ - "GSTSteeringBehavior" - ], - "extends_file": "", - "icon": "", - "signature": "class GSTGroupBehavior", - "description": " Base type for group-based steering behaviors.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "proximity", - "data_type": "GSTProximity", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var proximity: GSTProximity", - "description": " Container to find neighbors of the agent and calculate group behavior.\n" - }, - { - "name": "_callback", - "data_type": "FuncRef", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var _callback: FuncRef", - "description": "" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "_init", - "return_type": "null", - "rpc_mode": 0, - "signature": "func _init(agent: GSTSteeringAgent, proximity: GSTProximity) -> null", - "description": "", - "arguments": [ - { - "name": "agent", - "type": "GSTSteeringAgent" - }, - { - "name": "proximity", - "type": "GSTProximity" - } - ] - }, - { - "name": "_report_neighbor", - "return_type": "bool", - "rpc_mode": 0, - "signature": "func _report_neighbor(neighbor: GSTSteeringAgent) -> bool", - "description": " Internal callback for the behavior to define whether or not a member is\n relevant\n tags: virtual\n", - "arguments": [ - { - "name": "neighbor", - "type": "GSTSteeringAgent" - } - ] - } - ], - "static_functions": [ - - ] - }, - { - "name": "GSTAgentLocation", - "path": "res://src/GSTAgentLocation.gd", - "extends_class": [ - - ], - "extends_file": "", - "icon": "", - "signature": "class GSTAgentLocation", + "signature": "class GSAIAgentLocation", "description": " Represents an agent with only a location and an orientation.\n", "sub_classes": [ @@ -2885,100 +2979,6 @@ ], "static_functions": [ - ] - }, - { - "name": "GSTTargetAcceleration", - "path": "res://src/GSTTargetAcceleration.gd", - "extends_class": [ - - ], - "extends_file": "", - "icon": "", - "signature": "class GSTTargetAcceleration", - "description": " A desired linear and angular amount of acceleration requested by the steering\n system.\n", - "sub_classes": [ - - ], - "constants": [ - - ], - "members": [ - { - "name": "linear", - "data_type": "Vector3", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var linear: Vector3", - "description": " Linear acceleration\n" - }, - { - "name": "angular", - "data_type": "float", - "default_value": null, - "setter": "", - "getter": "", - "export": false, - "signature": "var angular: float", - "description": " Angular acceleration\n" - } - ], - "signals": [ - - ], - "methods": [ - { - "name": "set_zero", - "return_type": "null", - "rpc_mode": 0, - "signature": "func set_zero() -> null", - "description": " Sets the linear and angular components to 0.\n", - "arguments": [ - - ] - }, - { - "name": "add_scaled_accel", - "return_type": "null", - "rpc_mode": 0, - "signature": "func add_scaled_accel(accel: GSTTargetAcceleration, scalar: float) -> null", - "description": " Adds `accel`'s components, multiplied by `scalar`, to this one.\n", - "arguments": [ - { - "name": "accel", - "type": "GSTTargetAcceleration" - }, - { - "name": "scalar", - "type": "float" - } - ] - }, - { - "name": "get_magnitude_squared", - "return_type": "float", - "rpc_mode": 0, - "signature": "func get_magnitude_squared() -> float", - "description": " Returns the squared magnitude of the linear and angular components.\n", - "arguments": [ - - ] - }, - { - "name": "get_magnitude", - "return_type": "float", - "rpc_mode": 0, - "signature": "func get_magnitude() -> float", - "description": " Returns the magnitude of the linear and angular components.\n", - "arguments": [ - - ] - } - ], - "static_functions": [ - ] } ] \ No newline at end of file