The diagrams below are generated from docs/generated/*.mmd and embedded here. For exact method signatures, params, and return types see api-spec.json; the diagrams show shortened names for readability.
Overview — architecture-overview.mmd
Shows the main classes and how they relate, without methods. Use it to see which subsystem owns what before reading the detailed diagrams.
classDiagram
GdPAIPlanScheduler -- GdPAIAgent : schedules plans for
GdPAIAgent -- GdPAIWorldNode : reads world state from
GdPAIWorldNode -- GdPAIBlackboard : holds world state in
GdPAIAgent -- GdPAIBlackboard : holds agent state in
GdPAIBlackboard -- GdPAIObjectData : tracks entities via
GdPAIObjectData -- Action : provides actions via
GdPAIAgent -- Action : plans and executes
GdPAIAgent -- Goal : pursues
GdPAIAgent -- GdPAIAgentConfig : configured by
GdPAIAgentConfig -- GdPAIBehaviorConfig : bundles behaviors via
Runtime — architecture-runtime.mmd
Shows the planning loop: how Agent, Scheduler, WorldNode, Blackboard, and the Rust bridge connect, with key methods only. Use it when tracing a live plan; see api-spec.json for full signatures.
classDiagram
GdPAIPlanScheduler <-- GdPAIAgent : submits plan to
GdPAIAgent --> GdPAIWorldNode : reads via get_world_state
GdPAIWorldNode --> GdPAIBlackboard : holds world state
GdPAIAgent --> GdPAIBlackboard : holds agent blackboard
GdPAIAgent --> GdPAIRustBridge : uses internally
GdPAIRustBridge --> GdPAIPlanScheduler : serialized payloads
GdPAIAutoload --> GdPAIPlanScheduler : get_scheduler
GdPlanningAIPlugin --> GdPAIAutoload : registers singleton
class GdPAIAgent {
+signal plan_delivered(result)
+get_current_goal()
+get_current_plan()
+manually_start_plan()
+set_planning_strategy()
}
class GdPAIPlanScheduler {
+submit_plan()
+process_callbacks()
+cancel_agent_jobs()
+cancel_all_jobs()
+get_pool_status()
+get_engine_version()
}
class GdPAIWorldNode {
+blackboard_plan
+get_world_state()
}
class GdPAIBlackboard {
+get_property()
+set_property()
+has_property()
+erase_property()
+clone_for_simulation()
}
class GdPAIRustBridge {
+serialize_actions()
+serialize_goals()
+deserialize_plan_result()
}
class GdPAIAutoload {
+get_scheduler()
}
class GdPlanningAIPlugin {
<<EditorPlugin>>
}
Authoring — architecture-authoring.mmd
Shows the content classes (ObjectData, Action, Goal, PropertyUpdater) and how BehaviorConfig wires them to an agent. Use it when writing game content; classes marked <> are meant to be subclassed.
classDiagram
GdPAIObjectData <|-- GdPAIInteractable
GdPAIObjectData <|-- GdPAILocationData
Action <|-- GoToAction
GdPAIObjectData --> Action : get_provided_actions
GdPAIBehaviorConfig --> Action : registers via _populate
GdPAIBehaviorConfig --> Goal : registers via _populate
GdPAIBehaviorConfig --> PropertyUpdater : registers via _populate
GoToAction --> ProvisionSpecFactWildcard : provisions at_target
class GdPAIObjectData {
<<extension point>>
+entity
+get_group_labels()
+get_provided_actions()
+get_sim_properties()
}
class GdPAIInteractable {
+max_interaction_distance
+max_drift_from_plan
}
class GdPAILocationData {
+location_node_2d
+location_node_3d
+get_position()
+get_rotation()
}
class Action {
<<extension point>>
+Status FAILURE
+Status RUNNING
+Status SUCCESS
+chain_position
+get_validity_checks()
+get_action_cost()
+get_preconditions()
+get_requirements()
+get_provisions()
+inject_binding()
+simulate_effect()
+get_effect_spec()
+pre_perform_action()
+perform_action()
+post_perform_action()
+clone_for_plan()
+get_title()
+get_description()
}
class GoToAction {
+target_location
+provisions fact_wildcard at_target
+effect_spec copies at_target to agent position
}
class Goal {
<<extension point>>
+compute_reward()
+get_desired_state()
+get_title()
+get_description()
}
class PropertyUpdater {
<<extension point>>
+update_properties()
+initialize()
}
class GdPAIBehaviorConfig {
+apply_to_agent()
+_populate(goals, actions, updaters)
}
class ProvisionSpecFactWildcard {
+to_bridge_dict() kind (fact_wildcard)
}
Specs — architecture-specs.mmd
Shows the Precondition, RequirementSpec, and ProvisionSpec hierarchies and what each to_bridge_dict sends across the Rust bridge. Use it when declaring planner constraints; see api-spec.json for exact bridge string shapes.
classDiagram
Precondition <|-- PreconditionBuiltin
Precondition <|-- PreconditionCustom
PreconditionCustom <|-- PreconditionCustomWithDeps
RequirementSpec <|-- RequirementSpecBindingExists
RequirementSpec <|-- RequirementSpecBindingEquals
RequirementSpec <|-- RequirementSpecBindingInSet
RequirementSpec <|-- RequirementSpecFact
ProvisionSpec <|-- ProvisionSpecBinding
ProvisionSpec <|-- ProvisionSpecFact
ProvisionSpec <|-- ProvisionSpecFactWildcard
Action --> Precondition : get_preconditions
Action --> RequirementSpec : get_requirements
Action --> ProvisionSpec : get_provisions
GoToAction --> ProvisionSpecFactWildcard : provisions at_target
class Precondition {
<<extension point>>
+to_bridge_dict()
}
class PreconditionBuiltin {
+Target AGENT
+Target WORLD_STATE
+Target WORLD_OBJECT_PROXY
+Op HAS_PROPERTY
+Op EQUAL
+Op NOT_EQUAL
+Op GT
+Op GTE
+Op LT
+Op LTE
+to_bridge_dict() kind (builtin)
}
class PreconditionCustom {
+eval_func
+to_bridge_dict() kind (custom)
}
class PreconditionCustomWithDeps {
+dependent_objects
+to_bridge_dict() kind (custom_with_deps)
}
class RequirementSpec {
<<extension point>>
+binding_exists(fact)
+binding_equals(fact, value)
+binding_in_set(fact, values)
+fact(fact, values)
+to_bridge_dict()
}
class RequirementSpecBindingExists {
+to_bridge_dict() kind (binding_exists)
}
class RequirementSpecBindingEquals {
+to_bridge_dict() kind (binding_equals)
}
class RequirementSpecBindingInSet {
+to_bridge_dict() kind (binding_in_set)
}
class RequirementSpecFact {
+to_bridge_dict() kind (fact)
}
class ProvisionSpec {
<<extension point>>
+binding(fact, value)
+fact(fact, values)
+fact_wildcard(fact)
+to_bridge_dict()
}
class ProvisionSpecBinding {
+to_bridge_dict() kind (binding)
}
class ProvisionSpecFact {
+to_bridge_dict() kind (fact)
}
class ProvisionSpecFactWildcard {
+to_bridge_dict() kind (fact_wildcard)
}
class Action {
+get_preconditions()
+get_requirements()
+get_provisions()
}
class GoToAction {
+get_provisions()
+get_effect_spec()
}
note for RequirementSpecBindingExists "to_bridge_dict() kind (binding_exists) with (fact)"
note for RequirementSpecBindingEquals "to_bridge_dict() kind (binding_equals) with (fact) (value)"
note for RequirementSpecBindingInSet "to_bridge_dict() kind (binding_in_set) with (fact) (values)"
note for RequirementSpecFact "to_bridge_dict() kind (fact) with (fact) (values)"
note for ProvisionSpecBinding "to_bridge_dict() kind (binding) with (fact) (value)"
note for ProvisionSpecFact "to_bridge_dict() kind (fact) with (fact) (values)"
note for ProvisionSpecFactWildcard "to_bridge_dict() kind (fact_wildcard) with (fact) used by GoToAction for at_target"
note for PreconditionBuiltin "to_bridge_dict() kind (builtin) with (target) (op) (value)"
note for PreconditionCustom "to_bridge_dict() kind (custom) with eval_func as callable string"