@kismet.ts/core / Exports / SequenceEvent

Class: SequenceEvent<T>

Type parameters

Name	Type
T	extends Object = {}

Hierarchy

• SequenceNode

  ↳ SequenceEvent

Table of contents

Constructors

• constructor

Properties

• clientSideOnly
• commentOptions
• connections
• enabled
• hasBreakpoint
• id
• inputs
• name
• playerOnly
• raw
• rawData
• sequence
• trigger
• type

Accessors

• ClassData
• baseJSON
• category
• linkId
• position
• rawName

Methods

• breakAllLinks
• equals
• getConnection
• hideUnusedConnections
• isAction
• isCondition
• isEvent
• isSequence
• isSequenceActionNode
• isSequenceItem
• isSequenceNode
• isVariable
• on
• setBreakpoint
• setComment
• setDisabled
• setDisplay
• setPosition
• setProperty
• setSequence
• setTrigger
• setVariable
• showAllConnections
• toJSON
• toString
• fromJSON
• fromRaw

Constructors

constructor

• new SequenceEvent<T>(options)

Type parameters

Name	Type
T	extends Object = {}

Parameters

Name	Type
options	T & BaseKismetEventOptions & BaseKismetItemOptions

Overrides

SequenceNode.constructor

Defined in

structures/Event.ts:21

Properties

clientSideOnly

• clientSideOnly: boolean

See

https://docs.unrealengine.com/udk/Three/KismetUserGuide.html#Client%20Side%20Kismet

Defined in

structures/Event.ts:18

---

commentOptions

• commentOptions: KismetComment = {}

Inherited from

SequenceNode.commentOptions

Defined in

item/base.ts:62

---

connections

• connections: KismetConnections

Inherited from

SequenceNode.connections

Defined in

item/base.ts:64

---

enabled

• enabled: boolean

Defined in

structures/Event.ts:19

---

hasBreakpoint

• hasBreakpoint: boolean = false

Inherited from

SequenceNode.hasBreakpoint

Defined in

item/node.ts:11

---

id

• Readonly id: ProcessId

Inherited from

SequenceNode.id

Defined in

item/base.ts:67

---

inputs

• Protected inputs: Object

Type declaration

Name	Type
input?	string[]
output?	string[]
variable?	string[]

Inherited from

SequenceNode.inputs

Defined in

item/base.ts:75

---

name

• name: string

Inherited from

SequenceNode.name

Defined in

item/base.ts:68

---

playerOnly

• playerOnly: boolean

Defined in

structures/Event.ts:14

---

raw

• raw: [string, KismetVariableValue][] = []

Inherited from

SequenceNode.raw

Defined in

item/base.ts:70

---

rawData

• rawData: BaseKismetItemRawData

Inherited from

SequenceNode.rawData

Defined in

item/base.ts:71

---

sequence

• sequence: string

Inherited from

SequenceNode.sequence

Defined in

item/base.ts:65

---

trigger

• trigger: Object

The trigger options for this event

Type declaration

Name	Type
delay	number
maxCount	number

Defined in

structures/Event.ts:13

---

type

• Readonly type: null | SequenceItemTypeName

Inherited from

SequenceNode.type

Defined in

item/_base.ts:19

Accessors

ClassData

• get ClassData(): Record<"Class" | "ClassType" | "Package", string>

Returns

Record<"Class" | "ClassType" | "Package", string>

Inherited from

SequenceNode.ClassData

Defined in

item/base.ts:142

---

baseJSON

• Private get baseJSON(): Record<string, KismetVariableValue>

Returns

Record<string, KismetVariableValue>

Inherited from

SequenceNode.baseJSON

Defined in

item/base.ts:115

---

category

• get category(): undefined | string

Returns

undefined | string

Inherited from

SequenceNode.category

Defined in

item/base.ts:138

---

linkId

• get linkId(): string

Returns

string

Inherited from

SequenceNode.linkId

Defined in

item/base.ts:146

---

position

• get position(): KismetPosition

Returns

KismetPosition

Inherited from

SequenceNode.position

Defined in

item/base.ts:150

---

rawName

• get rawName(): string

Returns

string

Inherited from

SequenceNode.rawName

Defined in

item/base.ts:133

Methods

breakAllLinks

▸ breakAllLinks(): void

Break all object links to other items.

Same as the editor right click > Break all links to Object(s)

Returns

void

Inherited from

SequenceNode.breakAllLinks

Defined in

item/base.ts:162

---

equals

▸ equals(item): boolean

Check whether another item is of the same type as this item

Parameters

Name	Type
item	SequenceItemType

Returns

boolean

Inherited from

SequenceNode.equals

Defined in

item/base.ts:196

---

getConnection

▸ getConnection(type, connectionName?): null | BaseKismetConnection | KismetConnection

Parameters

Name	Type
type	KismetConnectionType
connectionName?	string

Returns

null | BaseKismetConnection | KismetConnection

Inherited from

SequenceNode.getConnection

Defined in

item/base.ts:200

---

hideUnusedConnections

▸ hideUnusedConnections(): void

Hide all connection sockets that have no connections currently.

Same as the editor right click > Hide unused connectors

Returns

void

Inherited from

SequenceNode.hideUnusedConnections

Defined in

item/base.ts:173

---

isAction

▸ isAction(): this is SequenceAction

Returns

this is SequenceAction

Inherited from

SequenceNode.isAction

Defined in

item/_base.ts:29

---

isCondition

▸ isCondition(): this is SequenceCondition

Returns

this is SequenceCondition

Inherited from

SequenceNode.isCondition

Defined in

item/_base.ts:33

---

isEvent

▸ isEvent(): this is SequenceEvent<Object>

