Cogito, ergo sum

UE3:UTUICollectionCheckBox (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> UIButton >> UICheckbox >> UTUICollectionCheckBox
Package: 
UTGame
Implemented interfaces
UIDataStorePublisher
This class in other games:
UDK

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Checkbox widget that works with collection datasources.

Properties

DataProvider

Type: UIListElementProvider

Modifiers: const, transient

the list element provider referenced by DataSource

Default values

Property Value
ValueDataSource
Member Value
RequiredFieldType DATATYPE_Collection

Subobjects

BackgroundImageTemplate

Class: Engine.UIComp_DrawImage

Inherits from: UICheckbox.BackgroundImageTemplate

No new values.

CheckedImageTemplate

Class: Engine.UIComp_DrawImage

Inherits from: UICheckbox.CheckedImageTemplate

No new values.

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UICheckbox.WidgetEventComponent

No new values.

Native functions

SetValue

native function SetValue (bool bShouldBeChecked, optional int PlayerIndex)

Overrides: UICheckbox.SetValue

Changed the checked state of this checkbox and activates a checked event.

Parameters:

  • bShouldBeChecked - TRUE to turn the checkbox on, FALSE to turn it off
  • PlayerIndex - the index of the player that generated the call to SetValue; used as the PlayerIndex when activating UIEvents; if not specified, the value of GetBestPlayerIndex() is used instead.