User Tools

Site Tools


set_entity_tooltip

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's tooltip.

Signature:

set_entity_tooltip(entity, tooltip_text)
ArgumentDescriptionTypeRequired
entityEntity to change the tooltip for.EntityYes
tooltip_textText to display in the tooltip.StringYes

You can use placeholder expressions within the tooltip text, for example to update an entity's tooltip based on the current value of a stat or custom property of that entity.

Example:

set_entity_tooltip(self, "Wooden Chest")

Results: The tooltip text for the entity that triggered this script will be changed to “Wooden Chest”.

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.


Editor Node:

Visual Demo:

set_entity_tooltip.txt · Last modified: 2020/04/28 10:00 by justin