@kismet.ts/core / Exports / VariableConnection

Class: VariableConnection

Hierarchy

• BaseKismetConnection

  ↳ VariableConnection

Table of contents

Constructors

• constructor

Properties

• CachedProperty
• DrawX
• MaxVars
• MinVars
• PropertyName
• bAllowAnyType
• bHidden
• bModifiesLinkedObject
• bSequenceNeverReadsOnlyWritesToThisVar
• bWriteable
• connectionIndex
• expectedType
• input
• kismet
• linkedIds
• links
• name
• type

Accessors

• isUsed
• typeName
• value

Methods

• addLink
• breakAllLinks
• breakLinkTo
• format
• isBaseConnection
• isItemConnection
• isOutput
• isVariableConnection
• prefix
• setHidden
• toString
• convertInput
• convertLink

Constructors

constructor

• new VariableConnection(input, type, index?)

Parameters

Name	Type
input	string
type	KismetConnectionType
index?	number

Overrides

BaseKismetConnection.constructor

Defined in

item/link.ts:234

Properties

CachedProperty

• CachedProperty: boolean

Defined in

item/link.ts:226

---

DrawX

• DrawX: number

Defined in

item/link.ts:229

---

MaxVars

• MaxVars: number

Defined in

item/link.ts:228

---

MinVars

• MinVars: number

Defined in

item/link.ts:227

---

PropertyName

• PropertyName: string

Defined in

item/link.ts:224

---

bAllowAnyType

• bAllowAnyType: boolean

Defined in

item/link.ts:225

---

bHidden

• bHidden: boolean

Inherited from

BaseKismetConnection.bHidden

Defined in

item/link.ts:38

---

bModifiesLinkedObject

• bModifiesLinkedObject: boolean

Defined in

item/link.ts:232

---

bSequenceNeverReadsOnlyWritesToThisVar

• bSequenceNeverReadsOnlyWritesToThisVar: boolean

Defined in

item/link.ts:231

---

bWriteable

• bWriteable: boolean

Defined in

item/link.ts:230

---

connectionIndex

• connectionIndex: number = 0

Inherited from

BaseKismetConnection.connectionIndex

Defined in

item/link.ts:34

---

expectedType

• expectedType: string

Defined in

item/link.ts:223

---

input

• Protected input: string

Inherited from

BaseKismetConnection.input

Defined in

item/link.ts:31

---

kismet

• Protected kismet: BaseKismetConnectionOptions

Inherited from

BaseKismetConnection.kismet

Defined in

item/link.ts:30

---

linkedIds

• linkedIds: string[] = []

Inherited from

BaseKismetConnection.linkedIds

Defined in

item/link.ts:37

---

links

• links: null | string[] = null

Inherited from

BaseKismetConnection.links

Defined in

item/link.ts:36

---

name

• name: string

Inherited from

BaseKismetConnection.name

Defined in

item/link.ts:33

---

type

• Protected Readonly type: KismetConnectionType

Inherited from

BaseKismetConnection.type

Defined in

item/link.ts:29

Accessors

isUsed

• get isUsed(): boolean

Whether the socket currently is being used by having at least one connection with another socket

Returns

boolean

Inherited from

BaseKismetConnection.isUsed

Defined in

item/link.ts:133

---

typeName

• Private get typeName(): string

Returns

string

Inherited from

BaseKismetConnection.typeName

Defined in

item/link.ts:97

---

value

• get value(): string

Returns

string

Inherited from

BaseKismetConnection.value

Defined in

item/link.ts:212

Methods

addLink

▸ addLink(linkId, index?, hidden?): VariableConnection

Add a new socket link connection

Parameters

Name	Type	Description
linkId	string	The linkId of the (other) item to connect to
index?	number	The index of the input variable socket that will be connected to. Empty or 0 if the socket is the first input socket on the item
hidden?	boolean	Change the hidden state of this socket

Returns

VariableConnection

Overrides

BaseKismetConnection.addLink

Defined in

item/link.ts:274

---

breakAllLinks

▸ breakAllLinks(): VariableConnection

Returns

VariableConnection

Inherited from

BaseKismetConnection.breakAllLinks

Defined in

item/link.ts:177

---

breakLinkTo

▸ breakLinkTo(linkId): VariableConnection

Parameters

Name	Type
linkId	string

Returns

VariableConnection

Inherited from

BaseKismetConnection.breakLinkTo

Defined in

item/link.ts:166

---

format

▸ Protected format(keys?): string

Parameters

Name	Type
keys?	string[]

Returns

string

Inherited from

BaseKismetConnection.format

Defined in

item/link.ts:101

---

isBaseConnection

▸ isBaseConnection(): this is BaseKismetConnection

Returns

this is BaseKismetConnection

Inherited from

BaseKismetConnection.isBaseConnection

Defined in

item/link.ts:184

---

isItemConnection

▸ isItemConnection(): this is ItemConnection

Returns

this is ItemConnection

Inherited from

BaseKismetConnection.isItemConnection

Defined in

item/link.ts:188

---

isOutput

▸ isOutput(): boolean

Returns

boolean

Defined in

item/link.ts:300

---

isVariableConnection

▸ isVariableConnection(): this is VariableConnection

Returns

this is VariableConnection

Inherited from

BaseKismetConnection.isVariableConnection

Defined in

item/link.ts:195

---

prefix

▸ prefix(index?): string

Parameters

Name	Type
index?	number

Returns

string

Inherited from

BaseKismetConnection.prefix

Defined in

item/link.ts:208

---

setHidden

▸ setHidden(hidden): VariableConnection

Parameters

Name	Type
hidden	boolean

Returns

VariableConnection

Inherited from

BaseKismetConnection.setHidden

Defined in

item/link.ts:202

---

toString

▸ toString(index?): string

Parameters

Name	Type
index?	number

Returns

string

Overrides

BaseKismetConnection.toString

Defined in

item/link.ts:304

---

convertInput

▸ Static convertInput(input): Record<string, string | number | boolean>

Parameters

Name	Type
input	string

Returns

Record<string, string | number | boolean>

Inherited from

BaseKismetConnection.convertInput

Defined in

item/link.ts:80

---

convertLink

▸ Static convertLink(type, input, index?): undefined | ItemConnection | VariableConnection

Parameters

Name	Type
type	KismetConnectionType
input	string
index?	number

Returns

undefined | ItemConnection | VariableConnection

Inherited from

BaseKismetConnection.convertLink

Defined in

item/link.ts:64