UE2:GUIMenuOption (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to navigation Jump to search
UT2004 Object >> GUI >> GUIComponent >> GUIMultiComponent >> GUIMenuOption
Package: 
XInterface

Class: UT2K4UI.GUIMultiComponent

MenuOptions combine a label and any other component in to 1 single control. The Label is left justified, the control is right.

Written by Joe Wilcox (c) 2002, Epic Games, Inc. All Rights Reserved

Properties

Property group 'Option'

bAutoSizeCaption

Type: bool

Extend CaptionWidth if caption is too long

Default value: True

bFlipped

Type: bool

Draw the Component to the left of the caption

bHeightFromComponent

Type: bool

Get the Height of this component from the Component

bIgnoreChange

Type: bool

Modifiers: editconst

Don't want an OnChange event

bSquare

Type: bool

Use the Height for the Width

bValueReadOnly

Type: bool

Value of this option cannot be modified by input

bVerticalLayout

Type: bool

Layout controls vertically

Caption

Type: string

Modifiers: localized

Caption for the label

CaptionWidth

Type: float

How big should the Caption be

Default value: 0.5

ComponentClassName

Type: string

Name of the component to spawn

ComponentJustification

Type: GUI.eTextAlign

How do we justify the label

Default value: TXTA_Right

ComponentWidth

Type: float

How big should the Component be (-1 = 1-CaptionWidth)

Default value: -1.0

LabelColor

Type: Object.Color

Color for the label

Default value:

Member Value
A 255
B 64
G 0
R 0

LabelFont

Type: string

Name of the Font for the label

Default value: "UT2MenuFont"

LabelJustification

Type: GUI.eTextAlign

How do we justify the label

LabelStyleName

Type: string

The Style for the label

Default value: "TextLabel"

MyComponent

Type: GUIComponent

Modifiers: editconst, noexport

Holds the component

MyLabel

Type: GUILabel

Modifiers: editconst, noexport

Holds the label

Default values

Property Value
bAcceptsInput True
bStandardized True
OnClickSound CS_Click
OnCreateComponent InternalOnCreateComponent
PropagateVisibility True
StandardHeight 0.03
ToolTip GUIToolTip'GUIMenuOptionToolTip'
WinHeight 0.03
WinLeft 0.496094
WinTop 0.347656
WinWidth 0.5

Subobjects

GUIMenuOptionToolTip

Class: XInterface.GUIToolTip

Empty subobject definition.

Functions

Events

InitComponent

event InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIMultiComponent.InitComponent


Other instance functions

CenterMouse

function CenterMouse ()

Overrides: GUIMultiComponent.CenterMouse


GetComponentValue

function string GetComponentValue ()


InternalOnChange

function InternalOnChange (GUIComponent Sender)


InternalOnCreateComponent

function InternalOnCreateComponent (GUIComponent NewComp, GUIComponent Sender)


MenuOptionClicked

function bool MenuOptionClicked (GUIComponent Sender)


ResetComponent

function ResetComponent ()


SetCaption

function SetCaption (string NewCaption)


SetComponentValue

function SetComponentValue (coerce string NewValue, optional bool bNoChange)


SetFriendlyLabel

function SetFriendlyLabel (GUILabel NewLabel)

Overrides: GUIComponent.SetFriendlyLabel


SetHint

function SetHint (string NewHint)

Overrides: GUIComponent.SetHint


SetReadOnly

function SetReadOnly (bool bValue)