@kismet.ts/core / Exports / Comment

Class: Comment

Hierarchy

• BaseSequenceItem

  ↳ Comment

  ↳↳ CommentFrame

Table of contents

Constructors

• constructor

Properties

• borderColor
• borderWidth
• commentOptions
• connections
• drawBox
• fillColor
• fillMaterial
• fillTexture
• filled
• id
• inputs
• name
• raw
• rawData
• sequence
• size
• tileFill
• type

Accessors

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

Methods

• breakAllLinks
• equals
• getConnection
• hideUnusedConnections
• isAction
• isCommentFrame
• isCondition
• isEvent
• isSequence
• isSequenceActionNode
• isSequenceItem
• isSequenceNode
• isVariable
• setBorder
• setComment
• setFilled
• setPosition
• setProperty
• setSequence
• setSize
• setStyle
• showAllConnections
• toJSON
• toString
• fromJSON
• fromRaw

Constructors

constructor

• new Comment(comment?)

Parameters

Name	Type
comment?	string

Overrides

BaseSequenceItem.constructor

Defined in

structures/Comment.ts:24

Properties

borderColor

• borderColor: KismetColor

Defined in

structures/Comment.ts:18

---

borderWidth

• borderWidth: number

Defined in

structures/Comment.ts:19

---

commentOptions

• commentOptions: KismetComment = {}

Inherited from

BaseSequenceItem.commentOptions

Defined in

item/base.ts:62

---

connections

• connections: KismetConnections

Inherited from

BaseSequenceItem.connections

Defined in

item/base.ts:64

---

drawBox

• drawBox: boolean

Defined in

structures/Comment.ts:15

---

fillColor

• fillColor: KismetColor

Defined in

structures/Comment.ts:20

---

fillMaterial

• fillMaterial: null | string

Defined in

structures/Comment.ts:21

---

fillTexture

• fillTexture: null | string

Defined in

structures/Comment.ts:22

---

filled

• filled: boolean

Defined in

structures/Comment.ts:16

---

id

• Readonly id: ProcessId

Inherited from

BaseSequenceItem.id

Defined in

item/base.ts:67

---

inputs

• Protected inputs: Object

Type declaration

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

Inherited from

BaseSequenceItem.inputs

Defined in

item/base.ts:75

---

name

• name: string

Inherited from

BaseSequenceItem.name

Defined in

item/base.ts:68

---

raw

• raw: [string, KismetVariableValue][] = []

Inherited from

BaseSequenceItem.raw

Defined in

item/base.ts:70

---

rawData

• rawData: BaseKismetItemRawData

Inherited from

BaseSequenceItem.rawData

Defined in

item/base.ts:71

---

sequence

• sequence: string

Inherited from

BaseSequenceItem.sequence

Defined in

item/base.ts:65

---

size

• size: Object

Type declaration

Name	Type
x	number
y	number

Defined in

structures/Comment.ts:14

---

tileFill

• tileFill: boolean

Defined in

structures/Comment.ts:17

---

type

• Readonly type: null | SequenceItemTypeName

Inherited from

BaseSequenceItem.type

Defined in

item/_base.ts:19

Accessors

ClassData

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

Returns

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

Inherited from

BaseSequenceItem.ClassData

Defined in

item/base.ts:142

---

baseJSON

• Private get baseJSON(): Record<string, KismetVariableValue>

Returns

Record<string, KismetVariableValue>

Inherited from

BaseSequenceItem.baseJSON

Defined in

item/base.ts:115

---

category

• get category(): undefined | string

Returns

undefined | string

Inherited from

BaseSequenceItem.category

Defined in

item/base.ts:138

---

linkId

• get linkId(): string

Returns

string

Inherited from

BaseSequenceItem.linkId

Defined in

item/base.ts:146

---

position

• get position(): KismetPosition

Returns

KismetPosition

Inherited from

BaseSequenceItem.position

Defined in

item/base.ts:150

---

rawName

• get rawName(): string

Returns

string

Inherited from

BaseSequenceItem.rawName

Defined in

item/base.ts:133

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

BaseSequenceItem.breakAllLinks

Defined in

item/base.ts:162

---

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

BaseSequenceItem.equals

Defined in

item/base.ts:196

---

getConnection

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

Parameters

Name	Type
type	KismetConnectionType
connectionName?	string

Returns

null | BaseKismetConnection | KismetConnection

Inherited from

BaseSequenceItem.getConnection

Defined in

item/base.ts:200

---

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

BaseSequenceItem.hideUnusedConnections

Defined in

item/base.ts:173

---

isAction

▸ isAction(): this is SequenceAction

Returns

this is SequenceAction

Inherited from

BaseSequenceItem.isAction

Defined in

item/_base.ts:29

---

isCommentFrame

▸ isCommentFrame(): boolean

Returns

boolean

Defined in

structures/Comment.ts:49

---

isCondition

▸ isCondition(): this is SequenceCondition

Returns

this is SequenceCondition

Inherited from

BaseSequenceItem.isCondition

Defined in

item/_base.ts:33

---

isEvent

▸ isEvent(): this is SequenceEvent<Object>

Returns

this is SequenceEvent<Object>

Inherited from

BaseSequenceItem.isEvent

Defined in

item/_base.ts:37

---

isSequence

▸ isSequence(): this is Sequence

Returns

this is Sequence

Inherited from

BaseSequenceItem.isSequence

Defined in

item/_base.ts:41

---

isSequenceActionNode

▸ isSequenceActionNode(): this is SequenceAction | SequenceCondition

Returns

this is SequenceAction | SequenceCondition

Inherited from

BaseSequenceItem.isSequenceActionNode

Defined in

item/_base.ts:49

---

isSequenceItem

▸ isSequenceItem(): this is SequenceItemType

Returns

this is SequenceItemType

Inherited from

BaseSequenceItem.isSequenceItem

Defined in

item/_base.ts:45

---

isSequenceNode

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

Returns

this is SequenceAction | SequenceCondition | SequenceEvent<Object>

Inherited from

BaseSequenceItem.isSequenceNode

Defined in

item/_base.ts:53

---

isVariable

▸ isVariable(): this is SequenceVariable

Returns

this is SequenceVariable

Inherited from

BaseSequenceItem.isVariable

Defined in

item/_base.ts:60

---

setBorder

▸ setBorder(options?): Comment

Parameters

Name	Type
options?	Object
options.color?	KismetColor
options.width?	number

Returns

Comment

Defined in

structures/Comment.ts:53

---

setComment

▸ setComment(comment): Comment

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

Comment

Inherited from

BaseSequenceItem.setComment

Defined in

item/base.ts:216

---

setFilled

▸ setFilled(options?): Comment

Parameters

Name	Type
options?	Object
options.color?	KismetColor
options.material?	string
options.texture?	string
options.tileFill?	boolean

Returns

Comment

Defined in

structures/Comment.ts:69

---

setPosition

▸ setPosition(position, offset?): Comment

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

Comment

Inherited from

BaseSequenceItem.setPosition

Defined in

item/base.ts:244

---

setProperty

▸ setProperty(...properties): Comment

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

Comment

Inherited from

BaseSequenceItem.setProperty

Defined in

item/base.ts:258

---

setSequence

▸ setSequence(sequence, addToSequence?): Comment

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

Comment

Inherited from

BaseSequenceItem.setSequence

Defined in

item/base.ts:273

---

setSize

▸ setSize(size): Comment

Parameters

Name	Type
size	KismetPosition

Returns

Comment

Defined in

structures/Comment.ts:98

---

setStyle

▸ setStyle(style): Comment

Parameters

Name	Type
style	"default"

Returns

Comment

Defined in

structures/Comment.ts:104

---

showAllConnections

▸ showAllConnections(): void

Show all connection sockets.

Same as the editor right click > Show all connectors

Returns

void

Inherited from

BaseSequenceItem.showAllConnections

Defined in

item/base.ts:186

---

toJSON

▸ toJSON(): Record<string, KismetVariableValue>

Returns

Record<string, KismetVariableValue>

Overrides

BaseSequenceItem.toJSON

Defined in

structures/Comment.ts:131

---

toString

▸ toString(): string

Returns

string

Overrides

BaseSequenceItem.toString

Defined in

structures/Comment.ts:159

---

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

BaseSequenceItem.fromJSON

Defined in

item/base.ts:342

---

fromRaw

▸ Static fromRaw(input): BaseSequenceItem

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

Parameters

Name	Type
input	[string, KismetVariableValue][]

Returns

BaseSequenceItem

Inherited from

BaseSequenceItem.fromRaw

Defined in

item/base.ts:322