Returns

this is SequenceEvent<Object>

Inherited from

SequenceNode.isEvent

Defined in

item/_base.ts:37

---

isSequence

▸ isSequence(): this is Sequence

Returns

this is Sequence

Inherited from

SequenceNode.isSequence

Defined in

item/_base.ts:41

---

isSequenceActionNode

▸ isSequenceActionNode(): this is SequenceAction | SequenceCondition

Returns

this is SequenceAction | SequenceCondition

Inherited from

SequenceNode.isSequenceActionNode

Defined in

item/_base.ts:49

---

isSequenceItem

▸ isSequenceItem(): this is SequenceItemType

Returns

this is SequenceItemType

Inherited from

SequenceNode.isSequenceItem

Defined in

item/_base.ts:45

---

isSequenceNode

▸ isSequenceNode(): this is SequenceAction | SequenceCondition | SequenceEvent<Object>

Returns

this is SequenceAction | SequenceCondition | SequenceEvent<Object>

Inherited from

SequenceNode.isSequenceNode

Defined in

item/_base.ts:53

---

isVariable

▸ isVariable(): this is SequenceVariable

Returns

this is SequenceVariable

Inherited from

SequenceNode.isVariable

Defined in

item/_base.ts:60

---

on

▸ on<T>(name, to): SequenceEvent<T>

Type parameters

Name	Type
T	extends SequenceNode<T>

Parameters

Name	Type
name	string
to	Object
to.item	T
to.name?	string

Returns

SequenceEvent<T>

Defined in

structures/Event.ts:35

---

setBreakpoint

▸ setBreakpoint(enabled): SequenceEvent<T>

Parameters

Name	Type
enabled	boolean

Returns

SequenceEvent<T>

Inherited from

SequenceNode.setBreakpoint

Defined in

item/node.ts:20

---

setComment

▸ setComment(comment): SequenceEvent<T>

Set a comment on this item. This comment will be visible in the editor

Parameters

Name	Type	Description
comment	string | { comment?: string ; outputCommentToScreen?: boolean ; supressAutoComment?: boolean }	The text of the comment or the text in combination with comment options

Returns

SequenceEvent<T>

Inherited from

SequenceNode.setComment

Defined in

item/base.ts:216

---

setDisabled

▸ setDisabled(): SequenceEvent<T>

Disable this event

Returns

SequenceEvent<T>

Defined in

structures/Event.ts:70

---

setDisplay

▸ setDisplay(options): SequenceEvent<T>

Set the client / player display options

Parameters

Name	Type
options	Object
options.client?	boolean
options.player?	boolean

Returns

SequenceEvent<T>

Defined in

structures/Event.ts:80

---

setPosition

▸ setPosition(position, offset?): SequenceEvent<T>

Set a new position for this item

Parameters

Name	Type	Description
position	KismetPosition	The new position coordinates
offset?	boolean	Whether to use the new position as an offset to the current position (default: false)

Returns

SequenceEvent<T>

Inherited from

SequenceNode.setPosition

Defined in

item/base.ts:244

---

setProperty

▸ setProperty(...properties): SequenceEvent<T>

Set a variable if the variable has no variable connection. Used for properties you can set in the properties screen in the editor.

Parameters

Name	Type	Description
...properties	{ name: string ; value: KismetVariableValue }[]	The properties to set. Will not overwrite currently set properties

Returns

SequenceEvent<T>

Inherited from

SequenceNode.setProperty

Defined in

item/base.ts:258

---

setSequence

▸ setSequence(sequence, addToSequence?): SequenceEvent<T>

Change the sequence of this item

Parameters

Name	Type	Description
sequence	string | Sequence	The new sequence of this item: the linkId or the sequence itself
addToSequence?	boolean	If 'sequence' is the new sequence, whether to add the item to the sequence

Returns

SequenceEvent<T>

Inherited from

SequenceNode.setSequence

Defined in

item/base.ts:273

---

setTrigger

▸ setTrigger(options): SequenceEvent<T>

Set the trigger options for this event

Parameters

Name	Type
options	Object
options.delay?	number
options.max?	number

Returns

SequenceEvent<T>

Defined in

structures/Event.ts:102

---

setVariable

▸ setVariable(variableName, value, hidden?): SequenceEvent<T>

Parameters

Name	Type
variableName	string
value	string | number | SequenceVariable
hidden?	boolean

Returns

SequenceEvent<T>

Inherited from

SequenceNode.setVariable

Defined in

item/node.ts:28

---

showAllConnections

▸ showAllConnections(): void

Show all connection sockets.

Same as the editor right click > Show all connectors

Returns

void

Inherited from

SequenceNode.showAllConnections

Defined in

item/base.ts:186

---

toJSON

▸ toJSON(): Record<string, KismetVariableValue>

Returns

Record<string, KismetVariableValue>

Overrides

SequenceNode.toJSON

Defined in

structures/Event.ts:114

---

toString

▸ toString(): string

Returns

string

Overrides

SequenceNode.toString

Defined in

structures/Event.ts:128

---

fromJSON

▸ Static fromJSON(input): BaseSequenceItem

Converts an object to an item ands sets all other variables on the item. Special object keys:

Parameters

Name	Type
input	Record<string, KismetVariableValue>

Returns

BaseSequenceItem

Inherited from

SequenceNode.fromJSON

Defined in

item/base.ts:342

---

fromRaw

▸ Static fromRaw(input): BaseSequenceItem

Converts a two dimensional array of properties to an object. Then calls fromJSON with the object

Parameters

Name	Type
input	[string, KismetVariableValue][]

Returns

BaseSequenceItem

Inherited from

SequenceNode.fromRaw

Defined in

item/base.ts:322