Interface PlantRenderHandle

Renderer handle owns every created resource and supports deterministic cleanup.

interface PlantRenderHandle {
    cancel(): void;
    destroy(): void;
    getStatistics(): Readonly<Record<string, number>>;
    setGrowth(growth: number): void;
    setLod(level: LodLevel): void;
    setTime(time: number): void;
    updateMaterialTag(tag: string, material: Material, color?: Color3): void;
    updateTransform(transform: CFrame): void;
}

Hierarchy (View Summary)

PlantRenderHandle
- StreamingPlantRenderHandle

Index

Methods

cancel destroy getStatistics setGrowth setLod setTime updateMaterialTag updateTransform

Methods

cancel

cancel(): void
Stops pending streaming work without destroying existing output.

Returns void
- Defined in roblox/renderer.ts:20

destroy

destroy(): void
Releases all Instances and adapter-owned resources.

Returns void
- Defined in roblox/renderer.ts:22

getStatistics

getStatistics(): Readonly<Record<string, number>>
Returns adapter-specific counters for diagnostics and profiling.

Returns Readonly<Record<string, number>>
- Defined in roblox/renderer.ts:18

setGrowth

setGrowth(growth: number): void
Applies raw normalized developmental time to structural and organ growth.
Parameters
- growth: number
Returns void
- Defined in roblox/renderer.ts:8

setLod

setLod(level: LodLevel): void
Changes the active level-of-detail policy result.
Parameters
- level: LodLevel
Returns void
- Defined in roblox/renderer.ts:12

setTime

setTime(time: number): void
Applies an absolute or renderer-defined timeline time.
Parameters
- time: number
Returns void
- Defined in roblox/renderer.ts:10

updateMaterialTag

updateMaterialTag(tag: string, material: Material, color?: Color3): void
Replaces material styling for instances with a matching semantic tag.
Parameters
- tag: string
- material: Material
- Optionalcolor: Color3
Returns void
- Defined in roblox/renderer.ts:16

updateTransform

updateTransform(transform: CFrame): void
Moves the owned render root without regenerating topology.
Parameters
- transform: CFrame
Returns void
- Defined in roblox/renderer.ts:14