Hilo3d API - v2.0.0-alpha.4
    Preparing search index...

    Interface ParticleSystemParameters

    Construction parameters for a runtime particle scene node.

    interface ParticleSystemParameters {
        anim?: Animation | null;
        animationId?: string;
        autoPlay?: boolean;
        autoUpdateChildWorldMatrix?: boolean;
        autoUpdateWorldMatrix?: boolean;
        budgetId?: string;
        budgetPriority?: number;
        compilationEnvironment?: Readonly<ParticleCompilationEnvironment>;
        definition: ParticleSystemDefinition;
        eventReadbackCapacity?: number;
        jointName?: string;
        layer?: number;
        name?: string;
        needCallChildUpdate?: boolean;
        onlySyncQuaternion?: boolean;
        onUpdate?: ((deltaTime: number) => void) | null;
        parameters?: ParticleParameterSet;
        parent?: Node | null;
        pivotX?: number;
        pivotY?: number;
        pivotZ?: number;
        pointerChildren?: boolean;
        pointerEnabled?: boolean;
        rotationX?: number;
        rotationY?: number;
        rotationZ?: number;
        scaleX?: number;
        scaleY?: number;
        scaleZ?: number;
        seed?: number;
        sortingLayer?: number;
        timeScale?: number;
        up?: Vector3;
        useHandCursor?: boolean;
        userData?: unknown;
        visible?: boolean;
        x?: number;
        y?: number;
        z?: number;
        zIndex?: number;
    }

    Hierarchy (View Summary)

    Index
    anim? animationId? autoPlay? autoUpdateChildWorldMatrix? autoUpdateWorldMatrix? budgetId? budgetPriority? compilationEnvironment? definition eventReadbackCapacity? jointName? layer? name? needCallChildUpdate? onlySyncQuaternion? onUpdate? parameters? parent? pivotX? pivotY? pivotZ? pointerChildren? pointerEnabled? rotationX? rotationY? rotationZ? scaleX? scaleY? scaleZ? seed? sortingLayer? timeScale? up? useHandCursor? userData? visible? x? y? z? zIndex?
    anim?: Animation | null
    animationId?: string
    autoPlay?: boolean
    autoUpdateChildWorldMatrix?: boolean
    autoUpdateWorldMatrix?: boolean
    budgetId?: string

    Stable identifier used by deterministic frame-wide particle budgeting.

    budgetPriority?: number

    Higher values win budget allocation before distance and identifier tie-breaks.

    compilationEnvironment?: Readonly<ParticleCompilationEnvironment>

    Optional compile target. Omit for a portable CPU-first plan.

    definition: ParticleSystemDefinition
    eventReadbackCapacity?: number

    Maximum materialized CPU events retained for bounded asynchronous application reads.

    jointName?: string
    layer?: number

    Scene-layer bit mask. A node is renderable when at least one bit overlaps the active camera's visibility mask.

    name?: string
    needCallChildUpdate?: boolean
    onlySyncQuaternion?: boolean
    onUpdate?: ((deltaTime: number) => void) | null
    parameters?: ParticleParameterSet

    Live typed values used by bindable emission and initialization fields.

    parent?: Node | null
    pivotX?: number
    pivotY?: number
    pivotZ?: number
    pointerChildren?: boolean
    pointerEnabled?: boolean
    rotationX?: number
    rotationY?: number
    rotationZ?: number
    scaleX?: number
    scaleY?: number
    scaleZ?: number
    seed?: number
    sortingLayer?: number

    Coarse 2D display layer. Higher values render later.

    This is independent from layer, which is a camera-visibility bit mask.

    timeScale?: number
    up?: Vector3
    useHandCursor?: boolean
    userData?: unknown
    visible?: boolean
    x?: number
    y?: number
    z?: number
    zIndex?: number

    Fine 2D display order within sortingLayer. Higher values render later.

    Settings
    Member Visibility

    On This Page
    Properties