Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

UTGame.UTUIScene

Extends
UIScene
Modifiers
abstract native ( UI ) dependson ( OnlinePlayerInterface , UTGameInteraction )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Our UIScenes provide PreRender and tick passes to our Widgets 

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIScene
         |   
         +-- UTGame.UTUIScene

Direct Known Subclasses:

UTUIFrontEnd, UTUIFrontEnd_MapSelection, UTUIFrontEnd_TitleScreen, UTUIScene_AnimTest, UTUIScene_Campaign, UTUIScene_DemoSell, UTUIScene_Hud, UTUIScene_MessageBox, UTUIScene_OnlineToast, UTUIScene_SaveProfile, UTUIScene_TimedTutorialMessage, UTUIScene_TutorialMessage
Constants Summary
CONTEXT_ALLOWKEYBOARD=11
CONTEXT_ALLOWKEYBOARD_ANY=2
CONTEXT_ALLOWKEYBOARD_NO=0
CONTEXT_ALLOWKEYBOARD_YES=1
CONTEXT_BOTSKILL=0
CONTEXT_BOTSKILL_ADEPT=5
CONTEXT_BOTSKILL_AUTOADJUSTSKILL=0
CONTEXT_BOTSKILL_AVERAGE=2
CONTEXT_BOTSKILL_EXPERIENCED=3
CONTEXT_BOTSKILL_GODLIKE=8
CONTEXT_BOTSKILL_INHUMAN=7
CONTEXT_BOTSKILL_MASTERFUL=6
CONTEXT_BOTSKILL_NOVICE=1
CONTEXT_BOTSKILL_SKILLED=4
CONTEXT_CAMPAIGN=9
CONTEXT_CAMPAIGN_NO=0
CONTEXT_CAMPAIGN_YES=1
CONTEXT_DEDICATEDSERVER=14
CONTEXT_DEDICATEDSERVER_NO=0
CONTEXT_DEDICATEDSERVER_YES=1
CONTEXT_EMPTYSERVER=13
CONTEXT_EMPTYSERVER_NO=0
CONTEXT_EMPTYSERVER_YES=1
CONTEXT_FORCERESPAWN=10
CONTEXT_FORCERESPAWN_NO=0
CONTEXT_FORCERESPAWN_YES=1
CONTEXT_FULLSERVER=12
CONTEXT_FULLSERVER_NO=0
CONTEXT_FULLSERVER_YES=1
CONTEXT_GAME_MODE=0x0000800B
CONTEXT_GAME_MODE_BETRAYAL=9
CONTEXT_GAME_MODE_CAMPAIGN=7
CONTEXT_GAME_MODE_CTF=1
CONTEXT_GAME_MODE_CUSTOM=6
CONTEXT_GAME_MODE_DM=0
CONTEXT_GAME_MODE_DUEL=5
CONTEXT_GAME_MODE_GREED=8
CONTEXT_GAME_MODE_TDM=4
CONTEXT_GAME_MODE_VCTF=3
CONTEXT_GAME_MODE_WAR=2
CONTEXT_GOALSCORE_10=1
CONTEXT_GOALSCORE_15=2
CONTEXT_GOALSCORE_20=3
CONTEXT_GOALSCORE_30=4
CONTEXT_GOALSCORE_5=0
CONTEXT_LOCKEDSERVER=7
CONTEXT_LOCKEDSERVER_NO=0
CONTEXT_LOCKEDSERVER_YES=1
CONTEXT_MAPNAME=1
CONTEXT_MAPNAME_ARSENAL=7
CONTEXT_MAPNAME_AVALANCHE=28
CONTEXT_MAPNAME_BIOHAZARD=8
CONTEXT_MAPNAME_CARBON_FIRE=9
CONTEXT_MAPNAME_COLDHARBOR=51
CONTEXT_MAPNAME_CONFRONTATION=62
CONTEXT_MAPNAME_CONTAINMENT=21
CONTEXT_MAPNAME_CONTAINMENTSP=22
CONTEXT_MAPNAME_CORET=1
CONTEXT_MAPNAME_CORRUPTION=23
CONTEXT_MAPNAME_CUSTOM=0
CONTEXT_MAPNAME_DARKMATCH=57
CONTEXT_MAPNAME_DECK=10
CONTEXT_MAPNAME_DEFIANCE=11
CONTEXT_MAPNAME_DEIMOS=12
CONTEXT_MAPNAME_DIESEL=13
CONTEXT_MAPNAME_DOWNTOWN=29
CONTEXT_MAPNAME_DOWNTOWNNECRIS=52
CONTEXT_MAPNAME_DUSK=30
CONTEXT_MAPNAME_EDENINC=59
CONTEXT_MAPNAME_FACINGWORLDS=47
CONTEXT_MAPNAME_FEARLESS=14
CONTEXT_MAPNAME_FLOODGATE=31
CONTEXT_MAPNAME_GATEWAY=15
CONTEXT_MAPNAME_HEAT_RAY=16
CONTEXT_MAPNAME_HOSTILE=63
CONTEXT_MAPNAME_HYDROSIS=2
CONTEXT_MAPNAME_ISLANDER=32
CONTEXT_MAPNAME_ISLANDERNECRIS=33
CONTEXT_MAPNAME_KARGO=24
CONTEXT_MAPNAME_KBARGE=45
CONTEXT_MAPNAME_LOSTCAUSE=53
CONTEXT_MAPNAME_MARKET_DISTRICT=34
CONTEXT_MAPNAME_MISSION_SELECTION=44
CONTEXT_MAPNAME_MORBIAS=46
CONTEXT_MAPNAME_MORBID=54
CONTEXT_MAPNAME_NANOBLACK=55
CONTEXT_MAPNAME_NECROPOLIS=25
CONTEXT_MAPNAME_OCEANRELIC=58
CONTEXT_MAPNAME_OMICRON_DAWN=3
CONTEXT_MAPNAME_ONYX_COAST=35
CONTEXT_MAPNAME_POWER_SURGE=36
CONTEXT_MAPNAME_RAILS=49
CONTEXT_MAPNAME_REFLECTION=4
CONTEXT_MAPNAME_RISING_SUN=17
CONTEXT_MAPNAME_SANCTUARY=18
CONTEXT_MAPNAME_SANDSTORM=26
CONTEXT_MAPNAME_SEARCHLIGHT=48
CONTEXT_MAPNAME_SENTINEL=19
CONTEXT_MAPNAME_SERENITY=37
CONTEXT_MAPNAME_SERENITYNECRIS=38
CONTEXT_MAPNAME_SHAFT=56
CONTEXT_MAPNAME_SHANGRILA=20
CONTEXT_MAPNAME_SINKHOLE=39
CONTEXT_MAPNAME_STRANDED=61
CONTEXT_MAPNAME_STRIDENT=5
CONTEXT_MAPNAME_SUSPENSE=27
CONTEXT_MAPNAME_SUSPENSE_NECRIS=50
CONTEXT_MAPNAME_TANK_CROSSING=40
CONTEXT_MAPNAME_TORLAN=41
CONTEXT_MAPNAME_TORLANLEVIATHAN=42
CONTEXT_MAPNAME_TORLANNECRIS=43
CONTEXT_MAPNAME_TURBINE=60
CONTEXT_MAPNAME_VERTEBRAE=6
CONTEXT_NUMBOTS_0=0
CONTEXT_NUMBOTS_1=1
CONTEXT_NUMBOTS_2=2
CONTEXT_NUMBOTS_3=3
CONTEXT_NUMBOTS_4=4
CONTEXT_NUMBOTS_5=5
CONTEXT_NUMBOTS_6=6
CONTEXT_NUMBOTS_7=7
CONTEXT_NUMBOTS_8=8
CONTEXT_PRESENCE_MENUPRESENCE=0
CONTEXT_PURESERVER=6
CONTEXT_PURESERVER_ANY=2
CONTEXT_PURESERVER_NO=0
CONTEXT_PURESERVER_YES=1
CONTEXT_TIMELIMIT_10=1
CONTEXT_TIMELIMIT_15=2
CONTEXT_TIMELIMIT_20=3
CONTEXT_TIMELIMIT_30=4
CONTEXT_TIMELIMIT_5=0
CONTEXT_VSBOTS=8
CONTEXT_VSBOTS_1_TO_1=2
CONTEXT_VSBOTS_1_TO_2=1
CONTEXT_VSBOTS_2_TO_1=4
CONTEXT_VSBOTS_3_TO_1=5
CONTEXT_VSBOTS_3_TO_2=3
CONTEXT_VSBOTS_4_TO_1=6
CONTEXT_VSBOTS_NONE=0
GS_CDKEY_PART_MAXLENGTH=4
GS_EMAIL_MAXLENGTH=50
GS_MESSAGE_MAXLENGTH=255
GS_PASSWORD_MAXLENGTH=30
GS_USERNAME_MAXLENGTH=15
PROPERTY_CUSTOMGAMEMODE=0x40000002
PROPERTY_CUSTOMMAPNAME=0x40000001
PROPERTY_CUSTOMMUTATORS=0x40000004
PROPERTY_CUSTOMMUTCLASSES=0x40000005
PROPERTY_EPICMUTATORS=0x10000105
PROPERTY_GOALSCORE=0x100000F8
PROPERTY_LEADERBOARDRATING=0x20000004
PROPERTY_NUMBOTS=0x100000F7
PROPERTY_NUMBOTSIA=0x100000FA
PROPERTY_SERVERDESCRIPTION=0x40000003
PROPERTY_STEAMID=0x10000200
PROPERTY_STEAMVAC=0x10000201
PROPERTY_TIMELIMIT=0x100000F9
QUERY_BETRAYAL=8
QUERY_CAMPAIGN=6
QUERY_CTF=2
QUERY_DM=0
QUERY_DUEL=5
QUERY_GREED=7
QUERY_TDM=1
QUERY_VCTF=3
QUERY_WAR=4
STATS_VIEW_DM_PLAYER_ALLTIME=1
STATS_VIEW_DM_RANKED_ALLTIME=2
STATS_VIEW_DM_VEHICLES_ALLTIME=4
STATS_VIEW_DM_VEHICLES_RANKED_ALLTIME=6
STATS_VIEW_DM_VEHICLEWEAPONS_ALLTIME=5
STATS_VIEW_DM_VEHICLEWEAPONS_RANKED_ALLTIME=7
STATS_VIEW_DM_WEAPONS_ALLTIME=3
STATS_VIEW_DM_WEAPONS_RANKED_ALLTIME=8

Variables Summary
boolbHidingScene
boolbShowingScene
boolbSkipPendingCloseSceneNotify
UISceneInputBoxScene
UISceneMessageBoxScene
UISceneOnlineToastScene
UIScenePendingCloseScene
UIScenePendingOpenScene
UIScenePlayerCardScene
Editor
boolbEditorRealTimePreview
Flags
boolbIgnoreAxisInput
Inherited Variables from Engine.UIScene
ActiveContextMenu, ActiveToolTip, bAlwaysRenderScene, bCloseOnLevelChange, bDisableWorldRendering, bDisplayCursor, bEnableSceneDepthTesting, bEnableScenePostProcessing, bExemptFromAutoClose, bFlushPlayerInput, bIssuedPreRenderCallback, bMenuLevelRestoresScene, bMouseBoundsSet, bPauseGameWhileActive, bRefreshStringFormatting, bRefreshWidgetStyles, bRenderParentScenes, bRequiresNetwork, bRequiresOnlineService, bResolvingScenePositions, bSaveSceneValuesOnClose, bUpdateDockingStack, bUpdateNavigationLinks, bUpdatePrimitiveUsage, bUpdateScenePositions, bUsesPrimitives, CurrentViewportSize, DefaultContextMenuClass, DefaultToolTipClass, DockingStack, InputSubscriptions, LastPlayerIndex, MouseBounds, PlayerOwner, RenderStack, SceneClient, SceneClosedCue, SceneData, SceneInputMode, SceneLayerRoot, SceneOpenedCue, ScenePreview, SceneRenderMode, SceneTag, StandardContextMenu, StandardToolTip
Inherited Variables from Engine.UIScreenObject
bHidden, bInitialized, bNeverFocus, bSupports3DPrimitives, Children, DefaultStates, EventProvider, FocusControls, FocusedCue, FocusPropagation, InactiveStates, InitialState, MouseEnterCue, NavigateDownCue, NavigateLeftCue, NavigateRightCue, NavigateUpCue, Opacity, PlayerInputMask, Position, StateStack, ZDepth

Enumerations Summary
EUTBotTeam
UTBotTeam_Random, UTBotTeam_Ironguard, UTBotTeam_TwinSouls, UTBotTeam_Krall, UTBotTeam_Liandri, UTBotTeam_Necris
EUTRecordDemo
UTRecordDemo_No, UTRecordDemo_Yes,

Delegates Summary
delegate OnHideAnimationEnded ()
delegate OnSceneOpened (UIScene OpenedScene, bool bInitialActivation)
delegate OnShowAnimationEnded ()
Inherited Delegates from Engine.UIScene
GetSceneInputMode, OnSceneActivated, OnSceneDeactivated, OnTopSceneChanged, ShouldModulateBackgroundAlpha
Inherited Delegates from Engine.UIScreenObject
NotifyActiveSkinChanged, NotifyActiveStateChanged, NotifyPositionChanged, NotifyResolutionChanged, NotifyVisibilityChanged, OnPreRenderCallBack, OnProcessInputAxis, OnProcessInputKey, OnRawInputAxis, OnRawInputKey

