@kismet.ts/parsers-node / Exports

@kismet.ts/parsers-node

Table of contents

Classes

• KismetClassTree
• LocalClassesParser

Interfaces

• BaseClassTreeVariable
• ClassFileCreateOptions
• ExportOptions
• IStoreCompareResult
• JsonFile
• KismetClassTreeFillOptions
• KismetClassTreeItem
• PathCreateOptions
• PathInput
• PathReadError
• RawUnrealJsonConstant
• RawUnrealJsonEnum
• RawUnrealJsonFile
• RawUnrealJsonStructure
• RawUnrealJsonVariable
• StaticChildClassTreeVariable
• StaticParentClassTreeVariable
• TreeLogCreateOptions
• UnrealJsonReadFile

Type Aliases

• ClassVersionOption
• LocalClassesCreateOptions
• RawUnrealJsonDefaultVariables
• StaticClassTreeVariable
• UnrealJsonReadFileNode

Variables

• defaultClassParserOptions

Functions

• compareStores
• createClassFile
• createClassFileData
• createDefaultArchetype
• createLocalClasses
• createRecursiveTree
• createTreeLog
• getSuperClasses
• isPlaceableClass
• nodeToJSON
• readNodeFile
• readObjInstanceVersions

Type Aliases

ClassVersionOption

Ƭ ClassVersionOption: number | { [T in UnrealJsonReadFile["type"]]?: number } | undefined

Defined in

classes/utils/write.ts:27

---

LocalClassesCreateOptions

Ƭ LocalClassesCreateOptions: PathInput & ExportOptions & { cb?: (nodes: Partial<UnrealJsonReadFile>[]) => void }

Defined in

classes/extractor/files.ts:39

---

RawUnrealJsonDefaultVariables

Ƭ RawUnrealJsonDefaultVariables: RawUnrealJsonConstant

Defined in

classes/extractor/files.ts:58

---

StaticClassTreeVariable

Ƭ StaticClassTreeVariable: StaticParentClassTreeVariable | StaticChildClassTreeVariable

Defined in

classes/misc/tree.ts:21

---

UnrealJsonReadFileNode

Ƭ UnrealJsonReadFileNode: Omit<UnrealJsonReadFile, "links" | "staticProperties"> & { displayName?: string ; links: Record<KismetConnectionType, { expectedType?: string ; isOutput?: boolean ; name: string }[]> }

Defined in

classes/extractor/files.ts:111

Variables

defaultClassParserOptions

• Const defaultClassParserOptions: Required<ExportOptions>

Defined in

classes/utils/options.ts:3

Functions

compareStores

▸ compareStores(first, compare): IStoreCompareResult

Parameters

Name	Type
first	IStore<SequenceItemTypeof>
compare	string[]

Returns

IStoreCompareResult

Defined in

classes/misc/store.ts:8

---

createClassFile

▸ createClassFile(item, options): string | null

Parameters

Name	Type
item	BaseSequenceItem
options	ClassFileCreateOptions

Returns

string | null

Defined in

classes/misc/item.ts:25

---

createClassFileData

▸ createClassFileData(item, options?): UnrealJsonReadFile

Parameters

Name	Type
item	SequenceItemType
options?	Partial<ClassFileCreateOptions>

Returns

UnrealJsonReadFile

Defined in

classes/misc/item.ts:31

---

createDefaultArchetype

▸ createDefaultArchetype(options): string

Parameters

Name	Type
options	BaseSequenceItem | { Class: string ; Package: string }

Returns

string

Defined in

classes/misc/item.ts:7

---

createLocalClasses

▸ createLocalClasses(inputOptions): Promise<true | undefined>

Parameters

Name	Type
inputOptions	LocalClassesCreateOptions

Returns

Promise<true | undefined>

Defined in

classes/extractor/parser-function.ts:10

---

createRecursiveTree

▸ createRecursiveTree(nodes, options): RecursiveTree & { classes: RecursiveTree[] }

Parameters

Name	Type
nodes	Classes[]
options	Object
options.className	string
options.max	number

Returns

RecursiveTree & { classes: RecursiveTree[] }

Defined in

explorer/nested.ts:157

---

createTreeLog

▸ createTreeLog(options): void

Parameters

Name	Type
options	TreeLogCreateOptions

Returns

void

Defined in

explorer/index.ts:10

---

getSuperClasses

▸ getSuperClasses(name, items): string[]

Parameters

Name	Type
name	string
items	(UnrealJsonReadFileNode | Partial<UnrealJsonReadFile> | RawUnrealJsonFile)[]

Returns

string[]

Defined in

classes/utils/ClassManager.ts:96

---

isPlaceableClass

▸ isPlaceableClass(name, items): boolean

Parameters

Name	Type
name	string
items	Partial<UnrealJsonReadFile>[]

Returns

boolean

Defined in

classes/utils/ClassManager.ts:122

---

nodeToJSON

▸ nodeToJSON(node, skipLinks?): UnrealJsonReadFileNode

Parameters

Name	Type	Default value
node	UnrealJsonReadFile	undefined
skipLinks	boolean	false

Returns

UnrealJsonReadFileNode

Defined in

classes/extractor/read.ts:63

---

readNodeFile

▸ readNodeFile(json, Package): UnrealJsonReadFile

Parameters

Name	Type
json	RawUnrealJsonFile
Package	string

Returns

UnrealJsonReadFile

Defined in

classes/extractor/read.ts:19

---

readObjInstanceVersions

▸ readObjInstanceVersions(path): { Class: undefined | string ; version: number }[]

Parameters

Name	Type
path	string

Returns

{ Class: undefined | string ; version: number }[]

Defined in

versions/read.ts:4