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

Class: Named

Variables.Named

Hierarchy

• SequenceVariable

  ↳ Named

Table of contents

Constructors

• constructor

Properties

• commentOptions
• connections
• expectedType
• id
• inputs
• name
• raw
• rawData
• searchVariableName
• sequence
• type
• variableName

Accessors

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

Methods

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

Constructors

constructor

• new Named(options?)

Parameters

Name	Type
options?	BaseKismetVariableOptions

Overrides

SequenceVariable.constructor

Defined in

items/src/variables/Named.ts:7

Properties

commentOptions

• commentOptions: KismetComment

Inherited from

SequenceVariable.commentOptions

Defined in

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

---

connections

• connections: KismetConnections

Inherited from

SequenceVariable.connections

Defined in

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

---

expectedType

• expectedType: null | string = null

Defined in

items/src/variables/Named.ts:4

---

id

• Readonly id: ProcessId

Inherited from

SequenceVariable.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

SequenceVariable.inputs

Defined in

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

---

name

• name: string

Inherited from

SequenceVariable.name

Defined in

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

---

raw

• raw: [string, KismetVariableValue][]

Inherited from

SequenceVariable.raw

Defined in

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

---

rawData

• rawData: BaseKismetItemRawData

Inherited from

SequenceVariable.rawData

Defined in

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

---

searchVariableName

• searchVariableName: null | string = null

Defined in

items/src/variables/Named.ts:5

---

sequence

• sequence: string

Inherited from

SequenceVariable.sequence

Defined in

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

---

type

• Readonly type: null | SequenceItemTypeName

Inherited from

SequenceVariable.type

Defined in

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

---

variableName

• variableName: null | string

Inherited from

SequenceVariable.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

SequenceVariable.ClassData

Defined in

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

---

baseJSON

• Private get baseJSON(): any

Returns

any

Inherited from

SequenceVariable.baseJSON

Defined in

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

---

category

• get category(): undefined | string

Returns

undefined | string

Inherited from

SequenceVariable.category

Defined in

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

---

linkId

• get linkId(): string

Returns

string

Inherited from

SequenceVariable.linkId

Defined in

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

---

position

• get position(): KismetPosition

Returns

KismetPosition

Inherited from

SequenceVariable.position

Defined in

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

---

rawName

• get rawName(): string

Returns

string

Inherited from

SequenceVariable.rawName

Defined in

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

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

SequenceVariable.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

SequenceVariable.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

SequenceVariable.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

SequenceVariable.hideUnusedConnections

Defined in

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

---

isAction

▸ isAction(): this is SequenceAction

Returns

this is SequenceAction

Inherited from

SequenceVariable.isAction

Defined in

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

---

isCondition

▸ isCondition(): this is SequenceCondition

Returns

this is SequenceCondition

Inherited from

SequenceVariable.isCondition

Defined in

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

---

isEvent

▸ isEvent(): this is SequenceEvent<Object>

Returns

this is SequenceEvent<Object>

Inherited from

SequenceVariable.isEvent

Defined in

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

---

isSequence

▸ isSequence(): this is Sequence

Returns

this is Sequence

Inherited from

SequenceVariable.isSequence

Defined in

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

---

isSequenceActionNode

▸ isSequenceActionNode(): this is SequenceAction | SequenceCondition

Returns

this is SequenceAction | SequenceCondition

Inherited from

SequenceVariable.isSequenceActionNode

Defined in

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

---

isSequenceItem

▸ isSequenceItem(): this is SequenceItemType

Returns

this is SequenceItemType

Inherited from

SequenceVariable.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

SequenceVariable.isSequenceNode

Defined in

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

---

isVariable

▸ isVariable(): this is SequenceVariable

Returns

this is SequenceVariable

Inherited from

SequenceVariable.isVariable

Defined in

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

---

setComment

▸ setComment(comment): Named

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

Named

Inherited from

SequenceVariable.setComment

Defined in

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

---

setName

▸ setName(name): Named

Parameters

Name	Type
name	string

Returns

Named

Inherited from

SequenceVariable.setName

Defined in

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

---

setPosition

▸ setPosition(position, offset?): Named

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

Named

Inherited from

SequenceVariable.setPosition

Defined in

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

---

setProperty

▸ setProperty(...properties): Named

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

Named

Inherited from

SequenceVariable.setProperty

Defined in

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

---

setSearchVariable

▸ setSearchVariable<T>(options): Named

Type parameters

Name	Type
T	extends SequenceVariable<T>

Parameters

Name	Type
options	Object
options.name?	string
options.type?	T

Returns

Named

Defined in

items/src/variables/Named.ts:15

---

setSequence

▸ setSequence(sequence, addToSequence?): Named

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

Named

Inherited from

SequenceVariable.setSequence

Defined in

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

---

showAllConnections

▸ showAllConnections(): void

Show all connection sockets.

Same as the editor right click > Show all connectors

Returns

void

Inherited from

SequenceVariable.showAllConnections

Defined in

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

---

toJSON

▸ toJSON(): Record<string, KismetVariableValue>

Returns

Record<string, KismetVariableValue>

Inherited from

SequenceVariable.toJSON

Defined in

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

---

toString

▸ toString(): string

Returns

string

Overrides

SequenceVariable.toString

Defined in

items/src/variables/Named.ts:22

---

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

SequenceVariable.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

SequenceVariable.fromRaw

Defined in

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