@kismet.ts/core / Exports / CommentFrame

Class: CommentFrame

Hierarchy

• 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 CommentFrame(comment?)

Parameters

Name	Type
comment?	string

Overrides

Comment.constructor

Defined in

structures/Comment.ts:169

Properties

borderColor

• borderColor: KismetColor

Inherited from

Comment.borderColor

Defined in

structures/Comment.ts:18

---

borderWidth

• borderWidth: number

Inherited from

Comment.borderWidth

Defined in

structures/Comment.ts:19

---

commentOptions

• commentOptions: KismetComment = {}

Inherited from

Comment.commentOptions

Defined in

item/base.ts:62

---

connections

• connections: KismetConnections

Inherited from

Comment.connections

Defined in

item/base.ts:64

---

drawBox

• drawBox: boolean

Inherited from

Comment.drawBox

Defined in

structures/Comment.ts:15

---

fillColor

• fillColor: KismetColor

Inherited from

Comment.fillColor

Defined in

structures/Comment.ts:20

---

fillMaterial

• fillMaterial: null | string

Inherited from

Comment.fillMaterial

Defined in

structures/Comment.ts:21

---

fillTexture

• fillTexture: null | string

Inherited from

Comment.fillTexture

Defined in

structures/Comment.ts:22

---

filled

• filled: boolean

Inherited from

Comment.filled

Defined in

structures/Comment.ts:16

---

id

• Readonly id: ProcessId

Inherited from

Comment.id

Defined in

item/base.ts:67

---

inputs

• Protected inputs: Object

Type declaration

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

Inherited from

Comment.inputs

Defined in

item/base.ts:75

---

name

• name: string

Inherited from

Comment.name

Defined in

item/base.ts:68

---

raw

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

Inherited from

Comment.raw

Defined in

item/base.ts:70

---

rawData

• rawData: BaseKismetItemRawData

Inherited from

Comment.rawData

Defined in

item/base.ts:71

---

sequence

• sequence: string

Inherited from

Comment.sequence

Defined in

item/base.ts:65

---

size

• size: Object

Type declaration

Name	Type
x	number
y	number

Inherited from

Comment.size

Defined in

structures/Comment.ts:14

---

tileFill

• tileFill: boolean

Inherited from

Comment.tileFill

Defined in

structures/Comment.ts:17

---

type

• Readonly type: null | SequenceItemTypeName

Inherited from

Comment.type

Defined in

item/_base.ts:19

Accessors

ClassData

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

Returns

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

Inherited from

Comment.ClassData

Defined in

item/base.ts:142

---

baseJSON

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

Returns

Record<string, KismetVariableValue>

Inherited from

Comment.baseJSON

Defined in

item/base.ts:115

---

category

• get category(): undefined | string

Returns

undefined | string

Inherited from

Comment.category

Defined in

item/base.ts:138

---

linkId

• get linkId(): string

Returns

string

Inherited from

Comment.linkId

Defined in

item/base.ts:146

---

position

• get position(): KismetPosition

Returns

KismetPosition

Inherited from

Comment.position

Defined in

item/base.ts:150

---

rawName

• get rawName(): string

Returns

string

Inherited from

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

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

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

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

Comment.hideUnusedConnections

Defined in

item/base.ts:173

---

isAction

▸ isAction(): this is SequenceAction

Returns

this is SequenceAction

Inherited from

Comment.isAction

Defined in

item/_base.ts:29

---

isCommentFrame

▸ isCommentFrame(): boolean

Returns

boolean

Inherited from

Comment.isCommentFrame

Defined in

structures/Comment.ts:49

---

isCondition

▸ isCondition(): this is SequenceCondition

Returns

this is SequenceCondition

Inherited from

Comment.isCondition

Defined in

item/_base.ts:33

---

isEvent

▸ isEvent(): this is SequenceEvent<Object>

Returns

this is SequenceEvent<Object>

Inherited from

Comment.isEvent

Defined in

item/_base.ts:37

---

isSequence

▸ isSequence(): this is Sequence

Returns

this is Sequence

Inherited from

Comment.isSequence

Defined in

item/_base.ts:41

---

isSequenceActionNode

▸ isSequenceActionNode(): this is SequenceAction | SequenceCondition

Returns

this is SequenceAction | SequenceCondition

Inherited from

Comment.isSequenceActionNode

Defined in

item/_base.ts:49

---

isSequenceItem

▸ isSequenceItem(): this is SequenceItemType

Returns

this is SequenceItemType

Inherited from

Comment.isSequenceItem

Defined in

item/_base.ts:45

---

isSequenceNode

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

Returns

this is SequenceAction | SequenceCondition | SequenceEvent<Object>

Inherited from

Comment.isSequenceNode

Defined in

item/_base.ts:53

---

isVariable

▸ isVariable(): this is SequenceVariable

Returns

this is SequenceVariable

Inherited from

Comment.isVariable

Defined in

item/_base.ts:60

---

setBorder

▸ setBorder(options?): CommentFrame

Parameters

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

Returns

CommentFrame

Inherited from

Comment.setBorder

Defined in

structures/Comment.ts:53

---

setComment

▸ setComment(comment): CommentFrame

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

CommentFrame

Inherited from

Comment.setComment

Defined in

item/base.ts:216

---

setFilled

▸ setFilled(options?): CommentFrame

Parameters

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

Returns

CommentFrame

Inherited from

Comment.setFilled

Defined in

structures/Comment.ts:69

---

setPosition

▸ setPosition(position, offset?): CommentFrame

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

CommentFrame

Inherited from

Comment.setPosition

Defined in

item/base.ts:244

---

setProperty

▸ setProperty(...properties): CommentFrame

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

CommentFrame

Inherited from

Comment.setProperty

Defined in

item/base.ts:258

---

setSequence

▸ setSequence(sequence, addToSequence?): CommentFrame

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

CommentFrame

Inherited from

Comment.setSequence

Defined in

item/base.ts:273

---

setSize

▸ setSize(size): CommentFrame

Parameters

Name	Type
size	KismetPosition

Returns

CommentFrame

Inherited from

Comment.setSize

Defined in

structures/Comment.ts:98

---

setStyle

▸ setStyle(style): CommentFrame

Parameters

Name	Type
style	"default"

Returns

CommentFrame

Inherited from

Comment.setStyle

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

Comment.showAllConnections

Defined in

item/base.ts:186

---

toJSON

▸ toJSON(): Record<string, KismetVariableValue>

Returns

Record<string, KismetVariableValue>

Inherited from

Comment.toJSON

Defined in

structures/Comment.ts:131

---

toString

▸ toString(): string

Returns

string

Inherited from

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

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

Comment.fromRaw

Defined in

item/base.ts:322