Engine API Reference - v2.6.1
    Preparing search index...

    Class RenderHandler

    Resource handler used for loading Render resources.

    Hierarchy (View Summary)

    Index

    Properties

    Accessors

    Methods

    Properties

    _app: AppBase

    The running app instance.

    handlerType: string = ''

    Type of the resource the handler handles.

    Accessors

    • get maxRetries(): number

      Gets the number of times to retry a failed request for the resource.

      Returns number

    • set maxRetries(value: number): void

      Sets the number of times to retry a failed request for the resource.

      Parameters

      • value: number

      Returns void

    Methods

    • The open function is passed the raw resource data. The handler can then process the data into a format that can be used at runtime. The base implementation simply returns the data.

      Parameters

      • url: any

        The URL of the resource to open.

      • data: any

        The raw resource data passed by callback from ResourceHandler#load.

      Returns Render

      The parsed resource data.

    • The patch function performs any operations on a resource that requires a dependency on its asset data or any other asset data. The base implementation does nothing.

      Parameters

      • asset: any

        The asset to patch.

      • registry: any

      Returns void