Class PrefabManager

Index

Constructors

Properties

Methods

beginCapturingMouseClicks clearSelectedInstances cloneTemplate createTemplate deleteInstance deleteTemplate deselectInstance endCapturingMouseClicks getTemplate getTemplateList selectInstance

Constructors

`Private`constructor

new PrefabManager(): PrefabManager
Returns PrefabManager

Properties

`Readonly`instanceInteractionEvents

instanceInteractionEvents: PrefabServiceInstanceInteractionEvent

Methods

beginCapturingMouseClicks

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

Throws
This function can throw errors.

PrefabServiceError

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

clearSelectedInstances

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

Throws
This function can throw errors.

PrefabServiceError

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

cloneTemplate

cloneTemplate(
    templateOrMetadataToClone: PrefabTemplate | PrefabTemplateMetadata,
    newName: string,
    optionalNewDisplayName?: string,
): PrefabTemplate
Parameters
- templateOrMetadataToClone: PrefabTemplate | PrefabTemplateMetadata
- newName: string
- OptionaloptionalNewDisplayName: string
Returns PrefabTemplate
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

Error

PrefabErrorInvalidName

PrefabErrorInvalidTemplate

PrefabServiceError

PrefabTemplateExists

PrefabTemplateNotFound

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

createTemplate

createTemplate(
name: string,
options?: PrefabServiceCreateTemplateOptions,
): PrefabTemplate
Parameters
- name: string
- Optionaloptions: PrefabServiceCreateTemplateOptions
Returns PrefabTemplate
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

Error

PrefabErrorInvalidName

PrefabErrorStringInvalidLength

PrefabServiceError

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

deleteInstance

deleteInstance(instance: PrefabTemplateInstance): void
Parameters
- instance: PrefabTemplateInstance
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

PrefabErrorInvalidInstance

PrefabServiceError

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

deleteTemplate

deleteTemplate(
templateOrMetadata: PrefabTemplate | PrefabTemplateMetadata,
): void
Parameters
- templateOrMetadata: PrefabTemplate | PrefabTemplateMetadata
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

PrefabErrorInvalidName

PrefabErrorInvalidTemplate

PrefabServiceError

PrefabTemplateNotFound

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

deselectInstance

deselectInstance(instance: PrefabTemplateInstance): void
Parameters
- instance: PrefabTemplateInstance
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

PrefabErrorInvalidInstance

PrefabServiceError

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

endCapturingMouseClicks

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

Throws
This function can throw errors.

PrefabServiceError

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

getTemplate

getTemplate(
searchMetadata_or_fullyQualifiedName: string | PrefabTemplateMetadata,
): PrefabTemplate
Parameters
- searchMetadata_or_fullyQualifiedName: string | PrefabTemplateMetadata
Returns PrefabTemplate
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

Error

PrefabErrorInvalidName

PrefabServiceError

PrefabTemplateNotFound

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

getTemplateList

getTemplateList(): PrefabTemplateMetadata[]
Returns PrefabTemplateMetadata[]
Throws
This function can throw errors.

PrefabServiceError

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

selectInstance

selectInstance(instance: PrefabTemplateInstance, append: boolean): void
Parameters
- instance: PrefabTemplateInstance
- append: boolean
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

PrefabErrorInvalidInstance

PrefabServiceError

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

Class PrefabManager

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns PrefabManager

Properties

ReadonlyinstanceInteractionEvents

Methods

beginCapturingMouseClicks

Returns void

Remarks

Write Privilege

Throws

World Ready

clearSelectedInstances

Returns void

Remarks

Write Privilege

Throws

World Ready

cloneTemplate

Parameters

Returns PrefabTemplate

Remarks

Write Privilege

Throws

World Ready

createTemplate

Parameters

Returns PrefabTemplate

Remarks

Write Privilege

Throws

World Ready

deleteInstance

Parameters

Returns void

Remarks

Write Privilege

Throws

World Ready

deleteTemplate

Parameters

Returns void

Remarks

Write Privilege

Throws

World Ready

deselectInstance

Parameters

Returns void

Remarks

Write Privilege

Throws

World Ready

endCapturingMouseClicks

Returns void

Remarks

Write Privilege

Throws

World Ready

getTemplate

Parameters

Returns PrefabTemplate

Remarks

Write Privilege

Throws

World Ready

getTemplateList

Returns PrefabTemplateMetadata[]

Throws

World Ready

selectInstance

Parameters

Returns void

Remarks

Write Privilege

`Private`constructor

`Readonly`instanceInteractionEvents