doc: nyan data API v0.4.1 changelog.

heinezen · Dec 7, 2023 · 9bc47c9 · 9bc47c9
1 parent 30f4b14
commit 9bc47c9
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 1 deletion.
diff --git a/doc/changelogs/nyan_api/v0.4.0.md b/doc/changelogs/nyan_api/v0.4.0.md
@@ -19,7 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Rename `Entity` object to `Object`
 
 ## Added
-### Utility module
+### Ability module
 - Add `container : ResourceContainer` member to `Trade`
 
 ### Utility module

diff --git a/doc/changelogs/nyan_api/v0.4.1.md b/doc/changelogs/nyan_api/v0.4.1.md
@@ -0,0 +1,25 @@
+# [0.4.1] - 2023-12-02
+All notable changes for version [v0.4.1] are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Added
+### Ability module
+- Add `Activity(Ability)` object; defines the behaviour of a game entity
+
+### Utility module
+- Add `Activity(Entity)` object; stores behaviour node graph of a game entity
+- Add `Node(Entity)` object; node in behaviour node graph
+- Add `Ability(Node)` object
+- Add `End(Node)` object
+- Add `Start(Node)` object
+- Add `XOREventGate(Node)` object
+- Add `XORGate(Node)` object
+- Add `Event(Entity)` object; event for behaviour node graph
+- Add `Wait(Event)` object
+
+
+## Reference visualization
+
+TBD
diff --git a/doc/nyan/api_reference/reference_util.md b/doc/nyan/api_reference/reference_util.md
@@ -51,6 +51,15 @@ Event(Object):
 
 Generalization object for events that can be used in `XOREventGate` nodes.
 
+## util.activity.event.type.Command
+
+```python
+Command(Event):
+    pass
+```
+
+Fires after a new command has been added to the game entity's command queue.
+
 ## util.activity.event.type.Wait
 
 ```python
@@ -65,6 +74,17 @@ Time in seconds to wait.
 
 If the value is zero or negative, the event fires immediately.
 
+## util.activity.event.type.WaitAbility
+
+```python
+WaitAbility(Event):
+    pass
+```
+
+Fires at the exact time when a previously visited ability node has finished executing.
+
+In other words, the event fires when the ability is done with the associated task. For example, in case of the `Move` ability, the event fires when the game entity has reached its destination.
+
 ## util.activity.node.Node
 
 ```python