Functions Summary
function ActivateLevelEvent (name EventName)
function AnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq))
functionbool BeginHideAnimation (bool bClosingScene=false))
functionbool BeginShowAnimation (bool bInitialActivation=true, bool bBypassAnimation=false))
functionbool CheckCommunicationPrivilegeAndError (int ControllerId=INDEX_NONE, optional string AlternateTitle, optional string AlternateMessage ))
functionbool CheckContentPrivilegeAndError (int ControllerId=INDEX_NONE, optional string AlternateTitle, optional string AlternateMessage ))
functionbool CheckForAutoLogin (out string Username, out string Password)
functionbool CheckLinkConnectionAndError (optional string AlternateTitle, optional string AlternateMessage ))
functionbool CheckLoginAndError (int ControllerId=INDEX_NONE, optional bool bMustBeLoggedInOnline=false, optional string AlternateTitle, optional string AlternateMessage))
functionbool CheckNatTypeAndDisplayError (int ControllerId=GetBestControllerId(), optional string AlternateTitle, optional string AlternateMessage ))
functionbool CheckOnlinePrivilegeAndError (int ControllerId=INDEX_NONE, optional string AlternateTitle, optional string AlternateMessage ))
functionbool CloseScene (UIScene SceneToClose, bool bSkipKismetNotify=false, bool bSkipAnimation=false))
functionbool ConditionallyCheckNumControllers ()))
function ConditionallyStartSplitscreen ()))
function ConsoleCommand (string Cmd, optional bool bWriteToLog))
function DeleteDemo (string DemoName)
functionUTUIScene_MessageBox DisplayMessageBox (string Message, optional string Title=""))
functionUIDataStore FindDataStore (name DataStoreTag, optional LocalPlayer InPlayerOwner))
function FinishCloseScene (UIScene SceneToClose, bool bSkipAnimations=false, bool bSkipKismetNotify=false))
functionUIScene FinishOpenScene (UIScene SceneToOpen, bool bSkipAnimation=false, bool bSkipKismetNotify=false))
functionstring GenerateDemoFileName ()))
functionOnlineAccountInterface GetAccountInterface ()))
functionname GetBotTeamNameFromIndex (EUTBotTeam TeamIndex))
functionstring GetCommonOptionsURL ()))
functionstring GetCurrentAudioDevice ()
functionOnlineGameInterface GetGameInterface ()))
functionUTUIScene_InputBox GetInputBoxScene ()))
functionUTUIScene_MessageBox GetMessageBoxScene (optional UIScene SceneReference = None))
functionPawn GetPawnOwner ()
functionint GetPlayerControllerId (int PlayerIndex))
functionint GetPlayerIndex ()))
functionOnlinePlayerInterface GetPlayerInterface ()))
functionOnlinePlayerInterfaceEx GetPlayerInterfaceEx ()))
functionstring GetPlayerName (int PlayerIndex=INDEX_NONE))
functionUTProfileSettings GetPlayerProfile (optional int PlayerIndex=GetBestPlayerIndex() ))
functionUTProfileSettings GetPlayerProfileFromPC (PlayerController PC ))
function GetPossibleAudioDevices (out array<string> OutResults)
function GetPossibleScreenResolutions (out array<string> OutResults)
functionUTPlayerReplicationInfo GetPRIOwner ()
functionUTGameInteraction GetUTInteraction ()))
functionUTPlayerController GetUTPlayerOwner (optional int PlayerIndex=-1)
functionWorldInfo GetWorldInfo ()
function HideOnlineToast ()))
functionbool IsBelowMinSpecs () con)
eventbool IsControllerInput (name KeyName))
functionbool IsGame ()
function NotifyChildGameSessionEnded (UIObject Child))
function NotifyGameSessionEnded ()))
event OnAnimationFinished (UIObject AnimTarget, name AnimName, name SeqName)
function OnCurrentScene_HideAnimationEnded ()))
function OnLoginError_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex)
function OnLoginUI_LoginChange ()))
function OnLoginUI_LoginFailed (byte LocalUserNum, OnlineServerConnectionStatus ErrorCode))
function OnPendingCloseScene_HideAnimationEnded ()))
functionbool OpenCmdLineURL ()
functionUIScene OpenScene (UIScene SceneToOpen, optional bool bSkipAnimation=false, optional delegate<OnSceneActivated> SceneDelegate=None))
functionUIScene OpenSceneByName (string SceneToOpen, bool bSkipAnimation=false, optional delegate<OnSceneActivated> SceneDelegate=None))
function PlaySound (SoundCue InSoundCue, optional bool bIsUISound))
function SavePlayerProfile (optional int PlayerIndex=GetBestPlayerIndex()))
function SetAudioDeviceToUse (string InAudioDevice)
function SetLanPlay (bool bValue)
function SetScreenResolution (int ResX, int ResY, bool bFullscreen)
function SetupButtonBar ()
function ShowLoginUI (optional bool bOnlineOnly=false))
function ShowOnlineToast (string InMessage, optional float ToastTime=3.0f, optional int Priority=0))
functionUTUIScene_PlayerCard ShowPlayerCard (UniqueNetId InPlayerId, optional string InPlayerName, optional string InAccountName, optional bool bIncludeKickOption, optional bool bIncludeBanOption))
function StartDedicatedServer (string TravelURL)
functionUIScene StaticOpenScene (UIScene SceneToOpen))
functionstring TrimWhitespace (string InString))
functionbool TryCharacterUnlock (string UnlockCode)
function UpdateSplitscreenPlayers (bool bCreatePlayers)
function ViewportDeProject (LocalPlayer LocalPlayerOwner, vector ScreenLocation, out vector OutLocation, out vector OutDirection)
function ViewportProject (LocalPlayer LocalPlayerOwner, vector WorldLocation, out vector OutScreenLocation)
Inherited Functions from Engine.UIScene
AnimEnd, CalculateInputMask, CloseScene, ForceImmediateSceneUpdate, GetActiveContextMenu, GetActiveToolTip, GetDefaultContextMenu, GetDefaultToolTip, GetPreviousScene, GetSceneDataStore, GetWorldInfo, IsSceneActive, LoadSceneDataValues, LogCurrentState, LogDockingStack, LogRenderBounds, NotifyGameSessionEnded, NotifyLinkStatusChanged, NotifyOnlineServiceStatusChanged, OpenScene, RebuildDockingStack, ResetMouseBounds, ResolveDataStore, ResolveScenePositions, SaveSceneDataValues, SceneActivated, SceneCreated, SceneDeactivated, SetActiveContextMenu, SetActiveToolTip, SetInputMask, SetMouseBounds, SetSceneInputMode, SetVisibility, UnbindSubscribers
Inherited Functions from Engine.UIScreenObject
AcceptsPlayerInput, ActivateEventByClass, ActivateState, ActivateStateByClass, AddedChild, CanAcceptFocus, CanPlayOnline, CanPropagateFocusFor, CanvasToScreen, ConditionalPropagateEnabledState, ContainsChild, ContainsChildOfClass, CreatePlayerData, CreateWidget, DeactivateState, DeactivateStateByClass, DeProject, DisablePlayerInput, DisableWidget, EnablePlayerInput, EnableWidget, FindChild, FindChildIndex, FindChildUsingID, FindEventsOfClass, FocusFirstControl, FocusLastControl, GetActivePlayerCount, GetAspectRatioAutoScaleFactor, GetBestControllerId, GetBestPlayerIndex, GetBounds, GetCanvasToScreen, GetChildren, GetCurrentState, GetDockedWidgets, GetFocusedControl, GetInverseCanvasToScreen, GetLastFocusedControl, GetLoginStatus, GetNATType, GetObjectCount, GetParent, GetPlayerOwner, GetPosition, GetPositionVector, GetSupportedPlayerCount, GetSupportedUIActionKeyNames, GetViewportHeight, GetViewportOffset, GetViewportOrigin, GetViewportScale, GetViewportSize, GetViewportWidth, GetWidgetPathName, HasActiveStateOfClass, HasLinkConnection, Initialize, Initialized, InitializePlayerTracking, InsertChild, IsActive, IsEnabled, IsFocused, IsHidden, IsHoldingAlt, IsHoldingCtrl, IsHoldingShift, IsInitialized, IsLoggedIn, IsNeverFocused, IsPressed, IsVisible, KillFocus, LogCurrentState, NavigateFocus, NextControl, OnChangeVisibility, OnConsoleCommand, OnSetControllerId, OnShowAchievementsUI, OnShowContentMarketplaceUI, OnShowFeedbackUI, OnShowFriendInviteUI, OnShowFriendsUI, OnShowGamerCardUI, OnShowMembershipMarketplaceUI, OnShowMessagesUI, OnShowPlayersUI, OverrideLastFocusedControl, PixelToCanvas, PixelToScreen, PlayUISound, PostInitialize, PrevControl, PrivateSetVisibility, Project, RebuildNavigationLinks, RemoveChild, RemoveChildren, RemovedChild, RemovedFromParent, RemovePlayerData, ReplaceChild, RequestFormattingUpdate, RequestPrimitiveReview, RequestSceneUpdate, ScreenToCanvas, ScreenToPixel, SetEnabled, SetFocus, SetFocusToChild, SetInputMask, SetPosition, SetVisibility

Constants Detail

CONTEXT_ALLOWKEYBOARD Source code

const CONTEXT_ALLOWKEYBOARD = 11;

