documentation; started inspect, tangible
chimchooree
2 years ago
parent
c4acf39f80
commit
ca5f0f984e
@ -0,0 +1,15 @@
|
||||
<p>documenting Blessfrey objects, variables, and methods <br></p>
|
||||
<br>
|
||||
<p>The <a href="/blessfrey-gdd">GDD</a> is more about design, while the docs is more about the data and logic. (I fix a lot of problems just trying to explain what I wrote.) <br></p>
|
||||
<br>
|
||||
<h2>entity</h2>
|
||||
<p><ul>
|
||||
<li><a href="/blessfrey-gdd/docs/tangible-body">tangible-body</a> </li>
|
||||
</ul> <br></p>
|
||||
<br>
|
||||
<h2>UI</h2>
|
||||
<p><ul>
|
||||
<li><a href="/blessfrey-gdd/docs/highlight">highlight</a> </li>
|
||||
<li><a href="/blessfrey-gdd/docs/inspect-menu">inspect menu</a> </li>
|
||||
<li><a href="/blessfrey-gdd/docs/ui">ui</a> </li>
|
||||
</ul> <br></p>
|
||||
@ -0,0 +1,31 @@
|
||||
<p>The inspect menu is a PopupMenu that gives options for interaction with its subject. It rests at res://UI/InspectMenu/InspectMenu.tscn. <br></p>
|
||||
<br>
|
||||
<h3>flow </h3>
|
||||
<p>The inspect method is the entry point. Inspect > set_subject > _about_to_show > make_label<br></p>
|
||||
<br>
|
||||
<h3>signals </h3>
|
||||
<p><ul>
|
||||
<li>• <b>id_pressed</b>: connects the InspectMenu's signal to the subject's id_pressed method. Used to execute the associated method via pressing an inspect option. </li>
|
||||
<li>• <b>about_to_show</b>: connects the InspectMenu's signal to its own '_about_to_show' method. </li>
|
||||
</ul><br>
|
||||
<br>
|
||||
<h3>variables </h3>
|
||||
<p><ul>
|
||||
<li>• <b>subject</b>: the <a href="/blessfrey-gdd/docs/tangible">tangible entity</a> being inspected. Inspect options will be enacted on it. </li>
|
||||
<li>• <b>is_connected</b>: ensures 'about_to_show' is properly connected. </li>
|
||||
<li>• <b>label</b>: Label. Holds the subject's display name. </li>
|
||||
</ul><br></p>
|
||||
<br>
|
||||
<h3>methods </h3>
|
||||
<p>void set_subject (Object new_subject) <br></p>
|
||||
<p>tear down old subject + set up new subject <br></p>
|
||||
<br>
|
||||
<p>void inspect (Object new_subject) <br></p>
|
||||
<p>set up inspect menu <br></p>
|
||||
<br>
|
||||
<p>Object make_label () <br></p>
|
||||
<p>returns a label with the name set. (Subject requires write_name()) <br></p>
|
||||
<br>
|
||||
<p>void _about_to_show () <br></p>
|
||||
<p>resets the inspect menu, adds a label, and adds inspect options from the subject. <br></p>
|
||||
<br>
|
||||
@ -0,0 +1,43 @@
|
||||
<p>A tangible entity is a Node that inherits from <a href="/blessfrey-gdd/docs/tangible">mobile entities</a>. It is characterized by its physical presence in the world and possibility for interaction. It rests at res://addons/character_system/tangible.gd. <br></p>
|
||||
<br>
|
||||
<h3>flow </h3>
|
||||
<p>Groups and default <a href="/blessfrey-gdd/docs/inspect-menu">inspect options</a> are added at ready. <br></p>
|
||||
<br>Inspect: Inspect is the entry point. Inspect > (wait for user to press an inspect option) > id_pressed >
|
||||
<br>
|
||||
<h3>groups </h3>
|
||||
<p><ul>
|
||||
<li>• <b>can_highlight</b>: can target or hover mouse over entity for some information </li>
|
||||
<li>• <b>can_interact</b>: can become the subject of an inspection menu. </li>
|
||||
<li>• <b>can_skill_target</b>: can become the target of spells. </li>
|
||||
<li>• <b>can_target</b>: can be targetted. </li>
|
||||
</ul></p><br>
|
||||
<br>
|
||||
<h3>signals </h3>
|
||||
<p><ul>
|
||||
<li>• <b>-</b>: - </li>
|
||||
</ul><br>
|
||||
<br>
|
||||
<h3>variables </h3>
|
||||
<p><ul>
|
||||
<li>• <b>inspect_options</b>: Dictionary. the options available on this entity's <a href="/blessfrey-gdd/docs/inspect-menu">inspect menu</a>. </li>
|
||||
<li>• <b>applied_keywords</b>: Array[Objects]. all keywords currently active on this entity. </li>
|
||||
</ul><br></p>
|
||||
<br>
|
||||
<h3>methods </h3>
|
||||
<p>void _ready () <br></p>
|
||||
<p>adds groups and default examine options. <br></p>
|
||||
<br>
|
||||
<p>void examine () <br></p>
|
||||
<p>placeholder; prints display name. <br></p>
|
||||
<br>
|
||||
<p>void highlight () <br></p>
|
||||
<p>calls entry point on this entity's <a href="/blessfrey-gdd/docs/highlight">highlight node</a>. <br></p>
|
||||
<br>
|
||||
<p>void id_pressed (new_id) <br></p>
|
||||
<p>calls associated method from inspect_options. <br></p>
|
||||
<br>
|
||||
<p>void inspect () <br></p>
|
||||
<p>triggers <a href="/blessfrey-gdd/docs/ui">UI</a>'s inspect method. <br></p>
|
||||
<p>void unhighlight () <br></p>
|
||||
<p>triggers <a href="/blessfrey-gdd/docs/tangible-body">tangible entity's body</a>'s unhighlight method. <br></p>
|
||||
<br>
|
||||
@ -1,21 +0,0 @@
|
||||
<p>The inspect menu is a PopupMenu that gives options for interaction with its subject. It rests at res://UI/InspectMenu/InspectMenu.tscn. <br></p>
|
||||
<h3>variables </h3>
|
||||
<p><ul>
|
||||
<li><b>subject</b>: the entity being inspected. Options will be enacted on it. </li>
|
||||
<li><b>is_connected</b>: ensures 'about_to_show' is properly connected. </li>
|
||||
<li><b>label</b>: Label. Holds the subject's display name. </li>
|
||||
</ul><br></p>
|
||||
<br>
|
||||
<h3>methods </h3>
|
||||
<p>void set_subject (Object new_subject) <br></p>
|
||||
<p>setter + subject setup <br></p>
|
||||
<br>
|
||||
<p>void inspect () <br></p>
|
||||
<p>set up inspect menu <br></p>
|
||||
<br>
|
||||
<p>Object make_label () <br></p>
|
||||
<p>returns a label with the name set. (Subject requires write_name()) <br></p>
|
||||
<br>
|
||||
<p>void _about_to_show () <br></p>
|
||||
<p>resets the inspect menu, adds a label, <br></p>
|
||||
<br>
|
||||
Loading…
Reference in New Issue