@kismet.ts/core / Exports / BaseKismetConnection

Class: BaseKismetConnection

Hierarchy

• BaseKismetConnection

  ↳ VariableConnection

  ↳ ItemConnection

Table of contents

Constructors

• constructor

Properties

• bHidden
• baseConnection
• connectionIndex
• input
• kismet
• linkedIds
• links
• name
• type

Accessors

• isUsed
• typeName
• value

Methods

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

Constructors

constructor

• new BaseKismetConnection(options)

Parameters

Name	Type
options	Object
options.extends?	boolean
options.index?	number
options.input	string
options.kismetOptions?	BaseKismetConnectionOptions
options.type	KismetConnectionType

Defined in

item/link.ts:40

Properties

bHidden

• bHidden: boolean

Defined in

item/link.ts:38

---

baseConnection

• Private baseConnection: boolean

Defined in

item/link.ts:28

---

connectionIndex

• connectionIndex: number = 0

Defined in

item/link.ts:34

---

input

• Protected input: string

Defined in

item/link.ts:31

---

kismet

• Protected kismet: BaseKismetConnectionOptions

Defined in

item/link.ts:30

---

linkedIds

• linkedIds: string[] = []

Defined in

item/link.ts:37

---

links

• links: null | string[] = null

Defined in

item/link.ts:36

---

name

• name: string

Defined in

item/link.ts:33

---

type

• Protected Readonly type: KismetConnectionType

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

Defined in

item/link.ts:133

---

typeName

• Private get typeName(): string

Returns

string

Defined in

item/link.ts:97

---

value

• get value(): string

Returns

string

Defined in

item/link.ts:212

Methods

addLink

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

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

BaseKismetConnection

Defined in

item/link.ts:144

---

breakAllLinks

▸ breakAllLinks(): BaseKismetConnection

Returns

BaseKismetConnection

Defined in

item/link.ts:177

---

breakLinkTo

▸ breakLinkTo(linkId): BaseKismetConnection

Parameters

Name	Type
linkId	string

Returns

BaseKismetConnection

Defined in

item/link.ts:166

---

format

▸ Protected format(keys?): string

Parameters

Name	Type
keys?	string[]

Returns

string

Defined in

item/link.ts:101

---

isBaseConnection

▸ isBaseConnection(): this is BaseKismetConnection

Returns

this is BaseKismetConnection

Defined in

item/link.ts:184

---

isItemConnection

▸ isItemConnection(): this is ItemConnection

Returns

this is ItemConnection

Defined in

item/link.ts:188

---

isVariableConnection

▸ isVariableConnection(): this is VariableConnection

Returns

this is VariableConnection

Defined in

item/link.ts:195

---

prefix

▸ prefix(index?): string

Parameters

Name	Type
index?	number

Returns

string

Defined in

item/link.ts:208

---

setHidden

▸ setHidden(hidden): BaseKismetConnection

Parameters

Name	Type
hidden	boolean

Returns

BaseKismetConnection

Defined in

item/link.ts:202

---

toString

▸ toString(index?): string

Parameters

Name	Type
index?	number

Returns

string

Defined in

item/link.ts:216

---

convertInput

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

Parameters

Name	Type
input	string

Returns

Record<string, string | number | boolean>

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

Defined in

item/link.ts:64