I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

UE2:GUIMenuOption (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2004 Object >> GUI >> GUIComponent >> GUIMultiComponent >> GUIMenuOption
Package: 
XInterface
Direct subclasses:
GUIListSpacer, MoButton, MoCheckBox, MoComboBox, MoEditBox, MoFloatEdit, MoNumericEdit, MoSlider
This class in other games:
UE2Runtime, UT2003

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[edit]

Property group 'Option'[edit]

bAutoSizeCaption[edit]

Type: bool

Extend CaptionWidth if caption is too long

Default value: True

bFlipped[edit]

Type: bool

Draw the Component to the left of the caption

bHeightFromComponent[edit]

Type: bool

Get the Height of this component from the Component

bIgnoreChange[edit]

Type: bool

Modifiers: editconst

Don't want an OnChange event

bSquare[edit]

Type: bool

Use the Height for the Width

bValueReadOnly[edit]

Type: bool

Value of this option cannot be modified by input

bVerticalLayout[edit]

Type: bool

Layout controls vertically

Caption[edit]

Type: string

Modifiers: localized

Caption for the label

CaptionWidth[edit]

Type: float

How big should the Caption be

Default value: 0.5

ComponentClassName[edit]

Type: string

Name of the component to spawn

ComponentJustification[edit]

Type: GUI.eTextAlign

How do we justify the label

Default value: TXTA_Right

ComponentWidth[edit]

Type: float

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

Default value: -1.0

LabelColor[edit]

Type: Object.Color

Color for the label

Default value:

Member Value
A 255
B 64
G 0
R 0

LabelFont[edit]

Type: string

Name of the Font for the label

Default value: "UT2MenuFont"

LabelJustification[edit]

Type: GUI.eTextAlign

How do we justify the label

LabelStyleName[edit]

Type: string

The Style for the label

Default value: "TextLabel"

MyComponent[edit]

Type: GUIComponent

Modifiers: editconst, noexport

Holds the component

MyLabel[edit]

Type: GUILabel

Modifiers: editconst, noexport

Holds the label

Default values[edit]

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[edit]

GUIMenuOptionToolTip[edit]

Class: XInterface.GUIToolTip

Empty subobject definition.

Functions[edit]

Events[edit]

InitComponent[edit]

event InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIMultiComponent.InitComponent


Other instance functions[edit]

CenterMouse[edit]

function CenterMouse ()

Overrides: GUIMultiComponent.CenterMouse


GetComponentValue[edit]

function string GetComponentValue ()


InternalOnChange[edit]

function InternalOnChange (GUIComponent Sender)


InternalOnCreateComponent[edit]

function InternalOnCreateComponent (GUIComponent NewComp, GUIComponent Sender)


MenuOptionClicked[edit]

function bool MenuOptionClicked (GUIComponent Sender)


ResetComponent[edit]

function ResetComponent ()


SetCaption[edit]

function SetCaption (string NewCaption)


SetComponentValue[edit]

function SetComponentValue (coerce string NewValue, optional bool bNoChange)


SetFriendlyLabel[edit]

function SetFriendlyLabel (GUILabel NewLabel)

Overrides: GUIComponent.SetFriendlyLabel


SetHint[edit]

function SetHint (string NewHint)

Overrides: GUIComponent.SetHint


SetReadOnly[edit]

function SetReadOnly (bool bValue)