documentation for skills; full site proofreading

This commit is contained in:
chimchooree
2022-11-28 22:00:04 -06:00
parent ca5f0f984e
commit 6c4399a7f1
15 changed files with 189 additions and 145 deletions
+43
View File
@@ -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>•&nbsp;<b>can_highlight</b>: can target or hover mouse over entity for some information </li>
<li>•&nbsp;<b>can_interact</b>: can become the subject of an inspection menu. </li>
<li>•&nbsp;<b>can_skill_target</b>: can become the target of spells. </li>
<li>•&nbsp;<b>can_target</b>: can be targetted. </li>
</ul></p><br>
<br>
<h3>signals </h3>
<p><ul>
<li>•&nbsp;<b>-</b>: - </li>
</ul><br>
<br>
<h3>variables </h3>
<p><ul>
<li>•&nbsp;<b>inspect_options</b>: Dictionary. the options available on this entity's <a href="/blessfrey-gdd/docs/inspect-menu">inspect menu</a>. </li>
<li>•&nbsp;<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>