RPG in a Box
Official Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

======Set Entity Tooltip======
----

Sets the tooltip for the specified [[entity]]. An empty [[string]] value can be specified for the tooltip text in order to remove the [[entity|entity's]] tooltip.

====Signature:====
<code python>
set_entity_tooltip(entity, tooltip_text)
</code>

^Argument^Description^Type^Required^
|entity|[[Entity]] to change the tooltip for.|[[Entity]]|Yes|
|tooltip_text|Text to display in the tooltip.|[[String]]|Yes|

<WRAP center round info 100%>
You can use [[placeholder expression|placeholder expressions]] within the tooltip text, for example to update an [[entity|entity's]] tooltip based on the current value of a stat or custom property of that [[entity]].
</WRAP>

====Example:====
<code bauxite>
set_entity_tooltip(self, "Wooden Chest");
</code>
//Results:// The tooltip text for the [[entity]] that triggered this [[script]] will be changed to "Wooden Chest".

<WRAP center round tip 100%>
Use the **Set Entity Tooltip** function to set some initial descriptive tooltip text onto an [[object]] that has just become interactable or to update the existing tooltip text of an [[object]] whose appearance or purpose has changed.
</WRAP>

----

<WRAP group>
<WRAP half column>
====Editor Node:====
{{:wiki:set_entity_tooltip_node.png?nolink|}}
</WRAP>

<WRAP half column>
====Visual Demo:====
{{:wiki:set_entity_tooltip_demo.gif?nolink|}}
</WRAP>
</WRAP>

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation