@kismet.ts/items / Exports / Variables / ObjectList

Class: ObjectList

Variables.ObjectList

Hierarchy

• Object

  ↳ ObjectList

Table of contents

Constructors

• constructor

Properties

• commentOptions
• connections
• id
• inputs
• name
• raw
• rawData
• sequence
• type
• value
• values
• variableName

Accessors

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

Methods

• addItem
• addItems
• breakAllLinks
• equals
• getConnection
• hideUnusedConnections
• isAction
• isCondition
• isEvent
• isSequence
• isSequenceActionNode
• isSequenceItem
• isSequenceNode
• isVariable
• setComment
• setName
• setPosition
• setProperty
• setSequence
• setValue
• showAllConnections
• toJSON
• toString
• fromJSON
• fromRaw

Constructors

constructor

• new ObjectList(options?)

Parameters

Name	Type
options?	BaseKismetVariableOptions

Overrides

Object.constructor

Defined in

items/src/variables/Object.ts:32

Properties

commentOptions

• commentOptions: KismetComment

Inherited from

Object.commentOptions

Defined in

core/dist/src/item/base.d.ts:19

---

connections

• connections: KismetConnections

Inherited from

Object.connections

Defined in

core/dist/src/item/base.d.ts:20

---

id

• Readonly id: ProcessId

Inherited from

Object.id

Defined in

core/dist/src/item/base.d.ts:22

---

inputs

• Protected inputs: Object

Type declaration

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

Inherited from

Object.inputs

Defined in

core/dist/src/item/base.d.ts:28

---

name

• name: string

Inherited from

Object.name

Defined in

core/dist/src/item/base.d.ts:23

---

raw

• raw: [string, KismetVariableValue][]

Inherited from

Object.raw

Defined in

core/dist/src/item/base.d.ts:24

---

rawData

• rawData: BaseKismetItemRawData

Inherited from

Object.rawData

Defined in

core/dist/src/item/base.d.ts:25

---

sequence

• sequence: string

Inherited from

Object.sequence

Defined in

core/dist/src/item/base.d.ts:21

---

type

• Readonly type: null | SequenceItemTypeName

Inherited from

Object.type

Defined in

core/dist/src/item/_base.d.ts:4

---

value

• value: string

Inherited from

Object.value

Defined in

items/src/variables/Object.ts:4

---

values

• values: string[]

Defined in

items/src/variables/Object.ts:30

---

variableName

• variableName: null | string

Inherited from

Object.variableName

Defined in

core/dist/src/structures/Variable.d.ts:4

Accessors

ClassData

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

Returns

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

Inherited from

ObjectVariable.ClassData

Defined in

core/dist/src/item/base.d.ts:35

---

baseJSON

• Private get baseJSON(): any

Returns

any

Inherited from

ObjectVariable.baseJSON

Defined in

core/dist/src/item/base.d.ts:32

---

category

• get category(): undefined | string

Returns

undefined | string

Inherited from

ObjectVariable.category

Defined in

core/dist/src/item/base.d.ts:34

---

linkId

• get linkId(): string

Returns

string

Inherited from

ObjectVariable.linkId

Defined in

core/dist/src/item/base.d.ts:36

---

position

• get position(): KismetPosition

Returns

KismetPosition

Inherited from

ObjectVariable.position

Defined in

core/dist/src/item/base.d.ts:37

---

rawName

• get rawName(): string

Returns

string

Inherited from

ObjectVariable.rawName

Defined in

core/dist/src/item/base.d.ts:33

Methods

addItem

▸ addItem(item): ObjectList

Parameters

Name	Type
item	string

Returns

ObjectList

Defined in

items/src/variables/Object.ts:40

---

addItems

▸ addItems(items): ObjectList

Parameters

Name	Type
items	string[]

Returns

ObjectList

Defined in

items/src/variables/Object.ts:46

---

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

Object.breakAllLinks

Defined in

core/dist/src/item/base.d.ts:43

---

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

Object.equals

Defined in

core/dist/src/item/base.d.ts:60

---

getConnection

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

Parameters

Name	Type
type	KismetConnectionType
connectionName?	string

Returns

null | BaseKismetConnection | KismetConnection

Inherited from

Object.getConnection

Defined in

core/dist/src/item/base.d.ts:61

---

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

Object.hideUnusedConnections

Defined in

core/dist/src/item/base.d.ts:49

---

isAction

▸ isAction(): this is SequenceAction

Returns

this is SequenceAction

Inherited from

Object.isAction

Defined in

core/dist/src/item/_base.d.ts:7

---

isCondition

▸ isCondition(): this is SequenceCondition

Returns

this is SequenceCondition

Inherited from

Object.isCondition

Defined in

core/dist/src/item/_base.d.ts:8

---

isEvent

▸ isEvent(): this is SequenceEvent<Object>

Returns

this is SequenceEvent<Object>

Inherited from

Object.isEvent

Defined in

core/dist/src/item/_base.d.ts:9

---

isSequence

▸ isSequence(): this is Sequence

Returns

this is Sequence

Inherited from

Object.isSequence

Defined in

core/dist/src/item/_base.d.ts:10

---

isSequenceActionNode

▸ isSequenceActionNode(): this is SequenceAction | SequenceCondition

Returns

this is SequenceAction | SequenceCondition

Inherited from

Object.isSequenceActionNode

Defined in

core/dist/src/item/_base.d.ts:12

---

isSequenceItem

▸ isSequenceItem(): this is SequenceItemType

Returns

this is SequenceItemType

Inherited from

Object.isSequenceItem

Defined in

core/dist/src/item/_base.d.ts:11

---

isSequenceNode

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

Returns

this is SequenceAction | SequenceCondition | SequenceEvent<Object>

Inherited from

Object.isSequenceNode

Defined in

core/dist/src/item/_base.d.ts:13

---

isVariable

▸ isVariable(): this is SequenceVariable

Returns

this is SequenceVariable

Inherited from

Object.isVariable

Defined in

core/dist/src/item/_base.d.ts:14

---

setComment

▸ setComment(comment): ObjectList

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

ObjectList

Inherited from

Object.setComment

Defined in

core/dist/src/item/base.d.ts:66

---

setName

▸ setName(name): ObjectList

Parameters

Name	Type
name	string

Returns

ObjectList

Inherited from

Object.setName

Defined in

core/dist/src/structures/Variable.d.ts:6

---

setPosition

▸ setPosition(position, offset?): ObjectList

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

ObjectList

Inherited from

Object.setPosition

Defined in

core/dist/src/item/base.d.ts:76

---

setProperty

▸ setProperty(...properties): ObjectList

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

ObjectList

Inherited from

Object.setProperty

Defined in

core/dist/src/item/base.d.ts:82

---

setSequence

▸ setSequence(sequence, addToSequence?): ObjectList

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

ObjectList

Inherited from

Object.setSequence

Defined in

core/dist/src/item/base.d.ts:91

---

setValue

▸ setValue(value): ObjectList

Parameters

Name	Type
value	string

Returns

ObjectList

Inherited from

Object.setValue

Defined in

items/src/variables/Object.ts:16

---

showAllConnections

▸ showAllConnections(): void

Show all connection sockets.

Same as the editor right click > Show all connectors

Returns

void

Inherited from

Object.showAllConnections

Defined in

core/dist/src/item/base.d.ts:55

---

toJSON

▸ toJSON(): Record<string, KismetVariableValue>

Returns

Record<string, KismetVariableValue>

Inherited from

Object.toJSON

Defined in

core/dist/src/item/base.d.ts:92

---

toString

▸ toString(): string

Returns

string

Overrides

Object.toString

Defined in

items/src/variables/Object.ts:52

---

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

Object.fromJSON

Defined in

core/dist/src/item/base.d.ts:107

---

fromRaw

▸ Static fromRaw(input): BaseSequenceItem

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

Parameters

Name	Type
input	[string, KismetVariableValue][]

Returns

BaseSequenceItem

Inherited from

Object.fromRaw

Defined in

core/dist/src/item/base.d.ts:99