@kismet.ts/core / Exports / BaseSequenceItem
Class: BaseSequenceItem
Hierarchy
↳
BaseSequenceItem↳↳
SequenceNode↳↳
Comment
Table of contents
Constructors
Properties
Accessors
Methods
- breakAllLinks
- equals
- getConnection
- hideUnusedConnections
- isAction
- isCondition
- isEvent
- isSequence
- isSequenceActionNode
- isSequenceItem
- isSequenceNode
- isVariable
- setComment
- setPosition
- setProperty
- setSequence
- showAllConnections
- toJSON
- toString
- fromJSON
- fromRaw
Constructors
constructor
• new BaseSequenceItem(options)
Parameters
| Name | Type |
|---|---|
options | BaseKismetItemOptions & { type?: SequenceItemTypeName } |
Overrides
Defined in
Properties
_category
• Private _category: undefined | string = undefined
Defined in
_connectionKeys
• Private _connectionKeys: keyof KismetConnections[]
Defined in
commentOptions
• commentOptions: KismetComment = {}
Defined in
connections
• connections: KismetConnections
Defined in
id
• Readonly id: ProcessId
Defined in
inputs
• Protected inputs: Object
Type declaration
| Name | Type |
|---|---|
input? | string[] |
output? | string[] |
variable? | string[] |
Defined in
name
• name: string
Defined in
raw
• raw: [string, KismetVariableValue][] = []
Defined in
rawData
• rawData: BaseKismetItemRawData
Defined in
sequence
• sequence: string
Defined in
type
• Readonly type: null | SequenceItemTypeName
Inherited from
Defined in
Accessors
ClassData
• get ClassData(): Record<"Class" | "ClassType" | "Package", string>
Returns
Record<"Class" | "ClassType" | "Package", string>
Defined in
baseJSON
• Private get baseJSON(): Record<string, KismetVariableValue>
Returns
Record<string, KismetVariableValue>
Defined in
category
• get category(): undefined | string
Returns
undefined | string
Defined in
linkId
• get linkId(): string
Returns
string
Defined in
position
• get position(): KismetPosition
Returns
Defined in
rawName
• get rawName(): string
Returns
string
Defined in
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
Defined in
equals
▸ equals(item): boolean
Check whether another item is of the same type as this item
Parameters
| Name | Type |
|---|---|
item | SequenceItemType |
Returns
boolean
Defined in
getConnection
▸ getConnection(type, connectionName?): null | BaseKismetConnection | KismetConnection
Parameters
| Name | Type |
|---|---|
type | KismetConnectionType |
connectionName? | string |
Returns
null | BaseKismetConnection | KismetConnection
Defined in
hideUnusedConnections
▸ hideUnusedConnections(): void
Hide all connection sockets that have no connections currently.
Same as the editor right click > Hide unused connectors
Returns
void
Defined in
isAction
▸ isAction(): this is SequenceAction
Returns
this is SequenceAction
Inherited from
Defined in
isCondition
▸ isCondition(): this is SequenceCondition
Returns
this is SequenceCondition
Inherited from
Defined in
isEvent
▸ isEvent(): this is SequenceEvent<Object>
Returns
this is SequenceEvent<Object>
Inherited from
Defined in
isSequence
▸ isSequence(): this is Sequence
Returns
this is Sequence
Inherited from
Defined in
isSequenceActionNode
▸ isSequenceActionNode(): this is SequenceAction | SequenceCondition
Returns
this is SequenceAction | SequenceCondition
Inherited from
Defined in
isSequenceItem
▸ isSequenceItem(): this is SequenceItemType
Returns
this is SequenceItemType
Inherited from
Defined in
isSequenceNode
▸ isSequenceNode(): this is SequenceAction | SequenceCondition | SequenceEvent<Object>
Returns
this is SequenceAction | SequenceCondition | SequenceEvent<Object>
Inherited from
Defined in
isVariable
▸ isVariable(): this is SequenceVariable
Returns
this is SequenceVariable
Inherited from
Defined in
setComment
▸ setComment(comment): BaseSequenceItem
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
Defined in
setPosition
▸ setPosition(position, offset?): BaseSequenceItem
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
Defined in
setProperty
▸ setProperty(...properties): BaseSequenceItem
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
Defined in
setSequence
▸ setSequence(sequence, addToSequence?): BaseSequenceItem
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
Defined in
showAllConnections
▸ showAllConnections(): void
Show all connection sockets.
Same as the editor right click > Show all connectors
Returns
void
Defined in
toJSON
▸ toJSON(): Record<string, KismetVariableValue>
Returns
Record<string, KismetVariableValue>
Defined in
toString
▸ toString(): string
Returns
string
Defined in
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
Defined in
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][] |