UncivTooltip

class UncivTooltip<T : Actor>(target: Group, content: T, targetAlign: Int, tipAlign: Int, offset: Vector2, animate: Boolean, forceContentSize: Vector2?) : InputListener

A Replacement for Gdx Tooltip, placement does not follow the mouse.

Usage: group.addTooltip(text, size) builds a Label as tip actor and attaches it to your Group.

Parameters

target

The widget the tooltip will be added to - take care this is the same for which addListener is called

content

The actor to display as Tooltip

targetAlign

Point on the target widget to align the Tooltip to

tipAlign

Point on the Tooltip to align with the given point on the target

offset

Additional offset for Tooltip position after alignment

animate

Use show/hide animations

forceContentSize

Force virtual content width/height for alignment calculation - because Gdx auto layout reports wrong dimensions on scaled actors.

Constructors

UncivTooltip

fun <T : Actor> UncivTooltip(target: Group, content: T, targetAlign: Int = Align.topRight, tipAlign: Int = Align.topRight, offset: Vector2 = Vector2.Zero, animate: Boolean = true, forceContentSize: Vector2? = null)

Types

Companion

object Companion

TipState

enum TipState : Enum<UncivTooltip.TipState>

Functions

enter

open override fun enter(event: InputEvent?, x: Float, y: Float, pointer: Int, fromActor: Actor?)

equals

open operator fun equals(other: Any?): Boolean

exit

open override fun exit(event: InputEvent?, x: Float, y: Float, pointer: Int, toActor: Actor?)

getEdgePoint

private fun Actor.getEdgePoint(align: Int): Vector2

getOriginX

private fun getOriginX(width: Float, align: Int): Float

getOriginY

private fun getOriginY(height: Float, align: Int): Float

handle

open override fun handle(p0: Event): Boolean

hashCode

open fun hashCode(): Int

hide

fun hide(immediate: Boolean = false)

Hide the Tooltip (immediately or begin the animation). Can be called programmatically.

keyDown

open fun keyDown(p0: InputEvent, p1: Int): Boolean

keyTyped

open fun keyTyped(p0: InputEvent, p1: Char): Boolean

keyUp

open fun keyUp(p0: InputEvent, p1: Int): Boolean

mouseMoved

open fun mouseMoved(p0: InputEvent, p1: Float, p2: Float): Boolean

scrolled

open fun scrolled(p0: InputEvent, p1: Float, p2: Float, p3: Float, p4: Float): Boolean

show

fun show(immediate: Boolean = false)

Show the Tooltip (immediately or begin the animation). Can be called programmatically.

toString

open fun toString(): String

touchDown

open override fun touchDown(event: InputEvent?, x: Float, y: Float, pointer: Int, button: Int): Boolean

touchDragged

open fun touchDragged(p0: InputEvent, p1: Float, p2: Float, p3: Int)

touchUp

open fun touchUp(p0: InputEvent, p1: Float, p2: Float, p3: Int, p4: Int)

Properties

animate

val animate: Boolean = true

container

private val container: Container<T>

content

contentHeight

private val contentHeight: Float

contentWidth

private val contentWidth: Float

offset

val offset: Vector2

state

var state: UncivTooltip.TipState

current visibility state of the Tooltip

target

val target: Group

targetAlign

val targetAlign: Int

tipAlign

val tipAlign: Int

Sources

jvm source