UE2:GUIToolTip (UT2004)

Object >> GUI >> GUIComponent >> GUIToolTip

Package:

XInterface

Created on: 01/19/2004 Tooltip that appears when this component is moused over

Written by Ron Prestenback © 2003, Epic Games, Inc. All Rights Reserved

Properties

Property group 'GUIToolTip'

bMultiLine

Type: bool

Allow hint text to be wrapped if it's too long

Default value: True

bResetPosition

Type: bool

Position of this component needs to be updated

bTrackInput

Type: bool

Should this tooltip disappear when input is received

Default value: True

bTrackMouse

Type: bool

This tooltip will follow the mouse as it moves

CurrentTime

Type: float

Modifiers: noexport

ExpirationSeconds

Type: float

Modifiers: globalconfig

Default value: 3.0

InitialDelay

Type: float

Modifiers: globalconfig

Number of seconds of inactivity before appearing

Default value: 0.25

Lines

Type: array<string>

Modifiers: const

If multiline == true, contains the tooltip lines

MaxWidth

Type: float

Modifiers: globalconfig

Max width of the tooltip area, in percent of the screen width

Default value: 0.3

StartTime

Type: float

Modifiers: noexport

Text

Type: string

Modifiers: const

Entire tooltip

Default values

Property	Value
bRequiresStyle	True
bVisible	False
StyleName	"MouseOver"

Delegates

EnterArea

delegate GUIToolTip EnterArea ()

GetHeight

delegate float GetHeight (Canvas C)

GetLeft

delegate float GetLeft (Canvas C)

GetTop

delegate float GetTop (Canvas C)

GetWidth

delegate float GetWidth (Canvas C)

HideToolTip

delegate HideToolTip ()

LeaveArea

delegate bool LeaveArea ()

ShowToolTip

delegate ShowToolTip ()

Tick

delegate Tick (float RealSeconds)

Functions

Native functions

SetTip

native final function SetTip (coerce string NewTip)

Events

UpdatePosition

event UpdatePosition (Canvas C)

Other instance functions

GetTopAboveCursor

singular function float GetTopAboveCursor (Canvas C)

GetTopBelowCursor

singular function float GetTopBelowCursor (Canvas C)

InternalEnterArea

function GUIToolTip InternalEnterArea ()

InternalLeaveArea

function bool InternalLeaveArea ()