Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SinyavtsevIlya/DOTS-BehaviorTree
Unity DOTS Behavior-Tree implementation
https://github.com/SinyavtsevIlya/DOTS-BehaviorTree
behavior-tree-editor behavior-trees burst dots ecs unity
Last synced: 3 months ago
JSON representation
Unity DOTS Behavior-Tree implementation
- Host: GitHub
- URL: https://github.com/SinyavtsevIlya/DOTS-BehaviorTree
- Owner: SinyavtsevIlya
- License: mit
- Created: 2021-08-17T00:58:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-09-01T15:44:21.000Z (over 3 years ago)
- Last Synced: 2024-08-03T05:14:05.556Z (6 months ago)
- Topics: behavior-tree-editor, behavior-trees, burst, dots, ecs, unity
- Language: C#
- Homepage:
- Size: 35.2 KB
- Stars: 75
- Watchers: 2
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DOTS-BT
Unity DOTS Behavior-Tree implementation
# Features
- High performance. Zero GC allocations.
- Easy to use, less to code.
- 100% ECS-ish. No blackboards, no unrelated systems to think about.
- Supports all classic composite node types: Selector, Sequence, Repeater.
- Conditional aborts support.
- Creating (and editing) a tree in Unity Editor.
- Compatible with burst and il2cpp.
# HowTo
## Requirements
`Min. Requirements:` Unity >= 2019.4.18 and entities package >= 0.11.2-preview.1
`Tested on:` Unity 2020.2.3 and entities package 0.17.0-preview.42
## Installation
You can install the repository using `UPM`:
Just add this line in Packages/manifest.json:
"com.nanory.unity.entities.bt": "https://https://github.com/SinyavtsevIlya/DOTS-BehaviorTree.git",
## Usage
### 1) Create a new behavior tree
By right-clicking the `Hierarchy > Behavior Tree > Root`
### 2) Create any nested nodes you need
(Selector/Sequence/Repeater) doing the same way as shown in first step.
### 3) Create your own action or conditional node.
To make it you need to create a pair: a component and a system.
Action Node example:
```csharp
// 1) Create an action node component and (optional) add this attribute.
[GenerateAuthoringComponent]
public struct SeekEnemy : IComponentData { }
public sealed class BTSeekEnemySystem : SystemBase
{
protected override void OnUpdate()
{
var beginSimECB = this.CreateBeginSimECB();
Entities
.WithAll() // 2) Simply add it to your Query.
.ForEach((Entity agentEntity,
// The parameters below are just up to you.
in EnemyLink enemyLink,
in LocalToWorld ltw,
in StoppingDistance stoppingDistance,
in BTActionNodeLink bTNodeLink) => // 3) But don't forget to add this component in the end.
{
var position = GetComponent(enemyLink.Value).Position;
if (math.length((position - ltw.Position)) < stoppingDistance.Value)
{
// 4) When you decided that the action was completed successfully, then you need to send the result.
beginSimECB.AddComponent(bTNodeLink.Value, BTResult.Success);
}
else
beginSimECB.AddComponent(agentEntity, new MoveToDestinationRequest() { Position = position, Speed = 1f });
})
.ScheduleParallel();
}
}
```
Conditional Node example is very similar except two things:
```csharp
// 1) NOTE: in this case we need to implement interface IConditional. (It's only for conversion/validation purposes, not for runtime)
[GenerateAuthoringComponent]
public struct BTIsEnemyReachable : IComponentData, IConditional{ }
public sealed class BTIsEnemyReachableSystem : SystemBase
{
protected override void OnUpdate()
{
var beginSimECB = this.CreateBeginSimECB();
Entities
.WithAll()
.ForEach(
(DynamicBuffer interactableElements,
in EnemyLink enemyLink,
in Name name,
// 2) NOTE: we need to pass a Conditional Node reference.
in BTConditionalNodeLink bTNodeLink) =>
{
for (int i = 0; i < interactableElements.Length; i++)
{
if (interactableElements[i].value == enemyLink.Value)
{
beginSimECB.AddComponent(bTNodeLink.Value, BTResult.Success);
return;
}
}
// you also able to send "Fail" results.
beginSimECB.AddComponent(bTNodeLink.Value, BTResult.Fail);
})
.WithoutBurst()
.Run();
}
}
```
### 4) Add your newly created nodes in the tree
// TODO
### 5) Connect tree to agent
// TODO
# Advanced Tips
## How to use conditional aborts
// TODO (basic usage, priorities)
## How to react on state changes
// TODO (enter/exit events)
# FAQ
## Is it posible to use nested trees?
Yes. Since the tree is just a prefab it's easy to make using nested prefabs feature.