@kismet.ts/core / Exports / KismetFile

Class: KismetFile

Table of contents

Constructors

• constructor

Properties

• id
• layout
• mainSequence
• projectName
• streamedLevels

Methods

• debug
• debugSequences
• search
• toString
• debug
• listItems

Constructors

constructor

• new KismetFile(options)

Parameters

Name	Type
options	projectOptions<SchemaItemNames>

Defined in

project.ts:46

Properties

id

• Readonly id: ProcessId

Defined in

project.ts:23

---

layout

• Optional layout: SequencePositionOptions<SchemaItemNames>

Layout options for positioning kismet nodes

Defined in

project.ts:39

---

mainSequence

• mainSequence: Sequence

The main sequence that is attached to this project

Defined in

project.ts:28

---

projectName

• projectName: string

The name of the kismet project. Can be found as the .udk name / map name.

Defined in

project.ts:34

---

streamedLevels

• Optional streamedLevels: KismetFile[]

The sequences of streamed levels in this project that will be connected to this file.

Defined in

project.ts:44

Methods

debug

▸ debug(input): void

Log text to the console if the 'debug' option in this project is enabled

Parameters

Name	Type
input	string

Returns

void

Defined in

project.ts:130

---

debugSequences

▸ Private debugSequences(): void

Returns

void

Defined in

project.ts:134

---

search

▸ Private search(input, type, scope): void

Parameters

Name	Type
input	string
type	string
scope	"sequence" | "level" | "all"

Returns

void

Defined in

project.ts:140

---

toString

▸ toString(): string

Returns

string

Defined in

project.ts:149

---

debug

▸ Static debug(input, project): boolean

Log data in a project to the console

Parameters

Name	Type
input	string
project	KismetFile

Returns

boolean

if the input was logged

Defined in

project.ts:122

---

listItems

▸ Static listItems<T>(input): SequenceItemTypeof[]

Convert nodes to an array of items

See

KismetFile.listDefaultItems to list the default items

Example

const items = KismetFile.listItems({
 Actions: {
     MyAction
 }
}) // [MyAction]

Example

const items = KismetFile.listItems({
 Actions: {
     MyAction,
     MyCategory: {
         TestAction
     }
 }
}) // [MyAction]

Type parameters

Name	Type
T	extends SequenceItemTypeof

Parameters

Name	Type	Description
input	Partial<Record<"Actions" | "Conditions" | "Events" | "Variables", IStore<SequenceItemTypeof>>>	An object that holds the custom items

Returns

SequenceItemTypeof[]

The converted array of items

Defined in

project.ts:83