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

UTGame.UTUIFrontEnd_CharacterCustomization

Extends
UTUIFrontEnd
Modifiers
native ( UIFrontEnd ) dependson ( UTCustomChar_Preview )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Character customization screen for UT3

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

Constants Summary
CHARACTERCUSTOMIZATION_BUTTONBAR_ACCEPT=0
CHARACTERCUSTOMIZATION_BUTTONBAR_BACK=1
Inherited Contants from UTGame.UTUIScene
CONTEXT_ALLOWKEYBOARD, CONTEXT_ALLOWKEYBOARD_ANY, CONTEXT_ALLOWKEYBOARD_NO, CONTEXT_ALLOWKEYBOARD_YES, CONTEXT_BOTSKILL, CONTEXT_BOTSKILL_ADEPT, CONTEXT_BOTSKILL_AUTOADJUSTSKILL, CONTEXT_BOTSKILL_AVERAGE, CONTEXT_BOTSKILL_EXPERIENCED, CONTEXT_BOTSKILL_GODLIKE, CONTEXT_BOTSKILL_INHUMAN, CONTEXT_BOTSKILL_MASTERFUL, CONTEXT_BOTSKILL_NOVICE, CONTEXT_BOTSKILL_SKILLED, CONTEXT_CAMPAIGN, CONTEXT_CAMPAIGN_NO, CONTEXT_CAMPAIGN_YES, CONTEXT_DEDICATEDSERVER, CONTEXT_DEDICATEDSERVER_NO, CONTEXT_DEDICATEDSERVER_YES, CONTEXT_EMPTYSERVER, CONTEXT_EMPTYSERVER_NO, CONTEXT_EMPTYSERVER_YES, CONTEXT_FORCERESPAWN, CONTEXT_FORCERESPAWN_NO, CONTEXT_FORCERESPAWN_YES, CONTEXT_FULLSERVER, CONTEXT_FULLSERVER_NO, CONTEXT_FULLSERVER_YES, CONTEXT_GAME_MODE, CONTEXT_GAME_MODE_BETRAYAL, CONTEXT_GAME_MODE_CAMPAIGN, CONTEXT_GAME_MODE_CTF, CONTEXT_GAME_MODE_CUSTOM, CONTEXT_GAME_MODE_DM, CONTEXT_GAME_MODE_DUEL, CONTEXT_GAME_MODE_GREED, CONTEXT_GAME_MODE_TDM, CONTEXT_GAME_MODE_VCTF, CONTEXT_GAME_MODE_WAR, CONTEXT_GOALSCORE_10, CONTEXT_GOALSCORE_15, CONTEXT_GOALSCORE_20, CONTEXT_GOALSCORE_30, CONTEXT_GOALSCORE_5, CONTEXT_LOCKEDSERVER, CONTEXT_LOCKEDSERVER_NO, CONTEXT_LOCKEDSERVER_YES, CONTEXT_MAPNAME, CONTEXT_MAPNAME_ARSENAL, CONTEXT_MAPNAME_AVALANCHE, CONTEXT_MAPNAME_BIOHAZARD, CONTEXT_MAPNAME_CARBON_FIRE, CONTEXT_MAPNAME_COLDHARBOR, CONTEXT_MAPNAME_CONFRONTATION, CONTEXT_MAPNAME_CONTAINMENT, CONTEXT_MAPNAME_CONTAINMENTSP, CONTEXT_MAPNAME_CORET, CONTEXT_MAPNAME_CORRUPTION, CONTEXT_MAPNAME_CUSTOM, CONTEXT_MAPNAME_DARKMATCH, CONTEXT_MAPNAME_DECK, CONTEXT_MAPNAME_DEFIANCE, CONTEXT_MAPNAME_DEIMOS, CONTEXT_MAPNAME_DIESEL, CONTEXT_MAPNAME_DOWNTOWN, CONTEXT_MAPNAME_DOWNTOWNNECRIS, CONTEXT_MAPNAME_DUSK, CONTEXT_MAPNAME_EDENINC, CONTEXT_MAPNAME_FACINGWORLDS, CONTEXT_MAPNAME_FEARLESS, CONTEXT_MAPNAME_FLOODGATE, CONTEXT_MAPNAME_GATEWAY, CONTEXT_MAPNAME_HEAT_RAY, CONTEXT_MAPNAME_HOSTILE, CONTEXT_MAPNAME_HYDROSIS, CONTEXT_MAPNAME_ISLANDER, CONTEXT_MAPNAME_ISLANDERNECRIS, CONTEXT_MAPNAME_KARGO, CONTEXT_MAPNAME_KBARGE, CONTEXT_MAPNAME_LOSTCAUSE, CONTEXT_MAPNAME_MARKET_DISTRICT, CONTEXT_MAPNAME_MISSION_SELECTION, CONTEXT_MAPNAME_MORBIAS, CONTEXT_MAPNAME_MORBID, CONTEXT_MAPNAME_NANOBLACK, CONTEXT_MAPNAME_NECROPOLIS, CONTEXT_MAPNAME_OCEANRELIC, CONTEXT_MAPNAME_OMICRON_DAWN, CONTEXT_MAPNAME_ONYX_COAST, CONTEXT_MAPNAME_POWER_SURGE, CONTEXT_MAPNAME_RAILS, CONTEXT_MAPNAME_REFLECTION, CONTEXT_MAPNAME_RISING_SUN, CONTEXT_MAPNAME_SANCTUARY, CONTEXT_MAPNAME_SANDSTORM, CONTEXT_MAPNAME_SEARCHLIGHT, CONTEXT_MAPNAME_SENTINEL, CONTEXT_MAPNAME_SERENITY, CONTEXT_MAPNAME_SERENITYNECRIS, CONTEXT_MAPNAME_SHAFT, CONTEXT_MAPNAME_SHANGRILA, CONTEXT_MAPNAME_SINKHOLE, CONTEXT_MAPNAME_STRANDED, CONTEXT_MAPNAME_STRIDENT, CONTEXT_MAPNAME_SUSPENSE, CONTEXT_MAPNAME_SUSPENSE_NECRIS, CONTEXT_MAPNAME_TANK_CROSSING, CONTEXT_MAPNAME_TORLAN, CONTEXT_MAPNAME_TORLANLEVIATHAN, CONTEXT_MAPNAME_TORLANNECRIS, CONTEXT_MAPNAME_TURBINE, CONTEXT_MAPNAME_VERTEBRAE, CONTEXT_NUMBOTS_0, CONTEXT_NUMBOTS_1, CONTEXT_NUMBOTS_2, CONTEXT_NUMBOTS_3, CONTEXT_NUMBOTS_4, CONTEXT_NUMBOTS_5, CONTEXT_NUMBOTS_6, CONTEXT_NUMBOTS_7, CONTEXT_NUMBOTS_8, CONTEXT_PRESENCE_MENUPRESENCE, CONTEXT_PURESERVER, CONTEXT_PURESERVER_ANY, CONTEXT_PURESERVER_NO, CONTEXT_PURESERVER_YES, CONTEXT_TIMELIMIT_10, CONTEXT_TIMELIMIT_15, CONTEXT_TIMELIMIT_20, CONTEXT_TIMELIMIT_30, CONTEXT_TIMELIMIT_5, CONTEXT_VSBOTS, CONTEXT_VSBOTS_1_TO_1, CONTEXT_VSBOTS_1_TO_2, CONTEXT_VSBOTS_2_TO_1, CONTEXT_VSBOTS_3_TO_1, CONTEXT_VSBOTS_3_TO_2, CONTEXT_VSBOTS_4_TO_1, CONTEXT_VSBOTS_NONE, GS_CDKEY_PART_MAXLENGTH, GS_EMAIL_MAXLENGTH, GS_MESSAGE_MAXLENGTH, GS_PASSWORD_MAXLENGTH, GS_USERNAME_MAXLENGTH, PROPERTY_CUSTOMGAMEMODE, PROPERTY_CUSTOMMAPNAME, PROPERTY_CUSTOMMUTATORS, PROPERTY_CUSTOMMUTCLASSES, PROPERTY_EPICMUTATORS, PROPERTY_GOALSCORE, PROPERTY_LEADERBOARDRATING, PROPERTY_NUMBOTS, PROPERTY_NUMBOTSIA, PROPERTY_SERVERDESCRIPTION, PROPERTY_STEAMID, PROPERTY_STEAMVAC, PROPERTY_TIMELIMIT, QUERY_BETRAYAL, QUERY_CAMPAIGN, QUERY_CTF, QUERY_DM, QUERY_DUEL, QUERY_GREED, QUERY_TDM, QUERY_VCTF, QUERY_WAR, STATS_VIEW_DM_PLAYER_ALLTIME, STATS_VIEW_DM_RANKED_ALLTIME, STATS_VIEW_DM_VEHICLES_ALLTIME, STATS_VIEW_DM_VEHICLES_RANKED_ALLTIME, STATS_VIEW_DM_VEHICLEWEAPONS_ALLTIME, STATS_VIEW_DM_VEHICLEWEAPONS_RANKED_ALLTIME, STATS_VIEW_DM_WEAPONS_ALLTIME, STATS_VIEW_DM_WEAPONS_RANKED_ALLTIME

Variables Summary
boolbHaveLoadedCharData
boolbRotateLeftDown
boolbRotateRightDown
CharacterInfoCharacter
stringCharacterID
UIObjectCharacterPanel
CameraActorCurrentCameraActor
floatCurrentRotation
UTUICharacterCustomizationListCustomizationList
stringFaction
CustomCharDataLoadedCharData
UTCharFamilyAssetStoreLoadedPackage
UIObjectLoadingPanel
vectorOriginalCameraLocation
rotatorOriginalCameraRotation
array<UIImage>PartImages
UTCharFamilyAssetStorePendingPackage
UTCustomChar_PreviewPreviewActor
UTUIPressButtonRotateLeftButton
UTUIPressButtonRotateRightButton
UTUIFrontEnd_CharacterCustomization
floatCameraRotationSpeed
Inherited Variables from UTGame.UTUIFrontEnd
bCancellingInstallPS3, bInstallingPS3, ButtonBar, CurrentPageIndex, ImportingMessageBoxReference, ImportState, LastURL, PreviousPageIndex, TabControl, TitleMarkupString, VersionFont, VersionPos, VersionText
Inherited Variables from UTGame.UTUIScene
bEditorRealTimePreview, bHidingScene, bIgnoreAxisInput, bShowingScene, bSkipPendingCloseSceneNotify, InputBoxScene, MessageBoxScene, OnlineToastScene, PendingCloseScene, PendingOpenScene, PlayerCardScene

Enumerations Summary
Inherited Enumerations from UTGame.UTUIFrontEnd
EModImport
Inherited Enumerations from UTGame.UTUIScene
EUTBotTeam, EUTRecordDemo

Functions Summary
function ActivateLevelEventForCurrentPart ()))
function FindPreviewActor ()))
functionbool HandleInputKey (const out InputEventParameters EventParms ))
function LoadCharacterData ()))
function OnAccept ()))
function OnBack ()))
functionbool OnButtonBar_Accept (UIScreenObject InButton, int InPlayerIndex))
functionbool OnButtonBar_Back (UIScreenObject InButton, int InPlayerIndex))
functionbool OnButtonBar_ToggleShoulderType (UIScreenObject InButton, int InPlayerIndex))
function OnCustomizationList_SelectionChange (UTSimpleList InObject, int InNewIndex))
function OnPartSelected (ECharPart PartType, string PartID ))
function OnPreviewPartChanged (ECharPart PartType, string PartID ))
function OnRotateLeftButton_BeginPress (UIScreenObject InObject, INT InPlayerIndex))
function OnRotateLeftButton_EndPress (UIScreenObject InObject, INT InPlayerIndex))
function OnRotateRightButton_BeginPress (UIScreenObject InObject, INT InPlayerIndex))
function OnRotateRightButton_EndPress (UIScreenObject InObject, INT InPlayerIndex))
function OnSaveProfileCompleted ()))
function OnToggleShoulderType ()))
event PostInitialize ()))
function RestoreWorldSettings ()))
function SaveCharacterData ()))
function SetupButtonBar ()))
function StartLoadingPackage (string FamilyID))
event UpdateLoadingPackage ()))
function UpdatePaperDoll ()))
Inherited Functions from UTGame.UTUIFrontEnd
BeginHideAnimation, BeginImportMod, BeginInstallPS3, BeginShowAnimation, CancelInstallPS3, CheckForFrontEndError, ChildSceneOpened, GetTitleLabel, HandleInputKey, ImportMod, InstallPS3, OnCancelInstallPS3, OnCancelMessageClosed, OnImportModFinished, OnInstallMessageClosed, OnLoginError_Confirm, OnMainRegion_Show_UIAnimEnd, OnPageActivated, OnRetryPasswordDialog_Closed, OnTabPage_Hide_UIAnimEnd, OnTabPage_Show_UIAnimEnd, PostInitialize, PromptForPassword, SavePassword, SceneActivated, SetTitle, SetupButtonBar, UpdateModState, UpdatePS3InstallState
Inherited Functions from UTGame.UTUIScene
ActivateLevelEvent, AnimEnd, BeginHideAnimation, BeginShowAnimation, CheckCommunicationPrivilegeAndError, CheckContentPrivilegeAndError, CheckForAutoLogin, CheckLinkConnectionAndError, CheckLoginAndError, CheckNatTypeAndDisplayError, CheckOnlinePrivilegeAndError, CloseScene, ConditionallyCheckNumControllers, ConditionallyStartSplitscreen, ConsoleCommand, DeleteDemo, DisplayMessageBox, FindDataStore, FinishCloseScene, FinishOpenScene, GenerateDemoFileName, GetAccountInterface, GetBotTeamNameFromIndex, GetCommonOptionsURL, GetCurrentAudioDevice, GetGameInterface, GetInputBoxScene, GetMessageBoxScene, GetPawnOwner, GetPlayerControllerId, GetPlayerIndex, GetPlayerInterface, GetPlayerInterfaceEx, GetPlayerName, GetPlayerProfile, GetPlayerProfileFromPC, GetPossibleAudioDevices, GetPossibleScreenResolutions, GetPRIOwner, GetUTInteraction, GetUTPlayerOwner, GetWorldInfo, HideOnlineToast, IsBelowMinSpecs, IsControllerInput, IsGame, NotifyChildGameSessionEnded, NotifyGameSessionEnded, OnAnimationFinished, OnCurrentScene_HideAnimationEnded, OnLoginError_Confirm, OnLoginUI_LoginChange, OnLoginUI_LoginFailed, OnPendingCloseScene_HideAnimationEnded, OpenCmdLineURL, OpenScene, OpenSceneByName, PlaySound, SavePlayerProfile, SetAudioDeviceToUse, SetLanPlay, SetScreenResolution, SetupButtonBar, ShowLoginUI, ShowOnlineToast, ShowPlayerCard, StartDedicatedServer, StaticOpenScene, TrimWhitespace, TryCharacterUnlock, UpdateSplitscreenPlayers, ViewportDeProject, ViewportProject


Constants Detail

CHARACTERCUSTOMIZATION_BUTTONBAR_ACCEPT Source code

const CHARACTERCUSTOMIZATION_BUTTONBAR_ACCEPT = 0;

CHARACTERCUSTOMIZATION_BUTTONBAR_BACK Source code

const CHARACTERCUSTOMIZATION_BUTTONBAR_BACK = 1;


Variables Detail

bHaveLoadedCharData Source code

var transient bool bHaveLoadedCharData;
Whether or not we loaded character data.

bRotateLeftDown Source code

var transient bool bRotateLeftDown;
Rotation button flags.

bRotateRightDown Source code

var transient bool bRotateRightDown;

Character Source code

var transient CharacterInfo Character;
The current character we are viewing.

CharacterID Source code

var transient string CharacterID;
The name of the current character we are viewing.

CharacterPanel Source code

var transient UIObject CharacterPanel;
Panel that contains widgets to show when a character is finished loading.

CurrentCameraActor Source code

var transient CameraActor CurrentCameraActor;
Reference to the current camera actor.

CurrentRotation Source code

var transient float CurrentRotation;
Current rotation delta of the camera actor.

CustomizationList Source code

var transient UTUICharacterCustomizationList CustomizationList;
Reference to the character customization list.

Faction Source code

var transient string Faction;
The current faction we are viewing.

LoadedCharData Source code

var transient CustomCharData LoadedCharData;
Loaded character data.

LoadedPackage Source code

var transient UTCharFamilyAssetStore LoadedPackage;
Data structure that contains information about the character package that is already loaded.

LoadingPanel Source code

var transient UIObject LoadingPanel;
Panel that contains a bunch of widgets to show when loading a character package.

OriginalCameraLocation Source code

var transient vector OriginalCameraLocation;
Original location of the camera actor.

OriginalCameraRotation Source code

var transient rotator OriginalCameraRotation;
Original rotation of the camera actor.

PartImages Source code

var transient array<UIImage> PartImages;
List of paper doll images.

PendingPackage Source code

var transient UTCharFamilyAssetStore PendingPackage;
Data structure that contains information about the character package that is being loaded.

PreviewActor Source code

var transient UTCustomChar_Preview PreviewActor;
Reference to the actor that we are previewing part changes on.

