Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix debugger tab runtime update #301

Merged
merged 1 commit into from
Jan 21, 2024
Merged

Fix debugger tab runtime update #301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions addons/beehave/debug/debugger_tab.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
@tool
class_name BeehaveDebuggerTab extends PanelContainer


const BeehaveUtils := preload("res://addons/beehave/utils/utils.gd")


signal make_floating()
signal make_floating

const BeehaveGraphEdit := preload("graph_edit.gd")
const TREE_ICON := preload("../icons/tree.svg")
Expand Down Expand Up @@ -77,11 +75,16 @@ func stop() -> void:


func register_tree(data: Dictionary) -> void:
var idx := item_list.add_item(data.name, TREE_ICON)
item_list.set_item_tooltip(idx, data.path)
item_list.set_item_metadata(idx, data.id)
if not active_trees.has(data.id):
var idx := item_list.add_item(data.name, TREE_ICON)
item_list.set_item_tooltip(idx, data.path)
item_list.set_item_metadata(idx, data.id)

active_trees[data.id] = data

if active_tree_id == data.id.to_int():
graph.beehave_tree = data


func unregister_tree(instance_id: int) -> void:
var id := str(instance_id)
Expand All @@ -98,7 +101,9 @@ func unregister_tree(instance_id: int) -> void:

func _on_toggle_button_pressed(toggle_button: Button) -> void:
item_list.visible = !item_list.visible
toggle_button.icon = get_theme_icon(&"Back" if item_list.visible else &"Forward", &"EditorIcons")
toggle_button.icon = get_theme_icon(
&"Back" if item_list.visible else &"Forward", &"EditorIcons"
)


func _on_item_selected(idx: int) -> void:
Expand Down
6 changes: 1 addition & 5 deletions addons/beehave/nodes/beehave_node.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,7 @@ class_name BeehaveNode extends Node
## A node in the behavior tree. Every node must return `SUCCESS`, `FAILURE` or
## `RUNNING` when ticked.

enum {
SUCCESS,
FAILURE,
RUNNING
}
enum { SUCCESS, FAILURE, RUNNING }


func _get_configuration_warnings() -> PackedStringArray:
Expand Down
105 changes: 59 additions & 46 deletions addons/beehave/nodes/beehave_tree.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,13 @@ class_name BeehaveTree extends Node

## Controls the flow of execution of the entire behavior tree.

enum {
SUCCESS,
FAILURE,
RUNNING
}
enum { SUCCESS, FAILURE, RUNNING }

enum ProcessThread {
IDLE,
PHYSICS
}
enum ProcessThread { IDLE, PHYSICS }

signal tree_enabled
signal tree_disabled


## Whether this behavior tree should be enabled or not.
@export var enabled: bool = true:
set(value):
Expand All @@ -34,14 +26,12 @@ signal tree_disabled
get:
return enabled


## How often the tree should tick, in frames. The default value of 1 means
## How often the tree should tick, in frames. The default value of 1 means
## tick() runs every frame.
@export var tick_rate: int = 1


## An optional node path this behavior tree should apply to.
@export_node_path var actor_node_path : NodePath:
@export_node_path var actor_node_path: NodePath:
set(anp):
actor_node_path = anp
if actor_node_path != null and str(actor_node_path) != "..":
Expand All @@ -51,19 +41,16 @@ signal tree_disabled
if Engine.is_editor_hint():
update_configuration_warnings()


## Whether to run this tree in a physics or idle thread.
@export var process_thread:ProcessThread = ProcessThread.PHYSICS:
@export var process_thread: ProcessThread = ProcessThread.PHYSICS:
set(value):
process_thread = value
set_physics_process(enabled and process_thread == ProcessThread.PHYSICS)
set_process(enabled and process_thread == ProcessThread.IDLE)



## Custom blackboard node. An internal blackboard will be used
## if no blackboard is provided explicitly.
@export var blackboard:Blackboard:
@export var blackboard: Blackboard:
set(b):
blackboard = b
if blackboard and _internal_blackboard:
Expand All @@ -86,40 +73,43 @@ signal tree_disabled
@export var custom_monitor = false:
set(b):
custom_monitor = b
if custom_monitor and _process_time_metric_name != '':
Performance.add_custom_monitor(_process_time_metric_name, _get_process_time_metric_value)
if custom_monitor and _process_time_metric_name != "":
Performance.add_custom_monitor(
_process_time_metric_name, _get_process_time_metric_value
)
_get_global_metrics().register_tree(self)
else:
if _process_time_metric_name != '':
if _process_time_metric_name != "":
# Remove tree metric from the engine
Performance.remove_custom_monitor(_process_time_metric_name)
_get_global_metrics().unregister_tree(self)

BeehaveDebuggerMessages.unregister_tree(get_instance_id())


@export var actor : Node:
@export var actor: Node:
set(a):
actor = a
if actor == null:
actor = get_parent()
if Engine.is_editor_hint():
update_configuration_warnings()