CONTEXT_ALLOWKEYBOARD_ANY Source code

const CONTEXT_ALLOWKEYBOARD_ANY = 2;

CONTEXT_ALLOWKEYBOARD_NO Source code

const CONTEXT_ALLOWKEYBOARD_NO = 0;

CONTEXT_ALLOWKEYBOARD_YES Source code

const CONTEXT_ALLOWKEYBOARD_YES = 1;

CONTEXT_BOTSKILL Source code

const CONTEXT_BOTSKILL = 0;

CONTEXT_BOTSKILL_ADEPT Source code

const CONTEXT_BOTSKILL_ADEPT = 5;

CONTEXT_BOTSKILL_AUTOADJUSTSKILL Source code

const CONTEXT_BOTSKILL_AUTOADJUSTSKILL = 0;

CONTEXT_BOTSKILL_AVERAGE Source code

const CONTEXT_BOTSKILL_AVERAGE = 2;

CONTEXT_BOTSKILL_EXPERIENCED Source code

const CONTEXT_BOTSKILL_EXPERIENCED = 3;

CONTEXT_BOTSKILL_GODLIKE Source code

const CONTEXT_BOTSKILL_GODLIKE = 8;

CONTEXT_BOTSKILL_INHUMAN Source code

const CONTEXT_BOTSKILL_INHUMAN = 7;

CONTEXT_BOTSKILL_MASTERFUL Source code

const CONTEXT_BOTSKILL_MASTERFUL = 6;

CONTEXT_BOTSKILL_NOVICE Source code

const CONTEXT_BOTSKILL_NOVICE = 1;

CONTEXT_BOTSKILL_SKILLED Source code

const CONTEXT_BOTSKILL_SKILLED = 4;

CONTEXT_CAMPAIGN Source code

const CONTEXT_CAMPAIGN = 9;

CONTEXT_CAMPAIGN_NO Source code

const CONTEXT_CAMPAIGN_NO = 0;

CONTEXT_CAMPAIGN_YES Source code

const CONTEXT_CAMPAIGN_YES = 1;

CONTEXT_DEDICATEDSERVER Source code

const CONTEXT_DEDICATEDSERVER = 14;

CONTEXT_DEDICATEDSERVER_NO Source code

const CONTEXT_DEDICATEDSERVER_NO = 0;

CONTEXT_DEDICATEDSERVER_YES Source code

const CONTEXT_DEDICATEDSERVER_YES = 1;

CONTEXT_EMPTYSERVER Source code

const CONTEXT_EMPTYSERVER = 13;

CONTEXT_EMPTYSERVER_NO Source code

const CONTEXT_EMPTYSERVER_NO = 0;

CONTEXT_EMPTYSERVER_YES Source code

const CONTEXT_EMPTYSERVER_YES = 1;

CONTEXT_FORCERESPAWN Source code

const CONTEXT_FORCERESPAWN = 10;

CONTEXT_FORCERESPAWN_NO Source code

const CONTEXT_FORCERESPAWN_NO = 0;

CONTEXT_FORCERESPAWN_YES Source code

const CONTEXT_FORCERESPAWN_YES = 1;

CONTEXT_FULLSERVER Source code

const CONTEXT_FULLSERVER = 12;

CONTEXT_FULLSERVER_NO Source code

const CONTEXT_FULLSERVER_NO = 0;

CONTEXT_FULLSERVER_YES Source code

const CONTEXT_FULLSERVER_YES = 1;

CONTEXT_GAME_MODE Source code

const CONTEXT_GAME_MODE = 0x0000800B;

CONTEXT_GAME_MODE_BETRAYAL Source code

const CONTEXT_GAME_MODE_BETRAYAL = 9;

CONTEXT_GAME_MODE_CAMPAIGN Source code

const CONTEXT_GAME_MODE_CAMPAIGN = 7;

CONTEXT_GAME_MODE_CTF Source code

const CONTEXT_GAME_MODE_CTF = 1;

CONTEXT_GAME_MODE_CUSTOM Source code

const CONTEXT_GAME_MODE_CUSTOM = 6;

CONTEXT_GAME_MODE_DM Source code

const CONTEXT_GAME_MODE_DM = 0;

CONTEXT_GAME_MODE_DUEL Source code

const CONTEXT_GAME_MODE_DUEL = 5;

CONTEXT_GAME_MODE_GREED Source code

const CONTEXT_GAME_MODE_GREED = 8;

CONTEXT_GAME_MODE_TDM Source code

const CONTEXT_GAME_MODE_TDM = 4;

CONTEXT_GAME_MODE_VCTF Source code

const CONTEXT_GAME_MODE_VCTF = 3;

CONTEXT_GAME_MODE_WAR Source code

const CONTEXT_GAME_MODE_WAR = 2;

CONTEXT_GOALSCORE_10 Source code

const CONTEXT_GOALSCORE_10 = 1;

CONTEXT_GOALSCORE_15 Source code

const CONTEXT_GOALSCORE_15 = 2;

CONTEXT_GOALSCORE_20 Source code

const CONTEXT_GOALSCORE_20 = 3;

CONTEXT_GOALSCORE_30 Source code

const CONTEXT_GOALSCORE_30 = 4;

CONTEXT_GOALSCORE_5 Source code

const CONTEXT_GOALSCORE_5 = 0;

CONTEXT_LOCKEDSERVER Source code

const CONTEXT_LOCKEDSERVER = 7;

CONTEXT_LOCKEDSERVER_NO Source code

const CONTEXT_LOCKEDSERVER_NO = 0;

CONTEXT_LOCKEDSERVER_YES Source code

const CONTEXT_LOCKEDSERVER_YES = 1;

CONTEXT_MAPNAME Source code

const CONTEXT_MAPNAME = 1;

CONTEXT_MAPNAME_ARSENAL Source code

const CONTEXT_MAPNAME_ARSENAL = 7;

CONTEXT_MAPNAME_AVALANCHE Source code

const CONTEXT_MAPNAME_AVALANCHE = 28;

CONTEXT_MAPNAME_BIOHAZARD Source code

const CONTEXT_MAPNAME_BIOHAZARD = 8;

CONTEXT_MAPNAME_CARBON_FIRE Source code

const CONTEXT_MAPNAME_CARBON_FIRE = 9;

CONTEXT_MAPNAME_COLDHARBOR Source code

const CONTEXT_MAPNAME_COLDHARBOR = 51;

CONTEXT_MAPNAME_CONFRONTATION Source code

const CONTEXT_MAPNAME_CONFRONTATION = 62;

CONTEXT_MAPNAME_CONTAINMENT Source code

const CONTEXT_MAPNAME_CONTAINMENT = 21;

CONTEXT_MAPNAME_CONTAINMENTSP Source code

const CONTEXT_MAPNAME_CONTAINMENTSP = 22;

CONTEXT_MAPNAME_CORET Source code

const CONTEXT_MAPNAME_CORET = 1;

CONTEXT_MAPNAME_CORRUPTION Source code

const CONTEXT_MAPNAME_CORRUPTION = 23;

CONTEXT_MAPNAME_CUSTOM Source code

const CONTEXT_MAPNAME_CUSTOM = 0;

CONTEXT_MAPNAME_DARKMATCH Source code

const CONTEXT_MAPNAME_DARKMATCH = 57;

CONTEXT_MAPNAME_DECK Source code

const CONTEXT_MAPNAME_DECK = 10;

CONTEXT_MAPNAME_DEFIANCE Source code

const CONTEXT_MAPNAME_DEFIANCE = 11;

CONTEXT_MAPNAME_DEIMOS Source code

const CONTEXT_MAPNAME_DEIMOS = 12;

CONTEXT_MAPNAME_DIESEL Source code

