Class Preload

预加载模块

Hierarchy (view full)

Constructors

constructor

Properties

concurrence config? needActorPrecreate needEnginePreload poorNetJudge topics

Accessors

isSupportPack

Methods

dispose getPreloadType initConfig off on onGetPreloadType once setIndexDb setMainRoleLists setPreCreateActorConfigs setPrecreateClasses start stop

Constructors

constructor

Properties

concurrence

concurrence: number = 6

并发请求数

Optional config

config?: IPreloadConfig

needActorPrecreate

needActorPrecreate: boolean = false

资产预创建,由业务指定打开

needEnginePreload

needEnginePreload: boolean = true

引擎预加载, 默认为true，即处于开启状态

poorNetJudge

poorNetJudge: number = POOR_NET_JUDGE

连续poorNetJudge(s)没有任何资产下载完成，即判定为预加载失败

topics

topics: Record<keyof IPreloadEvent, ITopic<any>[]> = ...

Accessors

isSupportPack

  • get isSupportPack(): boolean

  • Returns boolean

Methods

dispose

  • dispose(): void

  • 移除所有的监听事件

    Returns void

getPreloadType

  • getPreloadType(options?): Promise<undefined | "completed" | "fresh" | "increment">

  • 主动获取预加载更新类型

    Parameters

    Returns Promise<undefined | "completed" | "fresh" | "increment">

initConfig

  • initConfig(): Promise<void>

  • Returns Promise<void>

off

  • off<K>(topic, listener?): void

  • 移除监听事件

    Type Parameters

    • K extends keyof IPreloadEvent

    Parameters

    • topic: K
    • Optional listener: IListener<IPreloadEvent[K]>

    Returns void

on

  • on<K>(topic, listener, order?): {
        unsub: (() => void);
    }

  • 添加事件监听器

    Type Parameters

    • K extends keyof IPreloadEvent

    Parameters

    • topic: K
    • listener: IListener<IPreloadEvent[K]>
    • Optional order: number

    Returns {
        unsub: (() => void);
    }

    • unsub: (() => void)
        • (): void

        • Returns void

onGetPreloadType

  • onGetPreloadType(func): void

  • 获取预加载更新类型

    Parameters

    • func: ((type) => any)

    Returns void

    Deprecated

    使用 getPreloadType

once

  • once<K>(topic, listener, order?): {
        unsub: (() => void);
    }

  • 添加事件监听器，单个 listener 只执行1次

    Type Parameters

    • K extends keyof IPreloadEvent

    Parameters

    • topic: K
    • listener: IListener<IPreloadEvent[K]>
    • Optional order: number

    Returns {
        unsub: (() => void);
    }

    • unsub: (() => void)
        • (): void

        • Returns void

setIndexDb

  • setIndexDb(useIndexDB): void

  • 设置是否开启indexdb，默认开启

    Parameters

    • useIndexDB: boolean

    Returns void

setMainRoleLists

  • setMainRoleLists(avatarIdLists): void

  • Parameters

    • avatarIdLists: string[]

    Returns void

setPreCreateActorConfigs

  • setPreCreateActorConfigs(configStr, classes): void

  • 设置预加载-预创建阶段的资产 & actor 类（旧版本预创建）

    Parameters

    • configStr: string

      配置json文件转string

    • classes: IActorClass[]

      actor类的map对象

    Returns void

    Deprecated

setPrecreateClasses

  • setPrecreateClasses(classes, roomList?, version?): Promise<void>

  • 设置预加载-预创建阶段 actor 类

    Parameters

    • classes: IActorClass[]

      actor类的map对象

    • Optional roomList: any[]

      预创建房间列表,用于房间跳转

    • Optional version: string

      预创建版本号,用于自动化版本构建

    Returns Promise<void>

start

  • start(onProgress?, options?): Promise<void>

  • 预加载成功可以通过返回的 promise resolve 来判断。目前单个资源预加载失败就会 reject 如果调用了 Preload.stop 会 reject 出 PreloadCanceledError。目前单个请求超时时间和资源大小相关，重试次数2

    Parameters

    Returns Promise<void>

stop

  • stop(): void

  • 停止预加载，停止后再次开启需要重新调用 Preload.start

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc