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

Difference between revisions of "UE3:UIAction Scene (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
m (1 revision: class descriptions for UDK January update (part 5))
 
(No difference)

Latest revision as of 06:48, 17 January 2010

UDK Object >> SequenceObject >> SequenceOp >> SequenceAction >> UIAction >> UIAction_Scene
Package: 
Engine
Direct subclasses:
UIAction_CloseScene, UIAction_OpenScene
This class in other games:
UT3

Base class for all actions that manipulate scenes.

Constants[edit]

ACTION_SUCCESS_INDEX[edit]

Value: 0


ACTION_FAILURE_INDEX[edit]

Value: 1


DEFAULT_SCENE_PRIORITY[edit]

Value: 10

the default priority for all UIScenes

Properties[edit]

Property group 'UIAction_Scene'[edit]

ForcedScenePriority[edit]

Type: byte

Allows the designer to override the scene's default stack priority

Default value: 10

Scene[edit]

Type: UIScene

the scene that this action will manipulate

Default values[edit]

Property Value
bAutoActivateOutputLinks False
bCallHandler False
ObjCategory "UI Scenes"
OutputLinks[0]
Member Value
LinkDesc "Success"
OutputLinks[1]
Member Value
LinkDesc "Failed"
VariableLinks[0]
Member Value
LinkDesc "Scene"
PropertyName 'Scene'

Functions[edit]

Static events[edit]

GetObjClassVersion[edit]

static event int GetObjClassVersion ()

Overrides: UIAction.GetObjClassVersion

Return the version number for this class. Child classes should increment this method by calling Super then adding a individual class version to the result. When a class is first created, the number should be 0; each time one of the link arrays is modified (VariableLinks, OutputLinks, InputLinks, etc.), the number that is added to the result of Super.GetObjClassVersion() should be incremented by 1.

Returns:

the version number for this specific class.

Events[edit]

IsValidLevelSequenceObject[edit]

event bool IsValidLevelSequenceObject ()

Overrides: UIAction.IsValidLevelSequenceObject

Determines whether this class should be displayed in the list of available ops in the level kismet editor.

Returns:

TRUE if this sequence object should be available for use in the level kismet editor