类 URL

En

The URL class provides URL formatting and version management.

  • The engine automatically calls the formatURL function to format URL paths when loading resources.
  • You can set the network base path through the basePath property.
  • By setting the customFormat function, you can customize the way URLs are formatted.

Zh

URL 类提供URL格式化和版本管理功能。

  • 引擎加载资源时，会自动调用formatURL函数格式化URL路径。
  • 通过basePath属性可以设置网络基础路径。
  • 通过设置customFormat函数，可以自定义URL格式化的方式。

构造函数

constructor

属性

basePath basePaths customFormat urlMapping version

访问器

path url rootPath

方法

formatURL getFileName getPath getResURLByUUID getURLVerion initMiniGameExtensionOverrides join normalize overrideExtension postFormatURL

构造函数

constructor

属性

静态basePath

basePath: string = ""

En

Base path. If not set, it defaults to the path of the current web page. The final address will be formatted as basePath + relative URL address.

Zh

基础路径。如果不设置，默认为当前网页的路径。最终地址将被格式化为 basePath + 相对URL地址。

静态basePaths

basePaths: Record<string, string> = {}

En

Extended base path mapping table. For example, {"aa/":"http://abc.com/"}, then resources with paths starting with aa/ will be mapped to http://abc.com/.

Zh

扩展的基础路径映射表。例如，{"aa/":"http://abc.com/"}，则把路径以aa/开头的资源映射到http://abc.com/下。

静态customFormat

customFormat: ((url: string) => string)

En

Custom URL formatting function. For example: customFormat = function(url:String):String{}

Zh

自定义URL格式化的方式。例如：customFormat = function(url:String):String{}

静态 只读urlMapping

urlMapping: Record<string, string> = {}

En

URL mapping table. For example, {"aa/bb.png":"cc/dd.png"}. This is used to map URLs to different paths.

Zh

URL映射表。例如，{"aa/bb.png":"cc/dd.png"}。用于将URL映射到不同的路径。

静态 只读version

version: Record<string, string> = {}

En

URL address version mapping table. For example, {"aaa/bb.png":"edcba","aaa/bb.png":"1342a"}. By default, after formatting through formatURL, it will automatically generate an address like "aaa/bb-1342a.png".

Zh

URL地址版本映射表。例如，{"aaa/bb.png":"edcba","aaa/bb.png":"1342a"}。默认情况下，通过formatURL格式化后，会自动生成为"aaa/bb-1342a.png"的地址。

访问器

path

  • get path(): string

  • 返回 string

    En

    The folder path of the address (excluding the file name).

    Zh

    地址的文件夹路径（不包括文件名）。

url

静态rootPath

方法

静态formatURL

  • formatURL(url, base?): string

  • 包含normalizedURL功能，并且合并base，如果base没有提供，则使用URL.basePath或者URL.rootPath。

    参数

    • url: string

      地址。

    • 可选base: string

      基础路径，如果没有，则使用URL.basePath或者URL.rootPath。

    返回 string

    格式化处理后的地址。

静态getFileName

  • getFileName(url): string

  • 参数

    • url: string

      The URL address.

    返回 string

    The file name.

    En

    Get the file name of the specified URL.

    Zh

    获取指定 URL 的文件名。

静态getPath

  • getPath(url): string

  • 参数

    • url: string

      The URL address.

    返回 string

    The folder path with a trailing slash (/).

    En

    Get the folder path of the specified URL (excluding the file name). Note: the returned path has a trailing slash (/).

    Zh

    获取指定 URL 的文件夹路径（不包括文件名）。注意：末尾有斜杠（/）。

静态getResURLByUUID

  • getResURLByUUID(url): string

  • 参数

    • url: string

      The input URL or UUID.

    返回 string

    The resource URL.

    En

    Get the resource URL by UUID.

    Zh

    通过 UUID 获取资源 URL。

静态getURLVerion

  • getURLVerion(url): string

  • 参数

    • url: string

      The URL to check.

    返回 string

    The version string or null if not found.

    En

    Get the version string of the URL.

    Zh

    获取 URL 版本字符。

静态initMiniGameExtensionOverrides

  • initMiniGameExtensionOverrides(): void

  • 返回 void

    En

    Initialize file extension overrides for mini-game.

    Zh

    初始化小游戏的文件扩展名覆盖。

静态join

  • join(base, path): string

  • 参数

    • base: string

      The base path.

    • path: string

      The path to join.

    返回 string

    The combined and normalized path.

    En

    Combine and normalize relative paths.

    Zh

    组合相对路径并格式化。

静态normalize

  • normalize(url): string

  • 参数

    • url: string

      The URL to normalize.

    返回 string

    The normalized URL.

    En

    Normalize a relative path. Mainly handles cases with '.' and '..'.

    Zh

    格式化相对路径。主要是处理 '.' 和 '..' 这些情况。

静态overrideExtension

  • overrideExtension(originalExts, targetExt, miniGameOnly?): void

  • 参数

    • originalExts: string[]

      The original extensions. For example, ["scene"].

    • targetExt: string

      The target extension to convert to. For example, "json".

    • 可选miniGameOnly: boolean

    返回 void

    En

    Override the file extension for downloading.

    Zh

    下载时，转换 URL 的扩展名。

静态postFormatURL

  • postFormatURL(url): string

  • 参数

    • url: string

      The address to be processed.

    返回 string

    The processed address.

    En

    Process automatic conversion of file extensions.

    Zh

    处理扩展名的自动转换。

显示设置

成员可见性

目录

构造函数
属性
访问器
方法