const CONTEXT_MAPNAME_DIESEL = 13;

CONTEXT_MAPNAME_DOWNTOWN Source code

const CONTEXT_MAPNAME_DOWNTOWN = 29;

CONTEXT_MAPNAME_DOWNTOWNNECRIS Source code

const CONTEXT_MAPNAME_DOWNTOWNNECRIS = 52;

CONTEXT_MAPNAME_DUSK Source code

const CONTEXT_MAPNAME_DUSK = 30;

CONTEXT_MAPNAME_EDENINC Source code

const CONTEXT_MAPNAME_EDENINC = 59;

CONTEXT_MAPNAME_FACINGWORLDS Source code

const CONTEXT_MAPNAME_FACINGWORLDS = 47;

CONTEXT_MAPNAME_FEARLESS Source code

const CONTEXT_MAPNAME_FEARLESS = 14;

CONTEXT_MAPNAME_FLOODGATE Source code

const CONTEXT_MAPNAME_FLOODGATE = 31;

CONTEXT_MAPNAME_GATEWAY Source code

const CONTEXT_MAPNAME_GATEWAY = 15;

CONTEXT_MAPNAME_HEAT_RAY Source code

const CONTEXT_MAPNAME_HEAT_RAY = 16;

CONTEXT_MAPNAME_HOSTILE Source code

const CONTEXT_MAPNAME_HOSTILE = 63;

CONTEXT_MAPNAME_HYDROSIS Source code

const CONTEXT_MAPNAME_HYDROSIS = 2;

CONTEXT_MAPNAME_ISLANDER Source code

const CONTEXT_MAPNAME_ISLANDER = 32;

CONTEXT_MAPNAME_ISLANDERNECRIS Source code

const CONTEXT_MAPNAME_ISLANDERNECRIS = 33;

CONTEXT_MAPNAME_KARGO Source code

const CONTEXT_MAPNAME_KARGO = 24;

CONTEXT_MAPNAME_KBARGE Source code

const CONTEXT_MAPNAME_KBARGE = 45;

CONTEXT_MAPNAME_LOSTCAUSE Source code

const CONTEXT_MAPNAME_LOSTCAUSE = 53;

CONTEXT_MAPNAME_MARKET_DISTRICT Source code

const CONTEXT_MAPNAME_MARKET_DISTRICT = 34;

CONTEXT_MAPNAME_MISSION_SELECTION Source code

const CONTEXT_MAPNAME_MISSION_SELECTION = 44;

CONTEXT_MAPNAME_MORBIAS Source code

const CONTEXT_MAPNAME_MORBIAS = 46;

CONTEXT_MAPNAME_MORBID Source code

const CONTEXT_MAPNAME_MORBID = 54;

CONTEXT_MAPNAME_NANOBLACK Source code

const CONTEXT_MAPNAME_NANOBLACK = 55;

CONTEXT_MAPNAME_NECROPOLIS Source code

const CONTEXT_MAPNAME_NECROPOLIS = 25;

CONTEXT_MAPNAME_OCEANRELIC Source code

const CONTEXT_MAPNAME_OCEANRELIC = 58;

CONTEXT_MAPNAME_OMICRON_DAWN Source code

const CONTEXT_MAPNAME_OMICRON_DAWN = 3;

CONTEXT_MAPNAME_ONYX_COAST Source code

const CONTEXT_MAPNAME_ONYX_COAST = 35;

CONTEXT_MAPNAME_POWER_SURGE Source code

const CONTEXT_MAPNAME_POWER_SURGE = 36;

CONTEXT_MAPNAME_RAILS Source code

const CONTEXT_MAPNAME_RAILS = 49;

CONTEXT_MAPNAME_REFLECTION Source code

const CONTEXT_MAPNAME_REFLECTION = 4;

CONTEXT_MAPNAME_RISING_SUN Source code

const CONTEXT_MAPNAME_RISING_SUN = 17;

CONTEXT_MAPNAME_SANCTUARY Source code

const CONTEXT_MAPNAME_SANCTUARY = 18;

CONTEXT_MAPNAME_SANDSTORM Source code

const CONTEXT_MAPNAME_SANDSTORM = 26;

CONTEXT_MAPNAME_SEARCHLIGHT Source code

const CONTEXT_MAPNAME_SEARCHLIGHT = 48;

CONTEXT_MAPNAME_SENTINEL Source code

const CONTEXT_MAPNAME_SENTINEL = 19;

CONTEXT_MAPNAME_SERENITY Source code

const CONTEXT_MAPNAME_SERENITY = 37;

CONTEXT_MAPNAME_SERENITYNECRIS Source code

const CONTEXT_MAPNAME_SERENITYNECRIS = 38;

CONTEXT_MAPNAME_SHAFT Source code

const CONTEXT_MAPNAME_SHAFT = 56;

CONTEXT_MAPNAME_SHANGRILA Source code

const CONTEXT_MAPNAME_SHANGRILA = 20;

CONTEXT_MAPNAME_SINKHOLE Source code

const CONTEXT_MAPNAME_SINKHOLE = 39;

CONTEXT_MAPNAME_STRANDED Source code

const CONTEXT_MAPNAME_STRANDED = 61;

CONTEXT_MAPNAME_STRIDENT Source code

const CONTEXT_MAPNAME_STRIDENT = 5;

CONTEXT_MAPNAME_SUSPENSE Source code

const CONTEXT_MAPNAME_SUSPENSE = 27;

CONTEXT_MAPNAME_SUSPENSE_NECRIS Source code

const CONTEXT_MAPNAME_SUSPENSE_NECRIS = 50;

CONTEXT_MAPNAME_TANK_CROSSING Source code

const CONTEXT_MAPNAME_TANK_CROSSING = 40;

CONTEXT_MAPNAME_TORLAN Source code

const CONTEXT_MAPNAME_TORLAN = 41;

CONTEXT_MAPNAME_TORLANLEVIATHAN Source code

const CONTEXT_MAPNAME_TORLANLEVIATHAN = 42;

CONTEXT_MAPNAME_TORLANNECRIS Source code

const CONTEXT_MAPNAME_TORLANNECRIS = 43;

CONTEXT_MAPNAME_TURBINE Source code

const CONTEXT_MAPNAME_TURBINE = 60;

CONTEXT_MAPNAME_VERTEBRAE Source code

const CONTEXT_MAPNAME_VERTEBRAE = 6;

CONTEXT_NUMBOTS_0 Source code

const CONTEXT_NUMBOTS_0 = 0;

CONTEXT_NUMBOTS_1 Source code

const CONTEXT_NUMBOTS_1 = 1;

CONTEXT_NUMBOTS_2 Source code

const CONTEXT_NUMBOTS_2 = 2;

CONTEXT_NUMBOTS_3 Source code

const CONTEXT_NUMBOTS_3 = 3;

CONTEXT_NUMBOTS_4 Source code

const CONTEXT_NUMBOTS_4 = 4;

CONTEXT_NUMBOTS_5 Source code

const CONTEXT_NUMBOTS_5 = 5;

CONTEXT_NUMBOTS_6 Source code

const CONTEXT_NUMBOTS_6 = 6;

CONTEXT_NUMBOTS_7 Source code

const CONTEXT_NUMBOTS_7 = 7;

CONTEXT_NUMBOTS_8 Source code

const CONTEXT_NUMBOTS_8 = 8;

CONTEXT_PRESENCE_MENUPRESENCE Source code

const CONTEXT_PRESENCE_MENUPRESENCE = 0;

CONTEXT_PURESERVER Source code

const CONTEXT_PURESERVER = 6;

CONTEXT_PURESERVER_ANY Source code

const CONTEXT_PURESERVER_ANY = 2;

CONTEXT_PURESERVER_NO Source code

