Class PrefabTemplate

Index

Constructors

Properties

description displayName instanceCount name notes source

Methods

addStructure createInstance getMetadata getTags getTemplateStructures removeStructure setName setTags

Constructors

`Private`constructor

new PrefabTemplate(): PrefabTemplate
Returns PrefabTemplate

Properties

description

description: string

Remarks

Write Privilege

This property can't be edited in read-only mode.

World Ready

This property can't be read in early-execution mode.

displayName

displayName: string

Remarks

Write Privilege

This property can't be edited in read-only mode.

World Ready

This property can't be read in early-execution mode.

`Readonly`instanceCount

instanceCount: number

Throws

This property can throw errors.

PrefabErrorInvalidTemplate

PrefabServiceError

World Ready

This property can't be read in early-execution mode.

`Readonly`name

name: string

Throws

This property can throw errors.

PrefabErrorInvalidTemplate

World Ready

This property can't be read in early-execution mode.

notes

notes: string

Remarks

Write Privilege

This property can't be edited in read-only mode.

World Ready

This property can't be read in early-execution mode.

`Readonly`source

source: PrefabSource

Throws

This property can throw errors.

PrefabErrorInvalidTemplate

World Ready

This property can't be read in early-execution mode.

Methods

addStructure

addStructure(
structure: EditorStructure,
options?: PrefabTemplateAddStructureOptions,
): PrefabTemplateStructure
Parameters
- structure: EditorStructure
- Optionaloptions: PrefabTemplateAddStructureOptions
Returns PrefabTemplateStructure
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

Error

PrefabErrorInvalidStructure

PrefabErrorInvalidTemplate

PrefabErrorValueOutOfBounds

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

createInstance

createInstance(
location: Vector3,
options?: PrefabTemplateCreateInstanceOptions,
): PrefabTemplateInstance
Parameters
- location: Vector3
- Optionaloptions: PrefabTemplateCreateInstanceOptions
Returns PrefabTemplateInstance
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

Error

PrefabErrorInvalidInstance

PrefabErrorInvalidTemplate

PrefabServiceError

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

getMetadata

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

Throws
This function can throw errors.

PrefabErrorInvalidTemplate

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

getTags

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

Throws
This function can throw errors.

PrefabErrorInvalidTemplate

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

getTemplateStructures

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

Throws
This function can throw errors.

Error

PrefabErrorInvalidTemplate

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

removeStructure

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

Throws
This function can throw errors.

PrefabErrorInvalidTemplate

PrefabErrorInvalidTemplateStructure

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

setName

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

Throws
This function can throw errors.

PrefabErrorInvalidName

PrefabErrorInvalidTemplate

PrefabServiceError

PrefabTemplateExists

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

setTags

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

Throws
This function can throw errors.

PrefabErrorInvalidTemplate

PrefabErrorStringInvalidLength

PrefabServiceError

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