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/base
+58
View File
@@ -0,0 +1,58 @@
<p>The Base is a node with IDs, a name, and a description. It rests at res://Entity/Base.gd. <br></p>
<br>
<h3>flow </h3>
<p>At ready, it gains a ref_id from the MessageBus. <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>base_id</b>: Color. The id shared by all instances of this type of object. For example, all instances of Melon Soda have the same base id but different ref ids. </li>
<li>•&nbsp;<b>desc_key</b>: String. The key used by the TranslationServer to retrieve the object's description. </li>
<li>•&nbsp;<b>is_player</b>: bool. Only true when this object is the player. </li>
<li>•&nbsp;<b>name_key</b>: String. The key used by the TranslationServer to retrieve the object's display name. </li>
<li>•&nbsp;<b>player_base_id</b>: Color. The base id of the player. </li>
<li>•&nbsp;<b>ref_id</b>: int. The id that identifies a particular instance of an object. </li>
</ul><br></p>
<br>
<h3>setters + getters </h3>
<p>Color get_base_id () <br></p>
<p>base_id getter <br></p>
<br>
<p>??? get_base_id_in_hex()<br></p>
<p>returns base_id in hex <br></p>
<br>
<p>String get_desc()<br></p>
<p>returns description in current language <br></p>
<br>
<p>String get_desc_key()<br></p>
<p>desc_key getter <br></p>
<br>
<p>String get_display_name()<br></p>
<p>returns display name in current language <br></p>
<br>
<p>bool get_is_player()<br></p>
<p>returns whether this object is the player <br></p>
<br>
<p>void set_ref_id(new_ref_id)<br></p>
<p>ref_id setter <br></p>
<br>
<p>int get_ref_id()<br></p>
<p>ref_id getter <br></p>
<br><br>
<h3>methods </h3><br>
<p>bool compare_base_id(second_object) <br></p>
<p>returns whether this object and the given object are the same kind of object. <br></p>
<br>
<p>bool compare_base_id_to_hex(hex) <br></p>
<p>returns whether this object has the given hex as a base id. <br></p>
<br>
<p>bool compare_ref_id(second_object) <br></p>
<p>returns whether this object and the given object are the exact same object. <br></p>
<br>
<p>??? make_instance(path) <br></p>
<p>returns an instance of the scene at the given path. <br></p>
<br>