const CONTEXT_PURESERVER_NO = 0;

CONTEXT_PURESERVER_YES Source code

const CONTEXT_PURESERVER_YES = 1;

CONTEXT_TIMELIMIT_10 Source code

const CONTEXT_TIMELIMIT_10 = 1;

CONTEXT_TIMELIMIT_15 Source code

const CONTEXT_TIMELIMIT_15 = 2;

CONTEXT_TIMELIMIT_20 Source code

const CONTEXT_TIMELIMIT_20 = 3;

CONTEXT_TIMELIMIT_30 Source code

const CONTEXT_TIMELIMIT_30 = 4;

CONTEXT_TIMELIMIT_5 Source code

const CONTEXT_TIMELIMIT_5 = 0;

CONTEXT_VSBOTS Source code

const CONTEXT_VSBOTS = 8;

CONTEXT_VSBOTS_1_TO_1 Source code

const CONTEXT_VSBOTS_1_TO_1 = 2;

CONTEXT_VSBOTS_1_TO_2 Source code

const CONTEXT_VSBOTS_1_TO_2 = 1;

CONTEXT_VSBOTS_2_TO_1 Source code

const CONTEXT_VSBOTS_2_TO_1 = 4;

CONTEXT_VSBOTS_3_TO_1 Source code

const CONTEXT_VSBOTS_3_TO_1 = 5;

CONTEXT_VSBOTS_3_TO_2 Source code

const CONTEXT_VSBOTS_3_TO_2 = 3;

CONTEXT_VSBOTS_4_TO_1 Source code

const CONTEXT_VSBOTS_4_TO_1 = 6;

CONTEXT_VSBOTS_NONE Source code

const CONTEXT_VSBOTS_NONE = 0;

GS_CDKEY_PART_MAXLENGTH Source code

const GS_CDKEY_PART_MAXLENGTH = 4;

GS_EMAIL_MAXLENGTH Source code

const GS_EMAIL_MAXLENGTH = 50;

GS_MESSAGE_MAXLENGTH Source code

const GS_MESSAGE_MAXLENGTH = 255;

GS_PASSWORD_MAXLENGTH Source code

const GS_PASSWORD_MAXLENGTH = 30;

GS_USERNAME_MAXLENGTH Source code

const GS_USERNAME_MAXLENGTH = 15;

PROPERTY_CUSTOMGAMEMODE Source code

const PROPERTY_CUSTOMGAMEMODE = 0x40000002;

PROPERTY_CUSTOMMAPNAME Source code

const PROPERTY_CUSTOMMAPNAME = 0x40000001;

PROPERTY_CUSTOMMUTATORS Source code

const PROPERTY_CUSTOMMUTATORS = 0x40000004;

PROPERTY_CUSTOMMUTCLASSES Source code

const PROPERTY_CUSTOMMUTCLASSES = 0x40000005;

PROPERTY_EPICMUTATORS Source code

const PROPERTY_EPICMUTATORS = 0x10000105;

PROPERTY_GOALSCORE Source code

const PROPERTY_GOALSCORE = 0x100000F8;

PROPERTY_LEADERBOARDRATING Source code

const PROPERTY_LEADERBOARDRATING = 0x20000004;

PROPERTY_NUMBOTS Source code

const PROPERTY_NUMBOTS = 0x100000F7;

PROPERTY_NUMBOTSIA Source code

const PROPERTY_NUMBOTSIA = 0x100000FA;

PROPERTY_SERVERDESCRIPTION Source code

const PROPERTY_SERVERDESCRIPTION = 0x40000003;

PROPERTY_STEAMID Source code

const PROPERTY_STEAMID = 0x10000200;

PROPERTY_STEAMVAC Source code

const PROPERTY_STEAMVAC = 0x10000201;

PROPERTY_TIMELIMIT Source code

const PROPERTY_TIMELIMIT = 0x100000F9;

QUERY_BETRAYAL Source code

const QUERY_BETRAYAL = 8;

QUERY_CAMPAIGN Source code

const QUERY_CAMPAIGN = 6;

QUERY_CTF Source code

const QUERY_CTF = 2;

QUERY_DM Source code

const QUERY_DM = 0;

QUERY_DUEL Source code

const QUERY_DUEL = 5;

QUERY_GREED Source code

const QUERY_GREED = 7;

QUERY_TDM Source code

const QUERY_TDM = 1;

QUERY_VCTF Source code

const QUERY_VCTF = 3;

QUERY_WAR Source code

const QUERY_WAR = 4;

STATS_VIEW_DM_PLAYER_ALLTIME Source code

const STATS_VIEW_DM_PLAYER_ALLTIME = 1;

STATS_VIEW_DM_RANKED_ALLTIME Source code

const STATS_VIEW_DM_RANKED_ALLTIME = 2;

STATS_VIEW_DM_VEHICLES_ALLTIME Source code

const STATS_VIEW_DM_VEHICLES_ALLTIME = 4;

STATS_VIEW_DM_VEHICLES_RANKED_ALLTIME Source code

const STATS_VIEW_DM_VEHICLES_RANKED_ALLTIME = 6;

STATS_VIEW_DM_VEHICLEWEAPONS_ALLTIME Source code

const STATS_VIEW_DM_VEHICLEWEAPONS_ALLTIME = 5;

STATS_VIEW_DM_VEHICLEWEAPONS_RANKED_ALLTIME Source code

const STATS_VIEW_DM_VEHICLEWEAPONS_RANKED_ALLTIME = 7;

STATS_VIEW_DM_WEAPONS_ALLTIME Source code

const STATS_VIEW_DM_WEAPONS_ALLTIME = 3;

STATS_VIEW_DM_WEAPONS_RANKED_ALLTIME Source code

const STATS_VIEW_DM_WEAPONS_RANKED_ALLTIME = 8;

Variables Detail

bHidingScene Source code

var transient bool bHidingScene;

bShowingScene Source code

var transient bool bShowingScene;
Animation flags, used by the tick function to determine which update func to call.

bSkipPendingCloseSceneNotify Source code

var transient bool bSkipPendingCloseSceneNotify;
Whether or not to skip the kismet notify for the close scene that is pending.

InputBoxScene Source code

var transient UIScene InputBoxScene;

MessageBoxScene Source code

var transient UIScene MessageBoxScene;
Global scene references, only scenes that are used in-game and in-menus should be referenced here.

OnlineToastScene Source code

var transient UIScene OnlineToastScene;

PendingCloseScene Source code

var transient UIScene PendingCloseScene;
Pending scene to close since we are waiting for the current scene's exit animation to end.

PendingOpenScene Source code

var transient UIScene PendingOpenScene;
Pending scene to open since we are waiting for the current scene's exit animation to end.

PlayerCardScene Source code

var transient UIScene PlayerCardScene;

Editor

bEditorRealTimePreview Source code

var(Editor) transient bool bEditorRealTimePreview;

Flags

bIgnoreAxisInput Source code

var(Flags) bool bIgnoreAxisInput;

Enumerations Detail

EUTBotTeam Source code

enum EUTBotTeam
{
UTBotTeam_Random, UTBotTeam_Ironguard, UTBotTeam_TwinSouls, UTBotTeam_Krall, UTBotTeam_Liandri, UTBotTeam_Necris
};
Possible factions for the bots.

EUTRecordDemo Source code

enum EUTRecordDemo
{
UTRecordDemo_No, UTRecordDemo_Yes,
};
Demo recording.

Delegates Detail

OnHideAnimationEnded Source code

delegate OnHideAnimationEnded ( )
Callback for when the scene's hide animation has ended.

OnSceneOpened Source code

delegate OnSceneOpened ( UIScene OpenedScene, bool bInitialActivation )
Callback for when a scene has opened after hiding the topmost scene.

