This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
set_entity_tooltip [2017/10/12 09:45] – justin | set_entity_tooltip [2020/04/28 09:51] – justin | ||
---|---|---|---|
Line 2: | Line 2: | ||
---- | ---- | ||
- | Sets the tooltip for the specified entity. An empty string value can be specified for the tooltip text in order to remove the entity' | + | Sets the tooltip for the specified |
+ | ====Signature: | ||
<code python> | <code python> | ||
set_entity_tooltip(entity, | set_entity_tooltip(entity, | ||
Line 9: | Line 10: | ||
^Argument^Description^Type^Required^ | ^Argument^Description^Type^Required^ | ||
- | |entity|Entity | + | |entity|[[Entity]] to change the tooltip |
|tooltip_text|Text to display in the tooltip.|[[String]]|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' | ||
+ | </ | ||
====Example: | ====Example: | ||
- | < | + | < |
set_entity_tooltip(self, | set_entity_tooltip(self, | ||
</ | </ | ||
- | // | + | // |
<WRAP center round tip 100%> | <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. | + | 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. |
</ | </ | ||