evidently-pixi/dist/Various/TextureStore.d.ts

TypeScript powered set of modules to make it easier to make games in Pixi.js.

import * as PIXI from 'pixi.js';
export interface TilesetTextureConfig {
    offsetX: number;
    offsetY: number;
    tileWidth: number;
    tileHeight: number;
    spacingX: number;
    spacingY: number;
}
/**
 * Provides simple API for retrieving texture by name, by a segment of a texture or by a tile in a tileset.
 *
 * The goal is to have a centralized source of textures that can be easily accessed just by a string. Simplifies
 * serialization among other things.
 *
 * To use this, a texture first has to be registered with a name, then you can access it by one of the many ways.
 * A tileset can also be registered in which case its tiles can be retrieved via `getTile()`.
 *
 * Note: `TextureStore` never creates new BaseTextures. What it means is that for the purpose of performance, all the textures
 * created from the same base texture are still part of that base texture, part of the same texture atlas.
 */
export declare class TextureStore {
    private readonly _separator;
    private readonly _separatorRemovalRegex;
    private readonly nameToTextureMap;
    private readonly textureToNameMap;
    private readonly nameToTilesetConfigMap;
    /**
     * Separator used to delimit properties of a dynamic texture rectangle
     */
    get separator(): string;
    /**
     * Creates a new Texture Factory.
     *
     * @param {string="/"} separator Used to delimit properties of a texture rectangle
     * @throws {Error} Thrown when separator's length is different than 1 character.
     */
    constructor(separator?: string);
    /**
     * Registers a texture for use in the factory.
     *
     * @param {PIXI.Texture} texture Texture to register
     * @param {string} name Name of the texture to use for access
     * @throws {Error} Thrown when texture name contains the separator provided in the constructor.
     */
    registerTexture(texture: PIXI.Texture, name: string): void;
    /**
     * Registers a previously registered texture as a tileset, to allow using it with `getTile()` method. The texture can still be used
     * the same way it was used previously.
     *
     * @param {string} textureName Name of the texture to use as the basis for the tileset
     * @param {TilesetTextureConfig} config Tileset configuration
     * @throwns {Error} Thrown when you try to register tileset for `textureName` that was not previously registered.
     * @throwns {Error} Thrown when you try to register tileset for `textureName` that was already registered as tileset.
     */
    registerTileset(textureName: string, config: TilesetTextureConfig): void;
    /**
     * Given a texture previously extracted from this factory returns its name. Most useful to get the generated name
     * of textures from `getTile()` or `getTextureRectangle()`.
     *
     * @param {string} texture Texture which name to get
     * @return {string} Name of the texture
     * @throws {Error} Thrown when texture was not previously registered nor generated.
     */
    getTextureName(texture: PIXI.Texture): string;
    /**
     * Retrieves a texture by name, where the name can be either a base name of a texture or one with the additional properties,
     * as generated by `getTextureRectangle()` or `getTile()`.
     * If a name with properties is passed and that texture was not previously generated in this factory it'll work exactly the same
     * as if calling `getTextureRectangle()` with the basename and rectangle extracted.
     *
     * @param {string} name Name of the texture to retrieve
     * @return {PIXI.Texture} The texture for the name
     * @throws {Error} Thrown when texture for the given name was not found and did not have the valid number of properties.
     * @throws {Error} Thrown when the width or height in the texture name's properties is less than 1
     */
    getTexture(name: string): PIXI.Texture;
    /**
     * Retrieves a rectangle from a previously registered texture or a valid texture rectangle. If the name provided is
     * a texture rectangle, the position provided will be relative to that rectangle's frame, not the base texture's frame.
     *
     * @param {string} name Name of the texture to use as a basis
     * @param {number} x Offset X position from the top-left corner of the texture's frame
     * @param {number} y Offset Y position from the top-left corner of the texture's frame
     * @param {number} width Width of the new texture
     * @param {number} height Height of the new texture
     * @return {PIXI.Texture} The new texture that matches the specified frame.
     * @throws {Error} Thrown when either width or height is less than 1
     */
    getTextureRectangle(name: string, x: number, y: number, width: number, height: number): PIXI.Texture;
    /**
     * Retrieves a texture that matches a tile at the given position in the tileset.
     *
     * @param {string} name Name of the tileset to use.
     * @param {number} x X position of the tile
     * @param {number} y Y position of the tile
     * @return {PIXI.Texture} The texture for the requested tile
     * @throws {Error} Thrown when the name of the texture was not registered as a tileset.
     */
    getTile(name: string, x: number, y: number): PIXI.Texture;
}