OnShowAnimationEnded Source code

delegate OnShowAnimationEnded ( )
Callback for when the scene's show animation has ended.

Functions Detail

ActivateLevelEvent Source code

native function ActivateLevelEvent ( name EventName )
Activates a level remote event in kismet.

AnimEnd Source code

function AnimEnd ( UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq) )
Called when an animation on this scene has finished.

BeginHideAnimation Source code

function bool BeginHideAnimation ( bool bClosingScene=false) )
Starts the exit animation for the scene.
@return TRUE if there's animation for this scene, FALSE otherwise.

BeginShowAnimation Source code

function bool BeginShowAnimation ( bool bInitialActivation=true, bool bBypassAnimation=false) )
Starts the show animation for the scene.
@param bInitialActivation TRUE if the scene is being opened; FALSE if the another scene was closed causing this one to become the topmost scene.
@param bBypassAnimation TRUE to force all animations to their last frame, effectively bypassing animations. This can be necessary for e.g. scenes which start out off-screen or something.
@return TRUE if there's animation for this scene, FALSE otherwise.

CheckCommunicationPrivilegeAndError Source code

function bool CheckCommunicationPrivilegeAndError ( int ControllerId=INDEX_NONE, optional string AlternateTitle, optional string AlternateMessage ) )

@return Checks to see if the specified player can play online games, if not an error message is shown and FALSE is returned.

CheckContentPrivilegeAndError Source code

function bool CheckContentPrivilegeAndError ( int ControllerId=INDEX_NONE, optional string AlternateTitle, optional string AlternateMessage ) )

@return Checks to see if the specified player can play online games, if not an error message is shown and FALSE is returned.

CheckForAutoLogin Source code

native static function bool CheckForAutoLogin ( out string Username, out string Password )
returns true if a username/password was specified on the command line and an auto login is in progress

CheckLinkConnectionAndError Source code

function bool CheckLinkConnectionAndError ( optional string AlternateTitle, optional string AlternateMessage ) )

@return Checks to see if the platform is currently connected to a network.

CheckLoginAndError Source code

function bool CheckLoginAndError ( int ControllerId=INDEX_NONE, optional bool bMustBeLoggedInOnline=false, optional string AlternateTitle, optional string AlternateMessage) )

@return Checks to see if the specified player is logged in, if not an error message is shown and FALSE is returned.

CheckNatTypeAndDisplayError Source code

function bool CheckNatTypeAndDisplayError ( int ControllerId=GetBestControllerId(), optional string AlternateTitle, optional string AlternateMessage ) )
Verifies that the player's NAT configuration allows them to host matches, and displays an error message if not.

CheckOnlinePrivilegeAndError Source code

function bool CheckOnlinePrivilegeAndError ( int ControllerId=INDEX_NONE, optional string AlternateTitle, optional string AlternateMessage ) )

@return Checks to see if the specified player can play online games, if not an error message is shown and FALSE is returned.

CloseScene Source code

function bool CloseScene ( UIScene SceneToClose, bool bSkipKismetNotify=false, bool bSkipAnimation=false) )
Closes a UI Scene given a reference to an previously open scene.
@param SceneToClose Scene that we want to close.
@param bSkipKismetNotify Whether or not to close the kismet notify for the scene.
@param bSkipAnimation Whether or not to skip the close animation for this scene.

ConditionallyCheckNumControllers Source code

function bool ConditionallyCheckNumControllers ( ) )

@return Checks for 2 controllers plugged in and displays a message if the user cannot play splitscreen, returns TRUE if the game can begin, returns FALSE otherwise.

ConditionallyStartSplitscreen Source code

function ConditionallyStartSplitscreen ( ) )
Checks to see if we should be playing splitscreen or not, if so, creates a 2nd local player.

ConsoleCommand Source code

final function ConsoleCommand ( string Cmd, optional bool bWriteToLog) )
Executes a console command.
@param string Cmd Command to execute.

DeleteDemo Source code

native function DeleteDemo ( string DemoName )

DisplayMessageBox Source code

function UTUIScene_MessageBox DisplayMessageBox ( string Message, optional string Title="") )
Displays a very simple OK message box with the specified message and title.
@param Message Message markup for the messagebox
@param Title Title markup for the messagebox
@return Returns a reference to the message box scene that was displayed.

FindDataStore Source code

static function UIDataStore FindDataStore ( name DataStoreTag, optional LocalPlayer InPlayerOwner) )

@return Returns a datastore given its tag and player owner.

FinishCloseScene Source code

function FinishCloseScene ( UIScene SceneToClose, bool bSkipAnimations=false, bool bSkipKismetNotify=false) )
Closes a UI Scene given a reference to an previously open scene.
@param SceneToClose Scene that we want to close.

FinishOpenScene Source code

function UIScene FinishOpenScene ( UIScene SceneToOpen, bool bSkipAnimation=false, bool bSkipKismetNotify=false) )
Finishes opening a scene, usually called when a hide animation has ended.
@param SceneToOpen the scene to open
@param bSkipAnimation specify TRUE to bypass the scene's opening animation
@param bSkipKismetNotify specify TRUE to prevent the 'OpeningMenu' level event from being activated.
@return reference to the UIScene instance that was opened.

GenerateDemoFileName Source code

function string GenerateDemoFileName ( ) )

@return Returns Returns a unique demo filename.

GetAccountInterface Source code

static function OnlineAccountInterface GetAccountInterface ( ) )

@return Returns a reference to the online subsystem player interface.

GetBotTeamNameFromIndex Source code

function name GetBotTeamNameFromIndex ( EUTBotTeam TeamIndex) )

@return string Returns a bot faction name given its enum.

GetCommonOptionsURL Source code

function string GetCommonOptionsURL ( ) )

@return Generates a set of URL options common to both instant action and host game.

GetCurrentAudioDevice Source code

native function string GetCurrentAudioDevice ( )

@return Returns the currently selected audio device.

GetGameInterface Source code

static function OnlineGameInterface GetGameInterface ( ) )

@return Returns a reference to the online subsystem game interface.

GetInputBoxScene Source code

function UTUIScene_InputBox GetInputBoxScene ( ) )

@return Opens the input box scene and returns a reference to it.

GetMessageBoxScene Source code

function UTUIScene_MessageBox GetMessageBoxScene ( optional UIScene SceneReference = None) )

@return Opens the message box scene and returns a reference to it.

GetPawnOwner Source code

native function Pawn GetPawnOwner ( )
Returns the Pawn associated with this Hud

GetPlayerControllerId Source code

function int GetPlayerControllerId ( int PlayerIndex) )

@return Returns the controller id of a player given its player index.

GetPlayerIndex Source code

function int GetPlayerIndex ( ) )

@return Returns the player index of the player owner for this scene.

GetPlayerInterface Source code

static function OnlinePlayerInterface GetPlayerInterface ( ) )

@return Returns a reference to the online subsystem player interface.

GetPlayerInterfaceEx Source code

static function OnlinePlayerInterfaceEx GetPlayerInterfaceEx ( ) )

@return Returns a reference to the online subsystem player interface ex.

GetPlayerName Source code

function string GetPlayerName ( int PlayerIndex=INDEX_NONE) )

@return Returns the name of the specified player if they have an alias or are logged in, or "DefaultPlayer" otherwise.

GetPlayerProfile Source code

function UTProfileSettings GetPlayerProfile ( optional int PlayerIndex=GetBestPlayerIndex() ) )
Returns the Player Profile for a given player index.
@param PlayerIndex The player who's profile you require
@returns the profile precast to UTProfileSettings

GetPlayerProfileFromPC Source code

