View source

class FlxUITooltipManager

package flixel.addons.ui

implements IFlxDestroyable

@:directlyUsed

...

Constructor

new(?State:FlxUIState, ?SubState:FlxUISubState)

Variables

@:value(true)autoFlipAnchor:Bool = true

Turn on flipping the anchor position around in order to keep a tooltip on screen

cameras:Array<FlxCamera>

Available since

2.2.0

.

@:value(null)defaultAnchor:Anchor = null

Default anchor position for tooltips where no anchor is defined

@:value(null)defaultStyle:FlxUITooltipStyle = null

Default style for tooltips where no style is defined

@:value(0.1)delay:Float = 0.1

@:value(null)fixedPosition:{object:FlxObject, anchor:Anchor} = null

Optional fixed position to use for ALL tooltips

Available since

2.1.0

.

@:value(false)showOnClick:Bool = false

showTooltipArrow:Bool

Available since

2.1.0

.

Methods

add(thing:FlxObject, data:FlxUITooltipData):Void

Adds a tooltip for this object, using the specified data. NOTE: if thing does not implement IFlxUIButton, a new invisible button will be created for it in order to drive tooltips.

Parameters:

thing

The object you want to add a tooltip to.

null

data

clear():Void

Removes all tooltips

destroy():Void

@:value({ checkChildren : true })doesCurrentTooltipBelongTo(thing:FlxSprite, checkChildren:Bool = true):Bool

Checks whether the currently shown tooltip belongs to a given FlxSprite, or optionally, any of its children (if it is a FlxUIGroup or FlxUI) @return

Parameters:

thing

the FlxSprite to check

checkChildren

whether or not to check its children (default: true)

enableTooltipFor(thing:FlxObject, enabled:Bool):Bool

Allows you to turn tooltips on or off for an object that has already been added

Parameters:

thing

The object you want to turn tooltips on or off for

b

On or off

Returns:

true if the object was found and the property set, false if the object has not been added to the tooltip manager

hideCurrent():Void

Hides the tooltip that is being displayed right now

@:access(flixel.addons.ui.FlxUI)@:access(flixel.addons.ui.FlxUIState)@:access(flixel.addons.ui.FlxUISubState)init():Void

isVisible():Bool

Available since

2.1.0

.

remove(thing:FlxObject):Void

Remove a tooltip associated with this object, if there is one

Parameters:

null

thing

@:value({ value : true })showTooltipFor(thing:FlxObject, value:Bool = true):Void

Show the tooltip for the given object, if one exists

Parameters:

thing

the thing you want to display a tooltip for

value

whether to show or hide the tooltip

Available since

2.1.0

.

@:value({ sticky : true })stickyTooltipFor(thing:FlxObject, sticky:Bool = true):Void

Set an object's tooltip's stickiness (whether it disappears when the mouse moves off of it or not)

Parameters:

thing

the thing you want to modify the tooltip for

sticky

if true, this tooltip will not disappear until explicitly hidden or until another tooltip is triggered

Available since

2.1.0

.

update(elapsed:Float):Void