@kismet.ts/core / Exports / Sequence

Class: Sequence

Class for a kismet sequence

Hierarchy

• BaseItem

  ↳ Sequence

Table of contents

Constructors

• constructor

Properties

• defaultView
• enabled
• hasBreakpoint
• id
• items
• kismet
• mainSequence
• name
• parentSequence
• positionManager
• project
• type

Accessors

• linkId
• rawData
• subSequences
• util
• DefaultFormattedSequenceName

Methods

• addItem
• addItems
• addSubSequence
• clearAllBreakpoints
• isAction
• isCondition
• isEvent
• isSequence
• isSequenceActionNode
• isSequenceItem
• isSequenceNode
• isVariable
• resolve
• resolveId
• setBreakpoint
• setDisabled
• setName
• setView
• toJSON
• toString
• update
• updateItem
• updateItems
• formatSequenceReference

Constructors

constructor

• new Sequence(options?)

Parameters

Name	Type
options?	SequenceBaseConstructorOptions<SchemaItemNames>

Overrides

BaseItem.constructor

Defined in

structures/base.ts:89

Properties

defaultView

• defaultView: Required<SequenceViewOptions>

The location of focus when opening the sequence

Defined in

structures/base.ts:51

---

enabled

• enabled: boolean = true

Whether this sequence can be edited

Defined in

structures/base.ts:63

---

hasBreakpoint

• hasBreakpoint: boolean = false

Defined in

structures/base.ts:87

---

id

• Readonly id: ProcessId

Defined in

structures/base.ts:53

---

items

• items: (SequenceItemType | Sequence)[] = []

The items that are added to this sequence

Defined in

structures/base.ts:73

---

kismet

• Private kismet: Object

Type declaration

Name	Type
x	number
y	number

Defined in

structures/base.ts:84

---

mainSequence

• Private Readonly mainSequence: boolean

Defined in

structures/base.ts:86

---

name

• name: string

Defined in

structures/base.ts:46

---

parentSequence

• parentSequence: string = Sequence.DefaultFormattedSequenceName

The parent sequence of this sequence.

Defined in

structures/base.ts:68

---

positionManager

• Private positionManager: SequencePositionManager

Defined in

structures/base.ts:85

---

project

• Optional Readonly project: ProcessId

The id of the attached project to this sequence

Defined in

structures/base.ts:58

---

type

• Readonly type: null | SequenceItemTypeName

Inherited from

BaseItem.type

Defined in

item/_base.ts:19

Accessors

linkId

• get linkId(): string

Returns

string

Defined in

structures/base.ts:142

---

rawData

• Private get rawData(): Object

Returns

Object

Name	Type
DrawHeight	number
DrawWidth	number
ObjInstanceVersion	number
ObjPosX	number
ObjPosY	number
ObjectArchetype	string

Defined in

structures/base.ts:119

---

subSequences

• get subSequences(): Sequence[]

The subsequences that are added in this sequence

Returns

Sequence[]

Defined in

structures/base.ts:78

---

util

• get util(): SequenceUtil

Returns

SequenceUtil

Defined in

structures/base.ts:138

---

DefaultFormattedSequenceName

• Static get DefaultFormattedSequenceName(): string

Returns

string

Defined in

structures/base.ts:134

Methods

addItem

▸ addItem(item, overwriteSequence?): Sequence

Parameters

Name	Type
item	SequenceItemType
overwriteSequence?	boolean

Returns

Sequence

Defined in

structures/base.ts:146

---

addItems

▸ addItems(items): Sequence

Parameters

Name	Type
items	SequenceItemType[]

Returns

Sequence

Defined in

structures/base.ts:156

---

addSubSequence

▸ addSubSequence(«destructured»): Object

Parameters

Name	Type
«destructured»	SequenceOptions<SequenceItemType, SchemaItemNames>

Returns

Object

Name	Type
sequence	Sequence
subSequence	Sequence

Defined in

structures/base.ts:162

---

clearAllBreakpoints

▸ clearAllBreakpoints(includeSubsequences?): Sequence

