The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE3:UTUIFrontEnd_Credits (UT3)

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

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

Credits scene for UT3.

Properties[edit]

Property group 'UTUIFrontEnd_Credits'[edit]

DelayAfterPictures[edit]

Type: float

How much of a delay to have after pictures end.

Default value: 20.0

DelayBeforePictures[edit]

Type: float

How much of a delay to have before starting to show gears photos.

Default value: 10.0

SceneTimeInSec[edit]

Type: float

How long to show the scene for.

Default value: 240.0

Internal variables[edit]

bFinishedPlaying[edit]

Type: bool

Whether or not the credits have finished player.

CurrentImageSet[edit]

Type: int

Modifiers: transient

Which image set we are currently on.

CurrentObjectOffset[edit]

Type: int

Modifiers: transient

Which object set to use for fading.

CurrentTextSet[edit]

Type: int

Modifiers: transient

Which text set we are currently on.

ImageSets[edit]

Type: array<CreditsImageSet>

Modifiers: transient

A set of images and labels to cycle between.

PhotoImage[edit]

Type: UIImage

Array size: 6

Modifiers: transient

Photos of each person.

QuoteLabels[edit]

Type: UILabel

Array size: 6

Modifiers: transient

Labels that hold quotes for each person.

StartOffset[edit]

Type: float

Array size: 3

Modifiers: transient

Scrolling offset to start from.

StartTime[edit]

Type: float

Modifiers: transient

Record when we started displaying.

TextLabels[edit]

Type: UILabel

Array size: 3

Modifiers: transient

Labels to hold the scrolling credits text.

TextSets[edit]

Type: array<string>

Modifiers: transient

Sets of text used for the scrolling credits.

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Structs[edit]

CreditsImageSet[edit]

Modifiers: native

array<CreditsImageSetData> ImageData 

CreditsImageSetData[edit]

Modifiers: native

Surface TexImage 
string TexImageName 
UIRoot.TextureCoordinates TexCoords 
string LabelMarkup 

Functions[edit]

Native functions[edit]

SetupScene[edit]

native function SetupScene ()

Sets up the credits scene and retrieves references to widgets.

Events[edit]

Initialized[edit]

event Initialized ()

Overrides: UIScreenObject.Initialized

Make sure we use the frontend skin for credits.

OnCreditsFinished[edit]

event OnCreditsFinished ()

Callback for when the credits have finished displaying.

PostInitialize[edit]

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

PostInitialize event - Sets delegates for the scene.

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.

OnBack[edit]

function OnBack ()

Callback for when the user wants to back out of this screen.

OnButtonBar_Back[edit]

function bool OnButtonBar_Back (UIScreenObject InButton, int InPlayerIndex)

Buttonbar Callbacks.

OnFinishCredits[edit]

function OnFinishCredits ()

Finishes the credits, either by closing the scene or going back to the main menu.

SetupButtonBar[edit]

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Sets up the scene's button bar.