function UTProfileSettings GetPlayerProfileFromPC ( PlayerController PC ) )
Returns the Player Profile for a given player index.
@param PC The PlayerContorller of the profile you require.
@returns the profile precast to UTProfileSettings

GetPossibleAudioDevices Source code

native function GetPossibleAudioDevices ( out array<string> OutResults )
Retrieves all of the possible audio devices from the audio driver.

GetPossibleScreenResolutions Source code

native function GetPossibleScreenResolutions ( out array<string> OutResults )
Retrieves all of the possible screen resolutions from the display driver.

GetPRIOwner Source code

native function UTPlayerReplicationInfo GetPRIOwner ( )
Returns the PRI associated with this hud

GetUTInteraction Source code

function UTGameInteraction GetUTInteraction ( ) )

@return Return a reference to the UT specific version of the UI interaction.

GetUTPlayerOwner Source code

native function UTPlayerController GetUTPlayerOwner ( optional int PlayerIndex=-1 )
Get the UTPlayerController that is associated with this Hud

GetWorldInfo Source code

native function WorldInfo GetWorldInfo ( )
Returns the WorldInfo

HideOnlineToast Source code

static function HideOnlineToast ( ) )
Hides the toast message.

IsBelowMinSpecs Source code

native final const function bool IsBelowMinSpecs ( ) con )

@return TRUE if the user's machine is below the minimum required specs to play the game.

IsControllerInput Source code

event bool IsControllerInput ( name KeyName) )
Returns whether or not the input passed in is a gamepad input event.
@param KeyName Key name to check
@return Returns TRUE if the input key is from a gamepad, FALSE otherwise.

IsGame Source code

native function bool IsGame ( )
@Returns the contents of GIsGame

NotifyChildGameSessionEnded Source code

function NotifyChildGameSessionEnded ( UIObject Child) )

NotifyGameSessionEnded Source code

function NotifyGameSessionEnded ( ) )

OnAnimationFinished Source code

event OnAnimationFinished ( UIObject AnimTarget, name AnimName, name SeqName )

OnCurrentScene_HideAnimationEnded Source code

function OnCurrentScene_HideAnimationEnded ( ) )
Callback for when the current scene's hide animation has completed.

OnLoginError_Confirm Source code

function OnLoginError_Confirm ( UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex )
Callback for when the login required box has finished displaying.

OnLoginUI_LoginChange Source code

function OnLoginUI_LoginChange ( ) )
Callback for when the login changes after showing the login UI.

OnLoginUI_LoginFailed Source code

function OnLoginUI_LoginFailed ( byte LocalUserNum,EOnlineServerConnectionStatus ErrorCode) )
Delegate used in notifying the UI/game that the manual login failed after showing the login UI.
@param LocalUserNum the controller number of the associated user
@param ErrorCode the async error code that occurred

OnPendingCloseScene_HideAnimationEnded Source code

function OnPendingCloseScene_HideAnimationEnded ( ) )
Callback for when the scene we are closing's hide animation has completed.

OpenCmdLineURL Source code

native static function bool OpenCmdLineURL ( )
Launch the URL specified on the command line

OpenScene Source code

function UIScene OpenScene ( UIScene SceneToOpen, optional bool bSkipAnimation=false, optional delegate<OnSceneActivated> SceneDelegate=None) )
Opens a UI Scene given a reference to a scene to open.
@param SceneToOpen Scene that we want to open.
@param bSkipAnimation specify TRUE to indicate that opening animations should be bypassed.
@param SceneDelegate if specified, will be called when the scene has finished opening.

OpenSceneByName Source code

function UIScene OpenSceneByName ( string SceneToOpen, bool bSkipAnimation=false, optional delegate<OnSceneActivated> SceneDelegate=None) )
Opens a UI Scene given a reference to a scene to open.
@param SceneToOpen Scene that we want to open.

PlaySound Source code

function PlaySound ( SoundCue InSoundCue, optional bool bIsUISound) )
Allows easy access to playing a sound @Param InSoundCue The Cue to play @Param SoundLocation Where in the world to play it. Defaults at the Player's position

SavePlayerProfile Source code

function SavePlayerProfile ( optional int PlayerIndex=GetBestPlayerIndex()) )
Saves the profile for the specified player index.
@param PlayerIndex The player index of the player to save the profile for.

SetAudioDeviceToUse Source code

native function SetAudioDeviceToUse ( string InAudioDevice )
Sets the audio device to use for playback.
@param InAudioDevice Audio device to use.

SetLanPlay Source code

native static final function SetLanPlay ( bool bValue )
Sets the value of GIsLanPlay, which controls LAN server bandwidth optimizations; True means faster downloads, but higher bandwidth usage

SetScreenResolution Source code

native function SetScreenResolution ( int ResX, int ResY, bool bFullscreen )
Sets the screen resolution.
@param ResX Width of the screen
@param ResY Height of the screen
@param bFullscreen Whether or not we are fullscreen.

SetupButtonBar Source code

function SetupButtonBar ( )
Function that sets up a buttonbar for this scene, automatically routes the call to the currently selected tab of the scene as well.

ShowLoginUI Source code

function ShowLoginUI ( optional bool bOnlineOnly=false) )
Displays the login interface using the online subsystem.

ShowOnlineToast Source code

static function ShowOnlineToast ( string InMessage, optional float ToastTime=3.0f, optional int Priority=0) )
Shows a toast message.

ShowPlayerCard Source code

function UTUIScene_PlayerCard ShowPlayerCard ( UniqueNetId InPlayerId, optional string InPlayerName, optional string InAccountName, optional bool bIncludeKickOption, optional bool bIncludeBanOption) )
Shows the player card for the player with the net ID specified.

StartDedicatedServer Source code

native function StartDedicatedServer ( string TravelURL )
Starts a dedicated server and kills the current process.

StaticOpenScene Source code

static function UIScene StaticOpenScene ( UIScene SceneToOpen) )
Opens a scene without any special hiding animation for previous scenes.

TrimWhitespace Source code

static function string TrimWhitespace ( string InString) )
Trims whitespace from the beginning and end of a string.

TryCharacterUnlock Source code

native function bool TryCharacterUnlock ( string UnlockCode )
Tries to unlock a character using a code.
@param UnlockCode Code to use to unlock the character.
@return TRUE if the unlock succeeded, FALSE otherwise.

UpdateSplitscreenPlayers Source code

native function UpdateSplitscreenPlayers ( bool bCreatePlayers )
Creates/Removes local players for splitscreen.
@param bCreatePlayers Whether we are creating or removing players.

ViewportDeProject Source code

native function ViewportDeProject ( LocalPlayer LocalPlayerOwner, vector ScreenLocation, out vector OutLocation, out vector OutDirection )
Converts a 2D Screen coordiate in to 3D space @Param LocalPlayerOwner The LocalPlayer that owns the viewport where the projection occurs @Param ScreenLocation Where on the screen are we converting from @Param OutLocation Returns the Location in world space @Param OutDirection Returns the view direction

ViewportProject Source code

native function ViewportProject ( LocalPlayer LocalPlayerOwner, vector WorldLocation, out vector OutScreenLocation )
Converts a 2D Screen coordiate in to 3D space @Param LocalPlayerOwner The LocalPlayer that owns the viewport where the projection occurs @Param WorldLocation The world location to project to @Param OutScreenLocation Returns the location in 2D space

Defaultproperties 

defaultproperties
{
   DefaultContextMenuClass=Class'UTGame.UTUI_ContextMenu'
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'Engine.Default__UIScene:SceneEventComponent'
      ObjectArchetype=UIComp_Event'Engine.Default__UIScene:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UTUIScene"
   ObjectArchetype=UIScene'Engine.Default__UIScene'
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:59.208 - Created with UnCodeX