UE3:SequenceObject (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 14:07, 28 November 2008 by Wormbo (talk | contribs) (tweaked descriptions)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
UT3 Object >> SequenceObject
Package:
Engine
Direct subclasses:
SequenceFrame, SequenceOp, SequenceVariable
This class in other games:

Base class for all Kismet related objects.

Properties

Property group 'SequenceObject'

bOutputObjCommentToScreen

Type: bool

Should this object display ObjComment when activated?

bSuppressAutoComment

Type: bool

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

Default value: True

ObjComment

Type: string

User editable text comment

Internal variables

bDeletable

Type: bool

Whether or not this object is deletable.

Default value: True

bDrawFirst

Type: bool

Should this object be drawn in the first pass?

bDrawLast

Type: bool

Should this object be drawn in the last pass?

DrawHeight

Type: int

Cached drawing dimensions

DrawWidth

Type: int

Cached drawing dimensions

ObjCategory

Type: string

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

ObjClassVersion

Type: int

Modifiers: const

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

Default value: 1

ObjColor

Type: Object.Color

Color used to draw the object

Default value:

Member Value
A 255
B 255
G 255
R 255

ObjInstanceVersion

Type: int

Modifiers: const

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

ObjName

Type: string

Text label that describes this object

Default value: "Undefined"

ObjPosX

Type: int

Visual position of this object within a sequence

ObjPosY

Type: int

Visual position of this object within a sequence

ParentSequence

Type: Sequence

Modifiers: const, noimport

Sequence that contains this object

Functions

Native functions

GetWorldInfo

native final function WorldInfo GetWorldInfo ()

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

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

Events

IsValidLevelSequenceObject

event bool IsValidLevelSequenceObject ()

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

Returns:

Always True. Kismet objects are allowed for level scripts by default.

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:

Always False. Kismet objects are not allowed for UI scripts by default.