RotateLeftButton Source code

var transient UTUIPressButton RotateLeftButton;
Button to rotate the character left.

RotateRightButton Source code

var transient UTUIPressButton RotateRightButton;
Button to rotate the character right.

UTUIFrontEnd_CharacterCustomization

CameraRotationSpeed Source code

var(UTUIFrontEnd_CharacterCustomization) float CameraRotationSpeed;
How fast to rotate the camera when the user clicks on it in degrees per second.


Functions Detail

ActivateLevelEventForCurrentPart Source code

function ActivateLevelEventForCurrentPart ( ) )
Activates the level kismet remote event for the currently selected part.

FindPreviewActor Source code

function FindPreviewActor ( ) )
Find the preview actor.

HandleInputKey Source code

function bool HandleInputKey ( const out InputEventParameters EventParms ) )
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.
@param EventParms information about the input event.
@return TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

LoadCharacterData Source code

function LoadCharacterData ( ) )
Loads the character data from the datastore.

OnAccept Source code

function OnAccept ( ) )
Callback for when the player has accepted the changes to their character.

OnBack Source code

function OnBack ( ) )
Callback for when the user is trying to back out of the character customization menu.

OnButtonBar_Accept Source code

function bool OnButtonBar_Accept ( UIScreenObject InButton, int InPlayerIndex) )
Button bar callbacks - Accept Button

OnButtonBar_Back Source code

function bool OnButtonBar_Back ( UIScreenObject InButton, int InPlayerIndex) )
Button bar callbacks - Back Button

OnButtonBar_ToggleShoulderType Source code

function bool OnButtonBar_ToggleShoulderType ( UIScreenObject InButton, int InPlayerIndex) )
Button bar callbacks - Toggle shoulder type Button

OnCustomizationList_SelectionChange Source code

function OnCustomizationList_SelectionChange ( UTSimpleList InObject, int InNewIndex) )
Delegate for when the customization list's index changes.

OnPartSelected Source code

function OnPartSelected ( ECharPart PartType, string PartID ) )
Called when the accepts a current list selection.
@param PartType The type of part we are changing.
@param string The id of the part we are changing.

OnPreviewPartChanged Source code

function OnPreviewPartChanged ( ECharPart PartType, string PartID ) )
Called when the user changes the selected index of a parts list.
@param PartType The type of part we are changing.
@param string The id of the part we are changing.

OnRotateLeftButton_BeginPress Source code

function OnRotateLeftButton_BeginPress ( UIScreenObject InObject, INT InPlayerIndex) )
Press button callbacks.

OnRotateLeftButton_EndPress Source code

function OnRotateLeftButton_EndPress ( UIScreenObject InObject, INT InPlayerIndex) )

OnRotateRightButton_BeginPress Source code

function OnRotateRightButton_BeginPress ( UIScreenObject InObject, INT InPlayerIndex) )

OnRotateRightButton_EndPress Source code

function OnRotateRightButton_EndPress ( UIScreenObject InObject, INT InPlayerIndex) )

OnSaveProfileCompleted Source code

function OnSaveProfileCompleted ( ) )
Callback for when the profile save has completed.

OnToggleShoulderType Source code

function OnToggleShoulderType ( ) )
Callback for when the user is trying to toggle the shoulder type of the character.

PostInitialize Source code

event PostInitialize ( ) )
PostInitialize event - Sets delegates for the scene.

RestoreWorldSettings Source code

function RestoreWorldSettings ( ) )
Reset the world settings.

SaveCharacterData Source code

function SaveCharacterData ( ) )
Saves the character data to the datastore.

SetupButtonBar Source code

function SetupButtonBar ( ) )
Sets up the buttonbar for this scene.

StartLoadingPackage Source code

function StartLoadingPackage ( string FamilyID) )
Starts loading a asset package.

UpdateLoadingPackage Source code

event UpdateLoadingPackage ( ) )
Checks the status of the package that is currently loading.

UpdatePaperDoll Source code

function UpdatePaperDoll ( ) )
Updates the paper doll part visibility using the current/previous part panels.


Defaultproperties

defaultproperties
{
   CameraRotationSpeed=72.000000
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIFrontEnd:SceneEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIFrontEnd:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UTUIFrontEnd_CharacterCustomization"
   ObjectArchetype=UTUIFrontEnd'UTGame.Default__UTUIFrontEnd'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:58.664 - Created with UnCodeX