I'm a doctor, not a mechanic

UE2:GUIMenuOption (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT2004 Object >> GUI >> GUIComponent >> GUIMultiComponent >> GUIMenuOption

Contents

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

[edit] Properties

[edit] Property group 'Option'

[edit] bAutoSizeCaption

Type: bool

Extend CaptionWidth if caption is too long

Default value: True

[edit] bFlipped

Type: bool

Draw the Component to the left of the caption

[edit] bHeightFromComponent

Type: bool

Get the Height of this component from the Component

[edit] bIgnoreChange

Type: bool

Modifiers: editconst

Don't want an OnChange event

[edit] bSquare

Type: bool

Use the Height for the Width

[edit] bValueReadOnly

Type: bool

Value of this option cannot be modified by input

[edit] bVerticalLayout

Type: bool

Layout controls vertically

[edit] Caption

Type: string

Modifiers: localized

Caption for the label

[edit] CaptionWidth

Type: float

How big should the Caption be

Default value: 0.5

[edit] ComponentClassName

Type: string

Name of the component to spawn

[edit] ComponentJustification

Type: GUI.eTextAlign

How do we justify the label

Default value: TXTA_Right

[edit] ComponentWidth

Type: float

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

Default value: -1.0

[edit] LabelColor

Type: Object.Color

Color for the label

Default value:

Member Value
A 255
B 64
G 0
R 0

[edit] LabelFont

Type: string

Name of the Font for the label

Default value: "UT2MenuFont"

[edit] LabelJustification

Type: GUI.eTextAlign

How do we justify the label

[edit] LabelStyleName

Type: string

The Style for the label

Default value: "TextLabel"

[edit] MyComponent

Type: GUIComponent

Modifiers: editconst, noexport

Holds the component

[edit] MyLabel

Type: GUILabel

Modifiers: editconst, noexport

Holds the label

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

[edit] Subobjects

[edit] GUIMenuOptionToolTip

Class: XInterface.GUIToolTip

Empty subobject definition.

[edit] Functions

[edit] Events

[edit] InitComponent

event InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIMultiComponent.InitComponent


[edit] Other instance functions

[edit] CenterMouse

function CenterMouse ()

Overrides: GUIMultiComponent.CenterMouse


[edit] GetComponentValue

function string GetComponentValue ()


[edit] InternalOnChange

function InternalOnChange (GUIComponent Sender)


[edit] InternalOnCreateComponent

function InternalOnCreateComponent (GUIComponent NewComp, GUIComponent Sender)


[edit] MenuOptionClicked

function bool MenuOptionClicked (GUIComponent Sender)


[edit] ResetComponent

function ResetComponent ()


[edit] SetCaption

function SetCaption (string NewCaption)


[edit] SetComponentValue

function SetComponentValue (coerce string NewValue, optional bool bNoChange)


[edit] SetFriendlyLabel

function SetFriendlyLabel (GUILabel NewLabel)

Overrides: GUIComponent.SetFriendlyLabel


[edit] SetHint

function SetHint (string NewHint)

Overrides: GUIComponent.SetHint


[edit] SetReadOnly

function SetReadOnly (bool bValue)