import { SpriteProvider } from "./SpriteProvider"; import { RequestResult } from "../RequestResult"; import CredentialMode from "../CredentialMode"; /** * スプライトデータのための汎用的なプロバイダ実装である。 * * [[requestLayout]]`()` は次の URL のオブジェクトを要求する。 * ``` * prefix + options.layout_suffix * ``` * * [[requestSheet]]`()` は次の URL のオブジェクトを要求する。 * ``` * prefix + options.sheet_suffix * ``` * * `prefix` は一般的に `"http://"` または `"https://"` で始まる * 文字列を指定する。 * * @see [[constructor]], [[Option]] */ declare class StandardSpriteProvider extends SpriteProvider { /** * @param prefix - URL の先頭文字列 * @param options - オプション辞書 */ constructor(prefix: string, options?: StandardSpriteProvider.Option); requestLayout(): RequestResult; requestSheet(): RequestResult; /** * レイアウトデータの URL を作成 */ private _make_layout_data_url; /** * スプライト画像データの URL を作成 */ private _make_sheet_data_url; /** * `LayoutItem` のリストを取得 (Promise) */ private _getLayout; /** * レイアウトデータが記述された Json インスタンスを取得 (Promise) */ private _getLayoutAsJson; /** * スプライト画像を取得 (Promise) */ private _getSheet; private readonly _prefix; private readonly _layout_suffix; private readonly _sheet_suffix; private readonly _layout_credentials; private readonly _layout_headers; private readonly _sheet_credentials; private readonly _sheet_headers; } declare namespace StandardSpriteProvider { /** * [[StandardSpriteProvider.constructor]] に与えるオプションの型である。 */ interface Option { /** * レイアウトデータの URL の末尾文字列 * * @defaultValue ".json" */ layout_suffix?: string; /** * 画像データの URL の末尾文字列 * * @defaultValue ".png" */ sheet_suffix?: string; /** * レイアウトデータ用のクレデンシャルモード * * @defaultValue [[CredentialMode.OMIT]] */ layout_credentials?: CredentialMode; /** * レイアウトデータのリクエストに追加するヘッダーの辞書 * * @defaultValue `{}` */ layout_headers?: Headers; /** * 画像データ用のクレデンシャルモード * * @defaultValue [[CredentialMode.OMIT]] */ sheet_credentials?: CredentialMode; /** * 画像データのリクエストに追加するヘッダーの辞書 * * @defaultValue `{}` */ sheet_headers?: Headers; } /** * リクエストに追加するヘッダーの辞書 * * @see [[Option.layout_headers]], [[Option.sheet_headers]] */ interface Headers { /** * ヘッダー名とその値 */ [name: string]: string; } } export { StandardSpriteProvider }; //# sourceMappingURL=StandardSpriteProvider.d.ts.map