@bscotch/sprite-source
Version:
Art pipeline scripting module for GameMaker sprites.
35 lines • 1.64 kB
TypeScript
import { Pathy } from '@bscotch/pathy';
import { SpriteCache } from './SpriteCache.js';
import { type SpritesInfo } from './SpriteCache.schemas.js';
import { type SpriteDestActionResult } from './SpriteDest.actions.js';
import { SpriteDestAction, type SpriteDestConfig, type SpriteDestSource } from './SpriteDest.schemas.js';
import { Reporter } from './types.js';
export interface SpriteDestImportOptions {
allowedNamePatterns?: (string | RegExp)[];
}
export declare class SpriteDest extends SpriteCache {
readonly yypPath: Pathy;
protected constructor(spritesRoot: string | Pathy, yypPath: Pathy);
get configFile(): Pathy<{
$schema?: string | undefined;
sources?: {
[x: string]: unknown;
source: string;
collaboratorSources?: string[] | undefined;
ignore?: string[] | null | undefined;
prefix?: string | undefined;
}[] | undefined;
}>;
protected inferChangeActions(sourceConfig: SpriteDestSource, destSpritesCache: SpritesInfo): Promise<SpriteDestAction[]>;
/**
* @param overrides Optionally override the configuration file (if it exists)
*/
import(overrides?: SpriteDestConfig, reporter?: Reporter, options?: SpriteDestImportOptions): Promise<SpriteDestActionResult[] | undefined>;
/**
* Load the config, ensuring it exists on disk. If overrides
* are provided the config will be updated with those values.
*/
loadConfig(overrides?: SpriteDestConfig): Promise<SpriteDestConfig>;
static from(projectYypPath: string | Pathy): Promise<SpriteDest>;
}
//# sourceMappingURL=SpriteDest.d.ts.map