UE3:UTUITabPage_VideoSettings (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
(Redirected from UE3:ScreenResSetting (UT3))
UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UITabPage >> UTTabPage >> UTUITabPage_Options >> UTUITabPage_VideoSettings
Package:
UTGame
Implemented interfaces:
UIDataStoreSubscriber

Tab page for a user's Video settings.

Properties

AdvancedSettingsScene

Type: string

Reference to the advanced video settings scene.

Default value: "UI_Scenes_FrontEnd.Scenes.SettingsVideoAdvanced"

MessageBoxReference

Type: UTUIScene_MessageBox

Modifiers: transient

Reference to the resolution changed message box.

NewResolution

Type: ScreenResSetting

Modifiers: transient

Struct for the new resolution we are switching to.

OldResolution

Type: ScreenResSetting

Modifiers: transient

Struct for the old resolution for the scene.

SettingsTimeoutTime

Type: float

Modifiers: transient

Amount of time the user has to accept their new resolution settings.

StartResChangeTime

Type: float

Modifiers: transient

When we started the resolution change.

Default values

Property Value
bRequiresTick True

Subobjects

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUITabPage_Options.WidgetEventComponent

No new values.

Structs

ScreenResSetting

Struct defining a screen resoluton.

int ResX
Horizontal resolution.
int ResY
Vertical resolution.
bool bFullscreen
Whether it's fullscreen or not.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UTUITabPage_Options.PostInitialize

Post initialization event - Setup widget delegates.

Other instance functions

OnApplySettings

function OnApplySettings ()

Applies the current settings to the screen, this is usually used for changing screen resolution.

OnButtonBar_Advanced

function bool OnButtonBar_Advanced (UIScreenObject InButton, int PlayerIndex)


OnButtonBar_Apply

function bool OnButtonBar_Apply (UIScreenObject InButton, int PlayerIndex)

Buttonbar Callbacks.

OnConfirmDialog_Closed

function OnConfirmDialog_Closed ()

Callback for when the confirm dialog closes.

OnKeepResolution_Confirm

function OnKeepResolution_Confirm (UTUIScene_MessageBox MessageBox, int Selection, int PlayerIndex)

Callback for whether or not the user decided to keep their resolution.

OnOptionList_OptionChanged

function OnOptionList_OptionChanged (UIScreenObject InObject, name OptionName, int PlayerIndex)

Overrides: UTUITabPage_Options.OnOptionList_OptionChanged

Pass through the option callback.

OnResetToDefaults_Confirm

function OnResetToDefaults_Confirm (UTUIScene_MessageBox MessageBox, int SelectionIdx, int PlayerIndex)

Overrides: UTUITabPage_Options.OnResetToDefaults_Confirm

Callback for the reset to defaults confirmation dialog box.

Parameters:

  • SelectionIdx - Selected item
  • PlayerIndex - Index of player that performed the action.

OnShowAdvancedSettings

function OnShowAdvancedSettings ()

Shows the advanced settings screen.

OnTickCallback

function OnTickCallback (float DeltaTime)

Callback for the tick event.

SetupButtonBar

function SetupButtonBar (UTUIButtonBar ButtonBar)

Overrides: UTUITabPage_Options.SetupButtonBar

Callback allowing the tabpage to setup the button bar for the current scene.

SetupDefaults

function SetupDefaults ()

Pulls default settings for screen resolution from the engine and sets the widgets appropriately.