Cogito, ergo sum

UE3:SequenceObject (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UDK Object >> SequenceObject

Contents

Package: 
Engine
Direct subclasses:
SequenceFrame, SequenceOp, SequenceVariable
This class in other games:
UT3

Base class for all Kismet related objects.

[edit] Properties

[edit] Property group 'SequenceObject'

[edit] bOutputObjCommentToScreen

Type: bool

Should this object display ObjComment when activated?

[edit] bSuppressAutoComment

Type: bool

Should we suppress the 'auto' comment text - values of properties flagged with the 'autocomment' metadata string.

Default value: True

[edit] ObjComment

Type: string

User editable text comment

[edit] Internal variables

[edit] bDeletable

Type: bool

Whether or not this object is deletable.

Default value: True

[edit] bDrawFirst

Type: bool

Should this object be drawn in the first pass?

[edit] bDrawLast

Type: bool

Should this object be drawn in the last pass?

[edit] DrawHeight

Type: int

Cached drawing dimensions

[edit] DrawWidth

Type: int

Cached drawing dimensions

[edit] ObjCategory

Type: string

Modifiers: editoronly

Editor category for this object. Determines which kismet submenu this object should be placed in

[edit] ObjColor

Type: Object.Color

Modifiers: editoronly

Color used to draw the object

Default value:

Member Value
A 255
B 255
G 255
R 255

[edit] ObjInstanceVersion

Type: int

Modifiers: const

Class vs instance version, for offering updates in the Kismet editor

[edit] ObjName

Type: string

Modifiers: editoronly

Text label that describes this object

Default value: "Undefined"

[edit] ObjPosX

Type: int

Modifiers: editoronly

Visual position of this object within a sequence

[edit] ObjPosY

Type: int

Modifiers: editoronly

Visual position of this object within a sequence

[edit] ObjRemoveInProject

Type: array<string>

Modifiers: editoronly

List of games that do not want to display this object

[edit] ParentSequence

Type: Sequence

Modifiers: const, noimport

Sequence that contains this object

[edit] Functions

[edit] Static events

[edit] GetObjClassVersion

static event int 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.

[edit] Native functions

[edit] GetWorldInfo

native final function WorldInfo GetWorldInfo ()

Returns the current world's WorldInfo, useful for spawning actors and such.

[edit] ScriptLog

native final function ScriptLog (string LogText, optional bool bWarning)

Writes out the specified text to a dedicated scripting log file.

Parameters:

  • LogText - the text to print
  • bWarning - true if this is a warning message. Warning messages are also sent to the normal game log and appear onscreen if Engine's configurable bOnScreenKismetWarnings is true

[edit] Events

[edit] IsPastingIntoLevelSequenceAllowed

event bool IsPastingIntoLevelSequenceAllowed ()

Determines whether objects of this class are allowed to be pasted into level sequences.

Returns:

TRUE if this sequence object can be pasted into level sequences.

[edit] IsPastingIntoUISequenceAllowed

event bool IsPastingIntoUISequenceAllowed ()

Determines whether objects of this class are allowed to be pasted into UI sequences.

Returns:

TRUE if this sequence object can be pasted into UI sequences.

[edit] IsValidLevelSequenceObject

event bool 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

[edit] IsValidUISequenceObject

event bool IsValidUISequenceObject (optional UIScreenObject TargetObject)

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

Parameters:

  • TargetObject - the widget that this SequenceObject would be attached to.

Returns:

TRUE if this sequence object should be available for use in the UI kismet editor
Personal tools