@rbxts/a-plant-generator - v0.2.0
    Preparing search index...

    Interface StreamingPlantRenderHandle

    Incremental renderer handle.

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

    Hierarchy (View Summary)

    Index
    cancel destroy getStatistics isComplete setGrowth setLod setTime step updateMaterialTag updateTransform

    • Reports whether streaming finished or was cancelled.

      Returns boolean

    • Creates at most the requested number of remaining Instances.

      Parameters

      • maximumInstances: number

      Returns number

    • Replaces material styling for instances with a matching semantic tag.

      Parameters

      • tag: string
      • material: Material
      • Optionalcolor: Color3

      Returns void

    Settings
    Member Visibility

    On This Page
    Methods