Mostly Harmless

UE3:UTUIFrontEnd_CharacterCustomization (UT3)

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

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

Character customization screen for UT3

Constants

CHARACTERCUSTOMIZATION_BUTTONBAR_ACCEPT

Value: 0


CHARACTERCUSTOMIZATION_BUTTONBAR_BACK

Value: 1


Properties

Property group 'UTUIFrontEnd_CharacterCustomization'

CameraRotationSpeed

Type: float

How fast to rotate the camera when the user clicks on it in degrees per second.

Default value: 72.0

Internal variables

bHaveLoadedCharData

Type: bool

Modifiers: transient

Whether or not we loaded character data.

bRotateLeftDown

Type: bool

Modifiers: transient

Rotation button flags.

bRotateRightDown

Type: bool

Modifiers: transient


Character

Type: UTCustomChar_Data.CharacterInfo

Modifiers: transient

The current character we are viewing.

CharacterID

Type: string

Modifiers: transient

The name of the current character we are viewing.

CharacterPanel

Type: UIObject

Modifiers: transient

Panel that contains widgets to show when a character is finished loading.

CurrentCameraActor

Type: CameraActor

Modifiers: transient

Reference to the current camera actor.

CurrentRotation

Type: float

Modifiers: transient

Current rotation delta of the camera actor.

CustomizationList

Type: UTUICharacterCustomizationList

Modifiers: transient

Reference to the character customization list.

Faction

Type: string

Modifiers: transient

The current faction we are viewing.

LoadedCharData

Type: UTCustomChar_Data.CustomCharData

Modifiers: transient

Loaded character data.

LoadedPackage

Type: UTCharFamilyAssetStore

Modifiers: transient

Data structure that contains information about the character package that is already loaded.

LoadingPanel

Type: UIObject

Modifiers: transient

Panel that contains a bunch of widgets to show when loading a character package.

OriginalCameraLocation

Type: Object.Vector

Modifiers: transient

Original location of the camera actor.

OriginalCameraRotation

Type: Object.Rotator

Modifiers: transient

Original rotation of the camera actor.

PartImages

Type: array<UIImage>

Modifiers: transient

List of paper doll images.

PendingPackage

Type: UTCharFamilyAssetStore

Modifiers: transient

Data structure that contains information about the character package that is being loaded.

PreviewActor

Type: UTCustomChar_Preview

Modifiers: transient

Reference to the actor that we are previewing part changes on.

RotateLeftButton

Type: UTUIPressButton

Modifiers: transient

Button to rotate the character left.

RotateRightButton

Type: UTUIPressButton

Modifiers: transient

Button to rotate the character right.

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

PostInitialize event - Sets delegates for the scene.

UpdateLoadingPackage

event UpdateLoadingPackage ()

Checks the status of the package that is currently loading.

Other instance functions

ActivateLevelEventForCurrentPart

function ActivateLevelEventForCurrentPart ()

Activates the level kismet remote event for the currently selected part.

FindPreviewActor

function FindPreviewActor ()

Find the preview actor.

HandleInputKey

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.

LoadCharacterData

function LoadCharacterData ()

Loads the character data from the datastore.

OnAccept

function OnAccept ()

Callback for when the player has accepted the changes to their character.

OnBack

function OnBack ()

Callback for when the user is trying to back out of the character customization menu.

OnButtonBar_Accept

function bool OnButtonBar_Accept (UIScreenObject InButton, int InPlayerIndex)

Button bar callbacks - Accept Button

OnButtonBar_Back

function bool OnButtonBar_Back (UIScreenObject InButton, int InPlayerIndex)

Button bar callbacks - Back Button

OnButtonBar_ToggleShoulderType

function bool OnButtonBar_ToggleShoulderType (UIScreenObject InButton, int InPlayerIndex)

Button bar callbacks - Toggle shoulder type Button

OnCustomizationList_SelectionChange

function OnCustomizationList_SelectionChange (UTSimpleList InObject, int InNewIndex)

Delegate for when the customization list's index changes.

OnPartSelected

function OnPartSelected (UTCustomChar_Data.ECharPart PartType, string PartID)

Called when the accepts a current list selection.

Parameters:

  • PartType - The type of part we are changing.
  • string - The id of the part we are changing.

OnPreviewPartChanged

function OnPreviewPartChanged (UTCustomChar_Data.ECharPart PartType, string PartID)

Called when the user changes the selected index of a parts list.

Parameters:

  • PartType - The type of part we are changing.
  • string - The id of the part we are changing.

OnRotateLeftButton_BeginPress

function OnRotateLeftButton_BeginPress (UIScreenObject InObject, int InPlayerIndex)

Press button callbacks.

OnRotateLeftButton_EndPress

function OnRotateLeftButton_EndPress (UIScreenObject InObject, int InPlayerIndex)


OnRotateRightButton_BeginPress

function OnRotateRightButton_BeginPress (UIScreenObject InObject, int InPlayerIndex)


OnRotateRightButton_EndPress

function OnRotateRightButton_EndPress (UIScreenObject InObject, int InPlayerIndex)


OnSaveProfileCompleted

function OnSaveProfileCompleted ()

Callback for when the profile save has completed.

OnToggleShoulderType

function OnToggleShoulderType ()

Callback for when the user is trying to toggle the shoulder type of the character.

RestoreWorldSettings

function RestoreWorldSettings ()

Reset the world settings.

SaveCharacterData

function SaveCharacterData ()

Saves the character data to the datastore.

SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Sets up the buttonbar for this scene.

StartLoadingPackage

function StartLoadingPackage (string FamilyID)

Starts loading a asset package.

UpdatePaperDoll

function UpdatePaperDoll ()

Updates the paper doll part visibility using the current/previous part panels.