Clear all breakpoints on items in this sequence

Parameters

Name	Type	Description
includeSubsequences?	boolean	Whether to clear breakpoints in subsequences (default false)

Returns

Sequence

Defined in

structures/base.ts:196

---

isAction

▸ isAction(): this is SequenceAction

Returns

this is SequenceAction

Inherited from

BaseItem.isAction

Defined in

item/_base.ts:29

---

isCondition

▸ isCondition(): this is SequenceCondition

Returns

this is SequenceCondition

Inherited from

BaseItem.isCondition

Defined in

item/_base.ts:33

---

isEvent

▸ isEvent(): this is SequenceEvent<Object>

Returns

this is SequenceEvent<Object>

Inherited from

BaseItem.isEvent

Defined in

item/_base.ts:37

---

isSequence

▸ isSequence(): this is Sequence

Returns

this is Sequence

Inherited from

BaseItem.isSequence

Defined in

item/_base.ts:41

---

isSequenceActionNode

▸ isSequenceActionNode(): this is SequenceAction | SequenceCondition

Returns

this is SequenceAction | SequenceCondition

Inherited from

BaseItem.isSequenceActionNode

Defined in

item/_base.ts:49

---

isSequenceItem

▸ isSequenceItem(): this is SequenceItemType

Returns

this is SequenceItemType

Inherited from

BaseItem.isSequenceItem

Defined in

item/_base.ts:45

---

isSequenceNode

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

Returns

this is SequenceAction | SequenceCondition | SequenceEvent<Object>

Inherited from

BaseItem.isSequenceNode

Defined in

item/_base.ts:53

---

isVariable

▸ isVariable(): this is SequenceVariable

Returns

this is SequenceVariable

Inherited from

BaseItem.isVariable

Defined in

item/_base.ts:60

---

resolve

▸ resolve(item): null | SequenceItemType | Sequence

Parameters

Name	Type
item	SequenceResolvable

Returns

null | SequenceItemType | Sequence

Defined in

structures/base.ts:224

---

resolveId

▸ resolveId(id): null | SequenceItemType | Sequence

Resolve an id to an item in this sequence

Parameters

Name	Type	Description
id	string | ProcessId	The id to search

Returns

null | SequenceItemType | Sequence

Defined in

structures/base.ts:212

---

setBreakpoint

▸ setBreakpoint(enabled): Sequence

Set / remove a breakpoint on this sequence

Parameters

Name	Type
enabled	boolean

Returns

Sequence

Defined in

structures/base.ts:233

---

setDisabled

▸ setDisabled(): Sequence

Disable this sequence

Returns

Sequence

Defined in

structures/base.ts:242

---

setName

▸ setName(name): Sequence

Set a new name for this sequence. Cannot be set if this sequence is the main sequence.

Parameters

Name	Type
name	string

Returns

Sequence

Defined in

structures/base.ts:253

---

setView

▸ setView(options): Sequence

Set view options for this sequence

Parameters

Name	Type	Description
options	SequenceViewOptions	The default view options

Returns

Sequence

Defined in

structures/base.ts:263

---

toJSON

▸ toJSON(): Record<string, KismetVariableValue>

Returns

Record<string, KismetVariableValue>

Defined in

structures/base.ts:300

---

toString

▸ toString(): string

Returns

string

Defined in

structures/base.ts:319

---

update

▸ update(item): void

Parameters

Name	Type
item	SequenceItemType | Sequence

Returns

void

Defined in

structures/base.ts:273

---

updateItem

▸ updateItem(item, updatedItem): void

Parameters

Name	Type
item	SequenceResolvable
updatedItem	SequenceItemType | Sequence

Returns

void

Defined in

structures/base.ts:277

---

updateItems

▸ updateItems(items): void

Parameters

Name	Type
items	[SequenceResolvable, SequenceItemType | Sequence][]

Returns

void

Defined in

structures/base.ts:294

---

formatSequenceReference

▸ Static formatSequenceReference(name): string

Parameters

Name	Type
name	string

Returns

string

Defined in

structures/base.ts:130