@kismet.ts/parsers-node / Exports / LocalClassesParser
Class: LocalClassesParser
Table of contents
Constructors
Properties
Methods
- createLocalClasses
- resolvePath
- setBlenderOptions
- setClassPackages
- setDebugOptions
- setExportOptions
- setExportPath
- setImportPath
- validatePath
- validatePaths
Constructors
constructor
• new LocalClassesParser(options)
Parameters
| Name | Type |
|---|---|
options | LocalClassesCreateOptions |
Defined in
classes/extractor/parser.ts:15
Properties
options
• options: LocalClassesCreateOptions
Defined in
classes/extractor/parser.ts:13
Methods
createLocalClasses
▸ createLocalClasses(): Promise<void>
Create / update custom class files with the set options
Returns
Promise<void>
Defined in
classes/extractor/parser.ts:42
resolvePath
▸ resolvePath(path): undefined | string
Parameters
| Name | Type |
|---|---|
path | string |
Returns
undefined | string
Defined in
classes/extractor/parser.ts:33
setBlenderOptions
▸ setBlenderOptions(options): LocalClassesParser
Customize the generated addon for kismet nodes in Blender
Parameters
| Name | Type | Description |
|---|---|---|
options | BlenderAddonGeneratorOptions | The blender addon creator options |
Returns
Defined in
classes/extractor/parser.ts:52
setClassPackages
▸ setClassPackages(names): LocalClassesParser
Only include classes from the packages. If no packages are set, all packages will be read.
Parameters
| Name | Type | Description |
|---|---|---|
names | string[] | The names of the class packages (without file extension) |
Returns
Defined in
classes/extractor/parser.ts:123
setDebugOptions
▸ setDebugOptions(enabled): LocalClassesParser
Enable debugging while the classes are read
Parameters
| Name | Type |
|---|---|
enabled | boolean |
Returns
Defined in
classes/extractor/parser.ts:67
setExportOptions
▸ setExportOptions(options?): LocalClassesParser
Set all export options for extracting the custom classes
Parameters
| Name | Type |
|---|---|
options? | LocalClassesCreateOptions |
Returns
Defined in
classes/extractor/parser.ts:77
setExportPath
▸ setExportPath(path, options?): LocalClassesParser
Set the export path which will hold the exported classes and more
Parameters
| Name | Type | Description |
|---|---|---|
path | string | The absolute (or relative) path to the export folder |
options? | PathCreateOptions | Path options: - check: whether to check if the path is valid |
Returns
Defined in
classes/extractor/parser.ts:108
setImportPath
▸ setImportPath(path, options?): LocalClassesParser
Set the import path of the directory that holds the JSON files with information about the custom classes.
Parameters
| Name | Type | Description |
|---|---|---|
path | string | The absolute path of the folder |
options? | PathCreateOptions | - |
Returns
Defined in
classes/extractor/parser.ts:91
validatePath
▸ Protected validatePath(path, options?): void
Parameters
| Name | Type |
|---|---|
path | undefined | null | string |
options? | Object |
options.onlyAbsolute? | boolean |
Returns
void
Defined in
classes/extractor/parser.ts:19
validatePaths
▸ validatePaths(): void
Returns
void