react-native-mobilex 开发文档
    Preparing search index...

    Type Alias IParticleLayers

    粒子特效图层

    存放粒子特效对象，可以添加，删除，修改

    type IParticleLayers = {
        addParticleLayer: (name: string) => Promise<boolean>;
        clearParticleLayer: (name: string) => Promise<boolean>;
        getAllCount: () => number;
        getAvailableName: (layerName: string, name: string) => string;
        getParticle: (layerName: string, id: string) => IParticle | undefined;
        getParticleCount: (layerName: string) => number;
        getParticleLayerNames: () => string[];
        isParticleLayerVisible: (name: string) => boolean;
        layerAddParticle: (
            name: string,
            particleName: string,
            particleUrl: string,
            param?: Partial<IParticleParam>,
        ) => Promise<string>;
        layerModifyParticle: (
            name: string,
            particleId: string,
            param: Partial<IParticleParam>,
        ) => Promise<boolean>;
        layerParticles: (
            name: string,
            range?: { end?: number; start?: number },
        ) => IParticle[];
        layerRemoveParticle: (name: string, particleId: string) => Promise<boolean>;
        removeAllParticleLayers: () => Promise<boolean>;
        removeParticleLayer: (name: string) => Promise<boolean>;
        renameParticleLayer: (oldName: string, newName: string) => Promise<boolean>;
        setParticleLayerVisible: (
            name: string,
            isVisible: boolean,
        ) => Promise<void>;
    }
    Index

    Properties

    addParticleLayer clearParticleLayer getAllCount getAvailableName getParticle getParticleCount getParticleLayerNames isParticleLayerVisible layerAddParticle layerModifyParticle layerParticles layerRemoveParticle removeAllParticleLayers removeParticleLayer renameParticleLayer setParticleLayerVisible

    Properties

    addParticleLayer: (name: string) => Promise<boolean>

    添加图层（已有同名图层添加失败）

    Type declaration

      • (name: string): Promise<boolean>

      • Parameters

        • name: string

          图层名

        Returns Promise<boolean>

        成功/失败

    clearParticleLayer: (name: string) => Promise<boolean>

    清空图层

    Type declaration

      • (name: string): Promise<boolean>

      • Parameters

        • name: string

          图层名

        Returns Promise<boolean>

        成功/失败

    getAllCount: () => number

    获取所有对象个数

    Type declaration

      • (): number

      • Returns number

        场景中所有粒子特效对象数量

    getAvailableName: (layerName: string, name: string) => string

    获取指定图层中可用粒子特效名称

    Type declaration

      • (layerName: string, name: string): string

      • Parameters

        • layerName: string

          图层名

        • name: string

          名称

        Returns string

        可用名称

    getParticle: (layerName: string, id: string) => IParticle | undefined

    获取指定指定的粒子特效对象

    Type declaration

      • (layerName: string, id: string): IParticle | undefined

      • Parameters

        • layerName: string

          图层名

        • id: string

          粒子特效对象id

        Returns IParticle | undefined

        粒子特效对象

    getParticleCount: (layerName: string) => number

    获取图层对象个数

    Type declaration

      • (layerName: string): number

      • Parameters

        • layerName: string

          图层名

        Returns number

        图层中对象个数

    getParticleLayerNames: () => string[]

    获取所有粒子图层名

    Type declaration

      • (): string[]

      • Returns string[]

        图层名数组

    isParticleLayerVisible: (name: string) => boolean

    图层是否可见

    Type declaration

      • (name: string): boolean

      • Parameters

        • name: string

          图层名

        Returns boolean

        成功/失败

    layerAddParticle: (
        name: string,
        particleName: string,
        particleUrl: string,
        param?: Partial<IParticleParam>,
    ) => Promise<string>

    图层添加粒子对象

    Type declaration

      • (
            name: string,
            particleName: string,
            particleUrl: string,
            param?: Partial<IParticleParam>,
        ): Promise<string>

      • Parameters

        • name: string

          图层名

        • particleName: string

          粒子id

        • particleUrl: string

          json路径

        • Optionalparam: Partial<IParticleParam>

          参数

        Returns Promise<string>

        粒子对象id

    layerModifyParticle: (
        name: string,
        particleId: string,
        param: Partial<IParticleParam>,
    ) => Promise<boolean>

    更新图层粒子对象

    Type declaration

      • (
            name: string,
            particleId: string,
            param: Partial<IParticleParam>,
        ): Promise<boolean>

      • Parameters

        • name: string

          图层名

        • particleId: string

          粒子id

        • param: Partial<IParticleParam>

          参数

        Returns Promise<boolean>

        成功/失败

    layerParticles: (
        name: string,
        range?: { end?: number; start?: number },
    ) => IParticle[]

    获取图层所有粒子对象

    Type declaration

      • (name: string, range?: { end?: number; start?: number }): IParticle[]

      • Parameters

        • name: string

          图层名

        • Optionalrange: { end?: number; start?: number }

          范围

        Returns IParticle[]

        粒子对象数组

    layerRemoveParticle: (name: string, particleId: string) => Promise<boolean>

    图层删除粒子对象

    Type declaration

      • (name: string, particleId: string): Promise<boolean>

      • Parameters

        • name: string

          图层名

        • particleId: string

          粒子id

        Returns Promise<boolean>

        成功/失败

    removeAllParticleLayers: () => Promise<boolean>

    删除所有图层

    Type declaration

      • (): Promise<boolean>

      • Returns Promise<boolean>

        成功/失败

    removeParticleLayer: (name: string) => Promise<boolean>

    删除图层

    Type declaration

      • (name: string): Promise<boolean>

      • Parameters

        • name: string

          图层名

        Returns Promise<boolean>

        成功/失败

    renameParticleLayer: (oldName: string, newName: string) => Promise<boolean>

    重命名

    Type declaration

      • (oldName: string, newName: string): Promise<boolean>

      • Parameters

        • oldName: string

          原图层名

        • newName: string

          新图层名

        Returns Promise<boolean>

        成功/失败

    setParticleLayerVisible: (name: string, isVisible: boolean) => Promise<void>

    设置图层是否可见

    Type declaration

      • (name: string, isVisible: boolean): Promise<void>

      • Parameters

        • name: string

          图层名

        • isVisible: boolean

          是否可见

        Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties