botaccount
/
limboai
mirror of https://github.com/limbonaut/limboai.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: Improve task example

This commit is contained in:
Serhii Snitsaruk 2023-10-31 15:03:38 +01:00
parent 793dba1e07
commit 6e6e9985b2
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/getting-started.md
View File

@ -32,8 +32,9 @@ Check out the `BTTask` class documentation in the editor, which provides the fou
@tool @tool
extends BTCondition extends BTCondition
## InRange checks if agent is within a range of target. ## InRange condition checks if the agent is within a range of target, defined by
## Returns SUCCESS if agent is within a range of target; ## distance_min and distance_max.
## Returns SUCCESS if agent is within the defined range;
## otherwise, returns FAILURE. ## otherwise, returns FAILURE.
@export var distance_min: float @export var distance_min: float
@ -44,16 +45,19 @@ var _min_distance_squared: float
var _max_distance_squared: float var _max_distance_squared: float
# Called to generate a display name for the task.
func _generate_name() -> String: func _generate_name() -> String:
return "InRange (%d, %d) of %s" % [distance_min, distance_max, return "InRange (%d, %d) of %s" % [distance_min, distance_max,
LimboUtility.decorate_var(target_var)] LimboUtility.decorate_var(target_var)]
# Called once to initialize the task.
func _setup() -> void: func _setup() -> void:
_min_distance_squared = distance_min * distance_min _min_distance_squared = distance_min * distance_min
_max_distance_squared = distance_max * distance_max _max_distance_squared = distance_max * distance_max
# Called when task is executed.
func _tick(_delta: float) -> int: func _tick(_delta: float) -> int:
var target: Node2D = blackboard.get_var(target_var, null) var target: Node2D = blackboard.get_var(target_var, null)
if not is_instance_valid(target): if not is_instance_valid(target):