Class JigsawService

Index

Constructors

Methods

generateJigsaw getEmptyRegistryFiles getExportLocation getJigsawBlockData getRegistryData getRegistryList setJigsawBlockData setRegistryData

Constructors

`Private`constructor

new JigsawService(): JigsawService
Returns JigsawService

Methods

generateJigsaw

generateJigsaw(
    registryName: string,
    startingPool: string,
    startTarget: string,
    seed: Vector3,
    depth: number,
    maxHorizontalDistanceFromCenter: number,
    validateRegistry: boolean,
    clipboardItem: ClipboardItem,
): Promise<EditorJigsawSection[]>
Parameters
- registryName: string
- startingPool: string
- startTarget: string
- seed: Vector3
- depth: number
- maxHorizontalDistanceFromCenter: number
- validateRegistry: boolean
- clipboardItem: ClipboardItem
Returns Promise<EditorJigsawSection[]>
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

getEmptyRegistryFiles

getEmptyRegistryFiles(): Record<string, string>
Returns Record<string, string>
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

getExportLocation

getExportLocation(): string
Returns string
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

getJigsawBlockData

getJigsawBlockData(pos: Vector3): JigsawBlockData
Parameters
- pos: Vector3
Returns JigsawBlockData
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

getRegistryData

getRegistryData(registryName: string): Record<string, EditorRegistryFile[]>
Parameters
- registryName: string
Returns Record<string, EditorRegistryFile[]>
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

getRegistryList

getRegistryList(): string[]
Returns string[]
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

setJigsawBlockData

setJigsawBlockData(pos: Vector3, jigsawData: JigsawBlockData): void
Parameters
- pos: Vector3
- jigsawData: JigsawBlockData
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

setRegistryData

setRegistryData(
    registryName: string,
    processorData: EditorRegistryFile[],
    structureData: EditorRegistryFile[],
    structureSetData: EditorRegistryFile[],
    templatePoolData: EditorRegistryFile[],
): Promise<string[]>
Parameters
- registryName: string
- processorData: EditorRegistryFile[]
- structureData: EditorRegistryFile[]
- structureSetData: EditorRegistryFile[]
- templatePoolData: EditorRegistryFile[]
Returns Promise<string[]>
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

Class JigsawService

Index

Constructors

Methods

Constructors

Privateconstructor

Returns JigsawService

Methods

generateJigsaw

Parameters

Returns Promise<EditorJigsawSection[]>

Remarks

Write Privilege

Throws

World Ready

getEmptyRegistryFiles

Returns Record<string, string>

Remarks

Write Privilege

World Ready

getExportLocation

Returns string

Remarks

Write Privilege

World Ready

getJigsawBlockData

Parameters

Returns JigsawBlockData

Remarks

Write Privilege

World Ready

getRegistryData

Parameters

Returns Record<string, EditorRegistryFile[]>

Remarks

Write Privilege

World Ready

getRegistryList

Returns string[]

Remarks

Write Privilege

World Ready

setJigsawBlockData

Parameters

Returns void

Remarks

Write Privilege

World Ready

setRegistryData

Parameters

Returns Promise<string[]>

Remarks

Write Privilege

Throws

World Ready

Settings

On This Page

`Private`constructor