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

    Class ModelHandler

    Resource handler used for loading Model 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

    • Add a parser that converts raw data into a Model. Default parser is for JSON models.

      Parameters

      • parser: any

        See JsonModelParser for example.

      • decider: AddParserCallback

        Function that decides on which parser to use. Function should take (url, data) arguments and return true if this parser should be used to parse the data into a Model. The first parser to return true is used.

      Returns void

    • Load a resource from a remote URL. The base implementation does nothing.

      Parameters

      • url: any

        Either the URL of the resource to load or a structure containing the load and original URL.

      • callback: any

        The callback used when the resource is loaded or an error occurs.

      • asset: any

        Optional asset that is passed by ResourceLoader.

      Returns void

    • 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 any

      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.

      • assets: any

        The asset registry.

      Returns void