var status : int = -1
var last_tick : int = 0
var status: int = -1
var last_tick: int = 0

var _internal_blackboard: Blackboard
var _process_time_metric_name : String
var _process_time_metric_value : float = 0.0
var _process_time_metric_name: String
var _process_time_metric_value: float = 0.0
var _can_send_message: bool = false


func _ready() -> void:
get_tree().node_added.connect(_on_scene_tree_node_added_removed.bind(true))
get_tree().node_removed.connect(_on_scene_tree_node_added_removed.bind(false))

if not process_thread:
process_thread = ProcessThread.PHYSICS

if actor_node_path:
actor = get_node(actor_node_path)
else:
Expand All @@ -128,13 +118,15 @@ func _ready() -> void:
if not blackboard:
# invoke setter to auto-initialise the blackboard.
self.blackboard = null

# Get the name of the parent node name for metric
_process_time_metric_name = "beehave [microseconds]/process_time_%s-%s" % [actor.name, get_instance_id()]
_process_time_metric_name = (
"beehave [microseconds]/process_time_%s-%s" % [actor.name, get_instance_id()]
)

set_physics_process(enabled and process_thread == ProcessThread.PHYSICS)
set_process(enabled and process_thread == ProcessThread.IDLE)

# Register custom metric to the engine
if custom_monitor and not Engine.is_editor_hint():
Performance.add_custom_monitor(_process_time_metric_name, _get_process_time_metric_value)
Expand All @@ -150,10 +142,22 @@ func _ready() -> void:
last_tick = randi_range(0, tick_rate - 1)


func _on_scene_tree_node_added_removed(node: Node, is_added: bool) -> void:
if Engine.is_editor_hint():
return

if node is BeehaveNode and is_ancestor_of(node):
var sgnal := node.ready if is_added else node.tree_exited
sgnal.connect(
func() -> void: BeehaveDebuggerMessages.register_tree(_get_debugger_data(self)),
CONNECT_ONE_SHOT
)


func _physics_process(_delta: float) -> void:
_process_internally()


func _process(_delta: float) -> void:
_process_internally()

Expand All @@ -163,9 +167,9 @@ func _process_internally() -> void:
return

if last_tick < tick_rate - 1:
last_tick += 1
last_tick += 1
return

last_tick = 0

# Start timing for metric
Expand Down Expand Up @@ -207,8 +211,8 @@ func tick() -> int:


func _get_configuration_warnings() -> PackedStringArray:
var warnings:PackedStringArray = []
var warnings: PackedStringArray = []

if actor == null:
warnings.append("Configure target node on tree")

Expand All @@ -234,7 +238,9 @@ func get_last_condition() -> ConditionLeaf:
## Returns the status of the last executed condition
func get_last_condition_status() -> String:
if blackboard.has_value("last_condition_status", str(actor.get_instance_id())):
var status = blackboard.get_value("last_condition_status", null, str(actor.get_instance_id()))
var status = blackboard.get_value(
"last_condition_status", null, str(actor.get_instance_id())
)
if status == SUCCESS:
return "SUCCESS"
elif status == FAILURE:
Expand All @@ -243,6 +249,7 @@ func get_last_condition_status() -> String:
return "RUNNING"
return ""


## interrupts this tree if anything was running
func interrupt() -> void:
if self.get_child_count() != 0:
Expand All @@ -263,7 +270,7 @@ func disable() -> void:

func _exit_tree() -> void:
if custom_monitor:
if _process_time_metric_name != '':
if _process_time_metric_name != "":
# Remove tree metric from the engine
Performance.remove_custom_monitor(_process_time_metric_name)
_get_global_metrics().unregister_tree(self)
Expand All @@ -277,9 +284,15 @@ func _get_process_time_metric_value() -> int:


func _get_debugger_data(node: Node) -> Dictionary:
if not node is BeehaveTree and not node is BeehaveNode:
if not (node is BeehaveTree or node is BeehaveNode):
return {}
var data := { path = node.get_path(), name = node.name, type = node.get_class_name(), id = str(node.get_instance_id()) }

var data := {
path = node.get_path(),
name = node.name,
type = node.get_class_name(),
id = str(node.get_instance_id())
}
if node.get_child_count() > 0:
data.children = []
for child in node.get_children():
Expand All @@ -291,14 +304,14 @@ func _get_debugger_data(node: Node) -> Dictionary:

func get_class_name() -> Array[StringName]:
return [&"BeehaveTree"]


# required to avoid lifecycle issues on initial load
# due to loading order problems with autoloads
func _get_global_metrics() -> Node:
return get_tree().root.get_node("BeehaveGlobalMetrics")


# required to avoid lifecycle issues on initial load
# due to loading order problems with autoloads
func _get_global_debugger() -> Node:
Expand Down
2 changes: 1 addition & 1 deletion addons/beehave/nodes/composites/sequence.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ func tick(actor: Node, blackboard: Blackboard) -> int:

if c.get_index() < successful_index:
continue

if c != running_child:
c.before_run(actor, blackboard)

Expand Down
Loading