I love the smell of UnrealEd crashing in the morning. – tarquin

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
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

Character customization screen for UT3

Constants[edit]

CHARACTERCUSTOMIZATION_BUTTONBAR_ACCEPT[edit]

Value: 0


CHARACTERCUSTOMIZATION_BUTTONBAR_BACK[edit]

Value: 1


Properties[edit]

Property group 'UTUIFrontEnd_CharacterCustomization'[edit]

CameraRotationSpeed[edit]

Type: float

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

Default value: 72.0

Internal variables[edit]

bHaveLoadedCharData[edit]

Type: bool

Modifiers: transient

Whether or not we loaded character data.

bRotateLeftDown[edit]

Type: bool

Modifiers: transient

Rotation button flags.

bRotateRightDown[edit]

Type: bool

Modifiers: transient


Character[edit]

Type: UTCustomChar_Data.CharacterInfo

Modifiers: transient

The current character we are viewing.

CharacterID[edit]

Type: string

Modifiers: transient

The name of the current character we are viewing.

CharacterPanel[edit]

Type: UIObject

Modifiers: transient

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

CurrentCameraActor[edit]

Type: CameraActor

Modifiers: transient

Reference to the current camera actor.

CurrentRotation[edit]

Type: float

Modifiers: transient

Current rotation delta of the camera actor.

CustomizationList[edit]

Type: UTUICharacterCustomizationList

Modifiers: transient

Reference to the character customization list.

Faction[edit]

Type: string

Modifiers: transient

The current faction we are viewing.

LoadedCharData[edit]

Type: UTCustomChar_Data.CustomCharData

Modifiers: transient

Loaded character data.

LoadedPackage[edit]

Type: UTCharFamilyAssetStore

Modifiers: transient

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

LoadingPanel[edit]

Type: UIObject

Modifiers: transient

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

OriginalCameraLocation[edit]

Type: Object.Vector

Modifiers: transient

Original location of the camera actor.

OriginalCameraRotation[edit]

Type: Object.Rotator

Modifiers: transient

Original rotation of the camera actor.

PartImages[edit]

Type: array<UIImage>

Modifiers: transient

List of paper doll images.

PendingPackage[edit]

Type: UTCharFamilyAssetStore

Modifiers: transient

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

PreviewActor[edit]

Type: UTCustomChar_Preview

Modifiers: transient

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

RotateLeftButton[edit]

Type: UTUIPressButton

Modifiers: transient

Button to rotate the character left.

RotateRightButton[edit]

Type: UTUIPressButton

Modifiers: transient

Button to rotate the character right.

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Functions[edit]

Events[edit]

PostInitialize[edit]

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

PostInitialize event - Sets delegates for the scene.

UpdateLoadingPackage[edit]

event UpdateLoadingPackage ()

Checks the status of the package that is currently loading.

Other instance functions[edit]

ActivateLevelEventForCurrentPart[edit]

function ActivateLevelEventForCurrentPart ()

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

FindPreviewActor[edit]

function FindPreviewActor ()

Find the preview actor.

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.

LoadCharacterData[edit]

function LoadCharacterData ()

Loads the character data from the datastore.

OnAccept[edit]

function OnAccept ()

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

OnBack[edit]

function OnBack ()

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

OnButtonBar_Accept[edit]

function bool OnButtonBar_Accept (UIScreenObject InButton, int InPlayerIndex)

Button bar callbacks - Accept Button

OnButtonBar_Back[edit]

function bool OnButtonBar_Back (UIScreenObject InButton, int InPlayerIndex)

Button bar callbacks - Back Button

OnButtonBar_ToggleShoulderType[edit]

function bool OnButtonBar_ToggleShoulderType (UIScreenObject InButton, int InPlayerIndex)

Button bar callbacks - Toggle shoulder type Button

OnCustomizationList_SelectionChange[edit]

function OnCustomizationList_SelectionChange (UTSimpleList InObject, int InNewIndex)

Delegate for when the customization list's index changes.

OnPartSelected[edit]

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[edit]

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[edit]

function OnRotateLeftButton_BeginPress (UIScreenObject InObject, int InPlayerIndex)

Press button callbacks.

OnRotateLeftButton_EndPress[edit]

function OnRotateLeftButton_EndPress (UIScreenObject InObject, int InPlayerIndex)


OnRotateRightButton_BeginPress[edit]

function OnRotateRightButton_BeginPress (UIScreenObject InObject, int InPlayerIndex)


OnRotateRightButton_EndPress[edit]

function OnRotateRightButton_EndPress (UIScreenObject InObject, int InPlayerIndex)


OnSaveProfileCompleted[edit]

function OnSaveProfileCompleted ()

Callback for when the profile save has completed.

OnToggleShoulderType[edit]

function OnToggleShoulderType ()

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

RestoreWorldSettings[edit]

function RestoreWorldSettings ()

Reset the world settings.

SaveCharacterData[edit]

function SaveCharacterData ()

Saves the character data to the datastore.

SetupButtonBar[edit]

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Sets up the buttonbar for this scene.

StartLoadingPackage[edit]

function StartLoadingPackage (string FamilyID)

Starts loading a asset package.

UpdatePaperDoll[edit]

function UpdatePaperDoll ()

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

Retrieved from "https://wiki.beyondunreal.com/UE3:UTUIFrontEnd_CharacterCustomization_(UT3)?oldid=28237"