Files
gymkhana-actions/docs/api/ESCTooltip.md
Dennis Ploeger 58d880101d Optimized Docs (#7)
Authored-by: Dennis Ploeger <develop@dieploegers.de>
2021-06-22 23:06:20 +02:00

2.4 KiB

ESCTooltip

Extends: RichTextLabel

Description

Constants Descriptions

MAX_HEIGHT

const MAX_HEIGHT: int = 500

MAX_WIDTH

const MAX_WIDTH: int = 200

MIN_HEIGHT

const MIN_HEIGHT: int = 30

ONE_LINE_HEIGHT

const ONE_LINE_HEIGHT: int = 16

Property Descriptions

current_action

var current_action: String

Infinitive verb

current_target

var current_target: String
  • Setter: set_target

Target item/hotspot

current_prep

var current_prep: String = "with"

Preposition: on, with...

current_target2

var current_target2: String

Target 2 item/hotspot

waiting_for_target2

var waiting_for_target2

True if tooltip is waiting for a click on second target (use x with y)

color

export var color = "0,0,0,1"
  • Setter: set_color

offset_from_cursor

export var offset_from_cursor = "(10, 0)"

debug_mode

export var debug_mode = false
  • Setter: set_debug_mode

debug_texturerect_node

var debug_texturerect_node: TextureRect

Method Descriptions

get_class

func get_class()

set_color

func set_color(p_color: Color)

set_debug_mode

func set_debug_mode(p_debug_mode: bool)

on_action_selected

func on_action_selected() -> void

set_target

func set_target(target: String, needs_second_target: bool = false) -> void

set_target2

func set_target2(target2: String) -> void

update_tooltip_text

func update_tooltip_text()

update_size

func update_size()

tooltip_distance_to_edge_top

func tooltip_distance_to_edge_top(position: Vector2)

tooltip_distance_to_edge_bottom

func tooltip_distance_to_edge_bottom(position: Vector2)

tooltip_distance_to_edge_left

func tooltip_distance_to_edge_left(position: Vector2)

tooltip_distance_to_edge_right

func tooltip_distance_to_edge_right(position: Vector2)

clear

func clear()