chimchooree/blessfrey-bottle
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

documentation - messagebus, base, knowledgebase

Browse Source
This commit is contained in:
chimchooree
2022-12-01 00:49:10 -06:00
parent 5b8b01678e
commit e5386e633b
5 changed files with 167 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/blessfrey-gdd/docs/knowledgebase
+36
View File
@@ -0,0 +1,36 @@
<p>The KnowledgeBase is a node singleton that stores and manages all the knowledge in the game. It rests at res://Singleton/KnowledgeBase.gd. <br></p>
<br>
<h3>flow </h3>
<p>On ready, the encountered, forgot, and learned topics and handlers are set up. <br></p>
<br>
<p>Knowledge is learned by setting
<br>
<p>Also, all objects that inherit from the <a href="/blessfrey-gdd/docs/base">base</a> request a ref_id at ready. <br></p>
<br>
<h3>signals </h3>
<p><ul>
<li>•&nbsp;<b>-</b>: - </li>
</ul><br>
<br>
<h3>variables </h3><br>
<p><ul>
<li>•&nbsp;<b>current_ref_id</b>: int. ref ids are handed out sequentially by incrementing this value. Its initial value is -1. </li>
<li>•&nbsp;<b>topics</b>: Dictionary. Holds a list of handlers for each topic. </li>
</ul><br></p>
<br>
<h3>methods </h3><br>
<p>int designate_ref_id() <br></p>
<p>increments current_ref_id by one then returns it. <br></p>
<br>
<p>void publish(String topic, ??? data) <br></p>
<p>If the topic has any active subscriptions, its handlers are prompted to handle the data. <br></p>
<br>
<p>void subscribe(String topic, Object handler) <br></p>
<p>An entry in topics is made for the topic if needed, then the handler is added to the topic's list. <br></p>
<br>
<p>void unsubscribe(String topic, Object handler) <br></p>
<p>if the topic has an active subscription, the given handler is erased from the topic's list. <br></p>
<br>
<p>void _on_handler_tree_exited(String topic, Object handler) <br></p>
<p>During subscribe, the handler is connected to execute this if it exits the tree. It unsubscribes the handler from the topic. <br></p>
<br>