Cogito, ergo sum

UE3:UTUIFrontEnd_SettingsVideoAdvanced (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_SettingsVideoAdvanced
Package: 
UTGame

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

Advanced video settings for the PC.

Properties[edit]

bCustomizedSettings[edit]

Type: bool

Modifiers: transient

Has the user customized any settings?

bNeedsCaptionRefresh[edit]

Type: bool

Modifiers: transient

Do we need to update the captions next tick?

bRequireRestartWarning[edit]

Type: bool

Modifiers: transient

If any properties are modified which require a restart, this will trigger the restart warning dialog when the user clicks 'apply'

MessageBoxReference[edit]

Type: UTUIScene_MessageBox

Modifiers: transient

Reference to the messagebox scene.

OptionsPage[edit]

Type: UTUITabPage_Options

Modifiers: transient

Pointer to the options page.

SettingWidgetMapping[edit]

Type: array<name>

Modifiers: transient

Array of setting types to widget names.

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Enums[edit]

EPossibleVideoSettings[edit]

Possible settings enum.

PVS_ScreenPercentage 
PVS_TextureDetail 
PVS_WorldDetail 
PVS_FXDetail 
PVS_DecalQuality 
PVS_LightingQuality 
PVS_ShadowQuality 
PVS_PostProcessQuality 
PVS_VSyncValue 
PVS_SmoothFramerate 
PVS_PlayerFOV 
PVS_EnableMotionBlur 
PVS_FirstDirectWorldDetailSetting 
PVS_StaticDecals 
PVS_DynamicDecals 
PVS_DynamicLights 
PVS_DynamicShadows 
PVS_LightEnvironmentShadows 
PVS_CompositeDynamicLights 
PVS_DirectionalLightmaps 
PVS_DepthOfField 
PVS_Bloom 
PVS_QualityBloom 
PVS_Distortion 
PVS_DropParticleDistortion 
PVS_SpeedTreeLeaves 
PVS_SpeedTreeFronds 
PVS_DetailMode 
PVS_LensFlares 
PVS_FogVolumes 
PVS_FloatingPointRenderTargets 
PVS_OneFrameThreadLag 
PVS_SkeletalMeshLODBias 
PVS_HighPolyChars 
PVS_ParticleLODBias 
PVS_ShadowFilterQualityBias 
PVS_LastDirectWorldDetailSetting 

Functions[edit]

Native functions[edit]

GetVideoSettingValue[edit]

native function int GetVideoSettingValue (EPossibleVideoSettings Setting)

Parameters:

  • Setting - Setting to get the value of

Returns:

Returns the current value of the specified setting.

ResetToDefaults[edit]

native function ResetToDefaults ()


SetVideoSettingValue[edit]

native function SetVideoSettingValue (EPossibleVideoSettings Setting, int Value)

Sets the value of the video setting.

Parameters:

  • Setting - Setting to set the value of
  • Value - New value for the setting

SetVideoSettingValueArray[edit]

native function SetVideoSettingValueArray (array<EPossibleVideoSettingsSettings, array<intValues)

Sets the value of multiple video settings at once.

Parameters:

  • Setting - Array of settings to set the value of
  • Value - New values for teh settings

Events[edit]

PerformUpdateSpecialCaptions[edit]

event PerformUpdateSpecialCaptions ()


PostInitialize[edit]

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

Post initialize callback.

SetPlayerFOV[edit]

event SetPlayerFOV (int NewFOV)


Other instance functions[edit]

HandleInputKey[edit]

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

Overrides: UTUIFrontEnd.HandleInputKey

Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.)

Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8).

This delegate is called BEFORE kismet is given a chance to process the input.

Parameters:

  • EventParms - information about the input event.

Returns:

TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

LevelToName[edit]

function string LevelToName (int Level)


OnAccept[edit]

function OnAccept ()

Callback for when the user wants to save their options.

OnAcceptOptions[edit]

function OnAcceptOptions (UIScreenObject InScreenObject, int InPlayerIndex)

Callback for when the user accepts the options list.

OnBack[edit]

function OnBack ()

Callback for when the user wants to exit this screen.

OnButtonBar_Accept[edit]

function bool OnButtonBar_Accept (UIScreenObject InButton, int PlayerIndex)

Button bar callbacks.

OnButtonBar_Back[edit]

function bool OnButtonBar_Back (UIScreenObject InButton, int PlayerIndex)


OnButtonBar_ResetToDefaults[edit]

function bool OnButtonBar_ResetToDefaults (UIScreenObject InButton, int InPlayerIndex)


OnOptionChanged[edit]

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

Called when one of our options changes.

OnResetToDefaults[edit]

function OnResetToDefaults ()

Reset to defaults callback, resets all of the profile options in this widget to their default values.

OnResetToDefaults_Confirm[edit]

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

Callback for the reset to defaults confirmation dialog box.

Parameters:

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

SetupButtonBar[edit]

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Callback to setup the buttonbar for this scene.

UpdateCaption[edit]

function UpdateCaption (EPossibleVideoSettings Setting, int Offset)


UpdateSpecialCaptions[edit]

function UpdateSpecialCaptions ()


WarningMessage_Closed[edit]

function WarningMessage_Closed ()

Callback for when the warning message has closed.