Files
FlaxEngine/Source/Engine/AI/BehaviorKnowledge.h
2023-08-17 21:24:19 +02:00

55 lines
1.6 KiB
C++

// Copyright (c) 2012-2023 Wojciech Figat. All rights reserved.
#pragma once
#include "Engine/Core/Types/Variant.h"
#include "Engine/Core/Collections/BitArray.h"
#include "Engine/Scripting/ScriptingObject.h"
class Behavior;
class BehaviorTree;
/// <summary>
/// Behavior logic component knowledge data container. Contains blackboard values, sensors data and goals storage for Behavior Tree execution.
/// </summary>
API_CLASS() class FLAXENGINE_API BehaviorKnowledge : public ScriptingObject
{
DECLARE_SCRIPTING_TYPE_WITH_CONSTRUCTOR_IMPL(BehaviorKnowledge, ScriptingObject);
~BehaviorKnowledge();
/// <summary>
/// Owning Behavior instance (constant).
/// </summary>
API_FIELD(ReadOnly) Behavior* Behavior = nullptr;
/// <summary>
/// Used Behavior Tree asset (defines blackboard and memory constraints).
/// </summary>
API_FIELD(ReadOnly) BehaviorTree* Tree = nullptr;
/// <summary>
/// Raw memory chunk with all Behavior Tree nodes state.
/// </summary>
void* Memory = nullptr;
/// <summary>
/// Array with per-node bit indicating whether node is relevant (active in graph with state created).
/// </summary>
BitArray<> RelevantNodes;
/// <summary>
/// Instance of the behaviour blackboard (structure or class).
/// </summary>
API_FIELD() Variant Blackboard;
/// <summary>
/// Initializes the knowledge for a certain tree.
/// </summary>
void InitMemory(BehaviorTree* tree);
/// <summary>
/// Releases the memory of the knowledge.
/// </summary>
void FreeMemory();
};