@truelab/truengine 0.0.1-0

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './src/index'
+export {}

package/dist/types/src/classes/assets.class.d.ts

@@ -0,0 +1,89 @@
+import { Sound } from '@pixi/sound';
+import { EAssetType } from '../extends/enum.types';
+import { TGenericObject, TMixedObject, TPixiAnimatedSprite, TPixiAnimations, TPixiSprite, TPixiTexture, TPixiTextures } from '../extends/short.types';
+import { Loaders } from './loaders.class';
+import * as PIXI from 'pixi.js';
+export type TPathType = {
+    desktop?: string;
+    desktopWebp?: string;
+    desktopRetina?: string;
+    desktopRetinaWebp?: string;
+    mobile?: string;
+    mobileWebp?: string;
+    mobileRetina?: string;
+    mobileRetinaWebp?: string;
+};
+export type TAsset = {
+    type: EAssetType;
+    src?: string | TPathType;
+    srcResource?: string;
+    tex?: string | TPathType;
+    texResource?: string;
+    ske?: string | TPathType;
+    skeResource?: string;
+    fonts?: string[];
+    config?: unknown;
+};
+export type TAssets = TGenericObject<TAsset>;
+/**
+ * Класс для загрузки и хранения ассетов
+ */
+export declare class Assets extends Loaders {
+    static assets: Map<string, TAsset>;
+    /**
+     * Добавить ассеты (не загружать)
+     * @param assets
+     */
+    add(assets: TAssets): Assets;
+    /**
+     * Загрузить раннее добавленные ассеты, которые еще не были загружены
+     */
+    load(tag?: string, timeout?: number): Promise<void>;
+    /**
+     * Получить путь к ассету на основе текущего режима
+     * @param src
+     */
+    static getPath(src: string | TPathType, useRealDevice?: boolean): string;
+    /**
+     * Получить конфиг ассета по имени
+     * @param assetName
+     */
+    static getConfig(assetName: string): TMixedObject;
+    /**
+     * Получить значение конфига ассета по имени и ключу
+     * @param assetName
+     * @param configKey
+     * @param def
+     */
+    static getConfigValue<T = string>(assetName: string, configKey: string, def?: T): T;
+    /**
+     * Получить текстуру спрайта по имени
+     * @param assetName
+     * @param textureName
+     */
+    static getTexture(assetName: string, textureName?: string): TPixiTexture;
+    /**
+     * Получить спрайт по имени ассета и тестуры
+     * @param assetName ключ ассета в конфиге
+     * @param textureName имя текстуры в спрайте
+     */
+    static getSprite(assetName: string, textureName?: string): TPixiSprite;
+    /**
+     * Получить анимированный спрайт по имени ассета
+     * @param assetName
+     * @param animation ?
+     */
+    static getAnimatedSprite(assetName: string, animation: string): TPixiAnimatedSprite;
+    /** */
+    static getSpritesheet(assetName: string, animation: string): TPixiTextures | TPixiAnimations;
+    /**
+     * Получить звуковой спрайт
+     * @param assetName
+     */
+    static getSound(assetName: string): Sound;
+    /**
+     * Получить bitmap шрифт
+     * @param assetName
+     */
+    static getBitmapFont(assetName: string): PIXI.BitmapFont;
+}

package/dist/types/src/classes/bitmap.text.class.d.ts

@@ -0,0 +1,77 @@
+import * as PIXI from 'pixi.js';
+type TBitmapTextOptionsRequired = {
+    /** Название ассета из конфига, например ./src/configs/assets.fonts.ts */
+    assetName: string;
+};
+/**
+ * Убираем fontName
+ * Обязательное поле assetName
+ * Дополнительные необязательные поля currency и space
+ */
+export type TBitmapTextOptions = TBitmapTextOptionsRequired & Partial<Omit<PIXI.IBitmapTextStyle, 'fontName'> & {
+    /** Валюта для форматирования */
+    currency?: string;
+    /** Символ или набор символов для замены пробела */
+    space?: string;
+}>;
+/**
+ * Расширение класса bitmap текста для обработки пробелов, валютных значений, проверки нехватки алфавита, и тд
+ *
+ * @example
+ *
+ * // Арт может собрать шрифт, где пробел заменяется нижним подчеркиванием
+ * // Если пробел оказался слишком узким - можно задать больше обычных пробелов {space: '    '})
+ * const bitmapText = new BitmapText('Any text', { assetName: 'fontWin', space: '_' })
+ *
+ * console.log(bitmapText.text) // 'Any_text', но будет отображаться как 'Any text'
+ *
+ * // Работа с валютой
+ *
+ * const bitmapText = new BitmapText('', { assetName: 'fontWin', currency: '%btc' })
+ * bitmapText.currencyFormat(100, true)
+ *
+ * console.log(bitmapText.text) // '100,00' - валюта будет проигнорировна, потому что в шрифте нет символа "%"
+ *
+ * // Предупреждения
+ *
+ * const bitmapText = new BitmapText('∑∑∑∑∆∆∆', { assetName: 'fontWin' }) // Будет предупреждение в консоли о нехватке алфавита
+ * bitmapText.text = 'µµµµ∫∫√√√√' // Будет предупреждение в консоли о нехватке алфавита
+ */
+export declare class BitmapText extends PIXI.BitmapText {
+    /** Название ассета шрифта */
+    protected _assetName: string;
+    /** Данные шрифта из .fnt файла **/
+    protected _fontFace: PIXI.BitmapFont;
+    /** Замена для пробелов ("_", "    ", etc.) */
+    protected _space: string;
+    /** Валюта, используемая в шрифте */
+    protected _currency: string;
+    /** Следует ли показывать валюту */
+    protected _withCurrency: boolean;
+    protected _maxWidthCustom: number;
+    /** Догступ к fontFace, на всякий случай */
+    get fontFace(): PIXI.BitmapFont;
+    /** @inheritdoc */
+    get text(): string;
+    /**
+     * @inheritdoc
+     * Пожалуйста, используйте this.currencyFormat() и this.coinsFormat() для валютных значений
+     */
+    set text(value: string);
+    /** @constructor */
+    constructor(text: string, options: TBitmapTextOptions);
+    /** Форматирование для валютного значения */
+    currencyFormat(value: number, withCurrency?: boolean): void;
+    /** Форматирование для значения в монетах */
+    coinsFormat(value: number, withCurrency?: boolean): void;
+    /** Проверка текста на нехватку алфавита */
+    hasMissing(text: string): boolean;
+    /** Замена пробелов и проверка отсутствия символов в алфавите */
+    refresh(): void;
+    /**
+     * Установить ограничения для размера компонента
+     * Одновременная установка width и height возможна только при isWordWrapMode=true
+     */
+    setMaxWidth(maxWidth: number): void;
+}
+export {};

package/dist/types/src/classes/borderview.class.d.ts

@@ -0,0 +1,204 @@
+export declare enum EDevice {
+    desktop = "desktop",
+    mobile = "mobile"
+}
+export declare enum EOrientation {
+    landscape = "landscape",
+    portrait = "portrait"
+}
+export type TUiConfig = {
+    checkpointMobile: [number, number];
+};
+export type TGameConfig = {
+    device: EDevice;
+    orientation?: EOrientation;
+    size: [number, number];
+    align: [string, string];
+};
+export type TModalVariant = {
+    checkpoint?: [number, number];
+    size: [number, number];
+    classes?: string[];
+};
+export type TModalsConfig = {
+    device: EDevice;
+    orientation?: EOrientation;
+    variants: TModalVariant[];
+};
+export type TGameConfigs = TGameConfig[];
+export type TGame = {
+    config: TGameConfig;
+    scale: number;
+    outerWidth: number;
+    outerHeight: number;
+    innerWidth: number;
+    innerHeight: number;
+    innerTop: number;
+    innerLeft: number;
+    innerRight: number;
+    innerBottom: number;
+};
+export type TModals = {
+    config: TModalsConfig;
+    variant: TModalVariant;
+    scale: number;
+    width: number;
+    height: number;
+};
+export type TModalsConfigs = TModalsConfig[];
+export type TUi = {
+    config: TUiConfig;
+    mobile: boolean;
+};
+export type TUiConfigs = {
+    [key in EDevice]?: TUiConfig;
+};
+/**
+ * Класс BorderView содержит в себе заранее подсчитанные значения для адаптивки сцены, модалок и ui.
+ * Объект borderView создается один на всю игру (в самом конце модуля), экспортируется из этого модуля и используется всеми компонентами сразу.
+ * Перед запуском игры надо выполнить у borderView.init с нужными конфигами.
+ */
+export declare class BorderView {
+    /** высота верхней полосы */
+    topBar: number;
+    /** высота нижней полосы */
+    bottomBar: number;
+    /** Классы модального окна для устройств */
+    protected _modalDeviceClasses: {
+        [key in EDevice]: string;
+    };
+    /** Классы модального окна для ориентации */
+    protected _modalOrientationClasses: {
+        [key in EOrientation]: string;
+    };
+    /** Конфиги для сцены игры (задаются из геймплея через метод init) */
+    protected _gameConfigs: TGameConfigs;
+    /** Конфиги для модалок (задаются из геймплея через метод init) */
+    protected _modalsConfigs: TModalsConfigs;
+    /** Конфиги для ui (задаются из геймплея через метод init) */
+    protected _uiConfigs: TUiConfigs;
+    /** Активный на данный момент конфиг для сцены игры (вместе с подсчитанными значениями) */
+    protected _game: TGame;
+    /** Активный на данный момент конфиг для модалок (вместе с подсчитанными значениями) */
+    protected _modals: TModals;
+    /** Активный на данный момент конфиг для ui (вместе с подсчитанными значениями) */
+    protected _ui: TUi;
+    /** Флаг ретины (задается один раз и не меняется) */
+    protected _retina: boolean;
+    /** hardcoded value to display mobile version always */
+    protected _device: EDevice;
+    /** real device value to load appropriate assets */
+    protected _realDevice: EDevice;
+    /**
+     * Плотность пикселей девайса (задается один раз и не меняется)
+     * Так как TrueLogic использует конфиги мобильных устройств для десктопа удваиваем devicePixelRatio,
+     * иначе падает качество при рендере.
+     */
+    protected _devicePixelRatio: number;
+    /** Ориентация экрана landscape или portrait (может меняться) */
+    protected _orientation: EOrientation;
+    /** Ширина видимой области экрана */
+    protected _width: number;
+    /** Высота видимой области экрана */
+    protected _height: number;
+    /** Соотношение сторон экрана */
+    protected _aspectRatio: number;
+    /** mobile */
+    get device(): EDevice;
+    /** desktop, mobile */
+    get realDevice(): EDevice;
+    /** Плотность пикселей девайса */
+    get devicePixelRatio(): number;
+    /** Ориентация экрана: landscape, portrait */
+    get orientation(): EOrientation;
+    /** Соотношение сторон экрана */
+    get aspectRatio(): number;
+    /** Ширина видимой области экрана */
+    get width(): number;
+    /** Высота видимой области экрана */
+    get height(): number;
+    /** Ретина или нет */
+    get isRetina(): boolean;
+    /** Десктоп или нет (планшет считается десктопом) */
+    get isDesktop(): boolean;
+    /** */
+    get isReallyDesktop(): boolean;
+    /** Мобильный или нет */
+    get isMobile(): boolean;
+    /** Мобильный в альбомной ориентации */
+    get isMobileLandscape(): boolean;
+    /** Мобильный в портретной ориентации */
+    get isMobilePortrait(): boolean;
+    /** Альбомная ориентация или нет */
+    get isLandscape(): boolean;
+    /** Портретная ориентация или нет */
+    get isPortrait(): boolean;
+    /** Режим сцены (меняется при изменении конфига) */
+    get gameMode(): string;
+    /** Ширина сцены */
+    get gameWidth(): number;
+    /** Высота сцены */
+    get gameHeight(): number;
+    /** Выравнивание сцены по X - left, center, right */
+    get gameAlignX(): string;
+    /** Выравнивание сцены по Y - left, center, right */
+    get gameAlignY(): string;
+    /** Скейл сцены, который применен к ней, чтобы она уместилась в видимой области экрана */
+    get gameScale(): number;
+    /** Реальная ширина всего канваса (равна ширине видимой области экрана) */
+    get gameOuterWidth(): number;
+    /** Реальная высота всего канваса (равна высоте видимой области экрана) */
+    get gameOuterHeight(): number;
+    /** Реальная ширина сцены (после применения скейла) */
+    get gameInnerWidth(): number;
+    /** Реальная высота сцены (после применения скейла) */
+    get gameInnerHeight(): number;
+    /** Реальный отступ сверху от сцены до края экрана */
+    get gameInnerTop(): number;
+    /** Реальный отступ слева от сцены до края экрана */
+    get gameInnerLeft(): number;
+    /** Реальный отступ справа от сцены до края экрана */
+    get gameInnerRight(): number;
+    /** Реальный отступ снизу от сцены до края экрана */
+    get gameInnerBottom(): number;
+    /** Ширина внутреннего контейнера модалок */
+    get modalsWidth(): number;
+    /** Высота внутреннего контейнера модалок */
+    get modalsHeight(): number;
+    /** CSS классы модалок */
+    get modalsClasses(): string[];
+    /** Масштаб модалок, который применен к ним, чтобы они уместились в видимой области экрана */
+    get modalsScale(): number;
+    /** Ширина внешнего контейнера модалок */
+    get modalsOuterWidth(): number;
+    /** Высота внешнего контейнера модалок */
+    get modalsOuterHeight(): number;
+    /** Мобильная ли сейчас версия ui или нет */
+    get uiMobile(): boolean;
+    /** Десктопная ли сейчас версия ui или нет */
+    get uiDesktop(): boolean;
+    /**
+     * Установить конфиги и пересчитать все значения
+     * @param gameConfigs
+     * @param modalsConfigs
+     * @param uiConfigs
+     */
+    init(gameConfigs: TGameConfigs, modalsConfigs: TModalsConfigs, uiConfigs: TUiConfigs): void;
+    /**
+     * Пересчитать все значения
+     */
+    recalc(): void;
+    /**
+     * Пересчитать все значения для сцены игры
+     */
+    protected recalcGame(): void;
+    /**
+     * Пересчитать все значения для модалок
+     */
+    protected recalcModals(): void;
+    /**
+     * Пересчитать все значения для ui
+     */
+    protected recalcUI(): void;
+}
+export declare const borderView: BorderView;

package/dist/types/src/classes/color.class.d.ts

@@ -0,0 +1,72 @@
+/** Цвет и методы его конвертации в разные форматы
+ * @example
+ * const c = Color.hex(0xff00ff)
+ * const style = c.getRGBAString()
+ */
+export declare class Color {
+    private r;
+    private g;
+    private b;
+    private a;
+    /** Создает объект с заданным цветом
+     * @param hex цвет в формате 0xffffff
+     * @returns новый объект цвета
+     */
+    static hex(hex: number): Color;
+    /** Создает объект с заданным цветом
+     * @param hexString цвет в формате "0xffffff"
+     * @returns новый объект цвета
+     */
+    static hexString(hexString: string): Color;
+    /** Создает объект с заданным цветом
+     * @param r значение красного канала [0..1]
+     * @param g значение зеленого канала [0..1]
+     * @param b значение синего канала [0..1]
+     * @returns новый объект цвета
+     */
+    static rgb(r: number, g: number, b: number): Color;
+    /** Создает объект с заданным цветом
+     * @param r значение красного канала [0..1]
+     * @param g значение зеленого канала [0..1]
+     * @param b значение синего канала [0..1]
+     * @param a значение канала прозрачности [0..1]
+     * @returns новый объект цвета
+     */
+    static rgba(r: number, g: number, b: number, a: number): Color;
+    /** Создает объкт с белым непрозрачным цветом по умолчанию */
+    constructor();
+    /** Задает значение цвета
+     * @param hex: цвет в формате 0xffffff
+     */
+    setHex(hex: number): this;
+    /** Задает значение цвета
+     * @param hexString: цвет в формате "0xffffff"
+     */
+    setHexString(hexString: string): this;
+    /** Задает значение цвета
+     * @param r значение красного канала [0..1]
+     * @param g значение зеленого канала [0..1]
+     * @param b значение синего канала [0..1]
+     */
+    setRGB(r: number, g: number, b: number): this;
+    /** Задает значение цвета
+     * @param r значение красного канала [0..1]
+     * @param g значение зеленого канала [0..1]
+     * @param b значение синего канала [0..1]
+     * @param a значение канала прозрачности [0..1] */
+    setRGBA(r: number, g: number, b: number, a: number): this;
+    /** Возвращает цвет
+     * @return цвет в формате 0xffffff */
+    getHex(): number;
+    /** Возвращает цвет
+     * @return цвет в формате "0xffffff" */
+    getHexString(): string;
+    /** Возвращает цвет
+     * @return цвет в формате "rgb(255, 255, 255)"
+     */
+    getRGBString(): string;
+    /** Возвращает цвет
+     * @return цвет в формате "rgba(255, 255, 255, 1)"
+     */
+    getRGBAString(): string;
+}

package/dist/types/src/classes/container.class.d.ts

@@ -0,0 +1,111 @@
+import { EPivot } from '../extends/enum.types';
+import { IContainer } from '../extends/interfaces';
+import { TCallbackVoid, TMixedObject, TPixiSprite, TSupportMask } from '../extends/short.types';
+import * as PIXI from 'pixi.js';
+/**
+ * Доступные варианты пивота
+ */
+export type TxPos = EPivot.LEFT | EPivot.RIGHT | EPivot.CENTER;
+export type TyPos = EPivot.TOP | EPivot.BOTTOM | EPivot.CENTER;
+/**
+ * Основной контейнер для всего фреймворка
+ *
+ * @example Заимствование методов и аксессоров:
+ * class Scene {
+ *      constructor(sceneName) {
+ *          this.instance = new Container(sceneName)
+ *          this.instance.link(
+ *              this,
+ *              ['width', 'height', 'alpha', 'position', 'rotation', 'scale'], // properties
+ *              ['show', 'hide'] // methods
+ *          )
+ *          this.alpha = 0.5
+ *      }
+ * }
+ */
+export declare class Container extends PIXI.Container implements IContainer {
+    [prop: string]: unknown;
+    /**
+     * Установить scale X
+     */
+    set scaleX(value: number);
+    /**
+     * Получить scale X
+     */
+    get scaleX(): number;
+    /**
+     * Установить scale Y
+     */
+    set scaleY(value: number);
+    /**
+     * Получить scale Y
+     */
+    get scaleY(): number;
+    /**
+     * @constructor
+     * @param name
+     */
+    constructor(name?: string);
+    /**
+     * Метод перелинковки сеттеров\геттеров
+     * @param to Куда передаем геттеры\сеттеры
+     * @param properties Список свойств для перелинковки
+     * @param methods Список методов для перелинковки (необязательный)
+     */
+    link(to: TMixedObject, properties: string[], methods?: string[]): void;
+    /**
+     * Добавляет для disabled функционал getter и setter
+     * @param to
+     * @param onDisabled
+     * @param onEnabled
+     */
+    disabled(to: TMixedObject, onDisabled: TCallbackVoid, onEnabled: TCallbackVoid): void;
+    /**
+     * Скрыть элемент
+     */
+    hide(): IContainer;
+    /**
+     * Показать элемент
+     */
+    show(): IContainer;
+    /**
+     * Установка маски в текущий контейнер
+     * @param graphics
+     */
+    setMask(graphics: TSupportMask): TSupportMask;
+    /**
+     * Удаление маски из текущего контейнера
+     */
+    removeMask(): IContainer;
+    /**
+     * Установить фон на контейнер
+     * @param sprite
+     * @param offsetX
+     * @param offsetY
+     * @param angle
+     */
+    setBackground(sprite: TPixiSprite, offsetX?: number, offsetY?: number, angle?: number): IContainer;
+    /**
+     * Опорную точку в центр
+     */
+    setCenterPivot(): IContainer;
+    /**
+     * Установка опорной точки
+     * @example this.setPivot(EPivot.CENTER, EPivot.BOTTOM)
+     * @param x
+     * @param y
+     */
+    setPivot(xPos?: TxPos, yPos?: TyPos): IContainer;
+    /**
+     * Центрирование элемента в другом элементе
+     * @example this.character.centeredTo(this.scene, -100, -100)
+     * @param toContainer
+     * @param offsetX
+     * @param offsetY
+     */
+    centeredTo(toContainer: Container, offsetX?: number, offsetY?: number): IContainer;
+    /**
+     * Центрирование элемента относительно своих размеров
+     */
+    centered(): IContainer;
+}

package/dist/types/src/classes/di.class.d.ts

@@ -0,0 +1,110 @@
+import { IService } from '../extends/interfaces';
+import { TCallbackService, TLangsReplace } from '../extends/short.types';
+import { LangsService } from '../services/langs.service';
+import { RegistryService } from '../services/registry.service';
+import { SettingsService } from '../services/settings.service';
+import { Emitter, IEmitter } from './emitter.class';
+/**
+ * Контейнер зависимостей
+ *
+ * @rules
+ * - изначально все сервисы регистрируются как колбэки
+ * - инициализация сервиса происходит в момент первого обращения к нему
+ * - все сервисы должны быть зарегистрированы в конструкторе геймплея
+ * - контекст this функции инициализации сервиса будет ссылкой на контейнер (по умолчанию стрелочные функции и контекста там нет)
+ * - любой сервис по умолчанию может быть перезаписан в конструкторе геймплея (перезапись колбэка)
+ * - после регистрации каждый сервис доступен как метод геймплея (однако он может быть переопределен)
+ * - синглтоны и колбэки вынесены в контекст модуля чтобы они были общими у всех объектов, расширяющих DI
+ * - общий эмиттер событий для всех объектов, расширяющих DI
+ * - основные зависимости не регистрируются здесь потому что контейнер может понадобиться с другим набором сервисов в других движках
+ *
+ * @rules
+ * Не перекрывать методы:
+ * - this.on()
+ * - this.one()
+ * - this.off()
+ * - this.clear()
+ * - this.emit()
+ * - this.get()
+ * - this.set()
+ *
+ * @rules
+ * Не перекрывать свойства:
+ * - this.settings
+ * - this.registry
+ * - this.langs
+ * - this.currency
+ *
+ * @extends Emitter
+ *
+ */
+export declare class DI extends Emitter implements IEmitter {
+    /** настройки приложения (общие на все контейнеры) */
+    settings: () => SettingsService;
+    /** реестр объектов (общий) */
+    registry: () => RegistryService;
+    /** сервис языков */
+    langs: () => LangsService;
+    /**
+     * @constructor
+     * @param autobind
+     */
+    constructor(autobind?: string[]);
+    /**
+     * Получить значение настройки из сервиса настроек
+     * @param name
+     * @param def
+     */
+    get<T = string>(name: string, def?: T): T;
+    /**
+     * Обновить значение настройки в сервисе настроек
+     * @param name
+     * @param value
+     */
+    set(name: string, value?: unknown): SettingsService;
+    /**
+     * Регистрация сервиса
+     *
+     * @example this.register('manager', () => new Manager())
+     * @example this.manager().getData()
+     * @param serviceName service name
+     * @param depCallback constructor callback
+     * @param autoinit init service immediately
+     */
+    register(serviceName: string, depCallback: TCallbackService, autoinit?: boolean): TCallbackService;
+    /**
+     * Возвращает собраный сервис
+     * @param serviceName name of registered service
+     */
+    service(serviceName: string): IService;
+    /** Собран ли сервис */
+    serviceInited(serviceName: string): boolean;
+    /** Зарегистрирован ли сервис */
+    serviceRegistered(serviceName: string): boolean;
+    /**
+     * Биндит отдельный сервис
+     * @param serviceName name of registered service
+     */
+    bind(serviceName: string): DI;
+}
+/**
+ * Прямой доступ к настройкам в любом месте кода
+ * @rules
+ * - используем этот метод только для того чтобы сделать конфигурируемый код
+ * - значение по умолчанию должно быть задано обязательно
+ * - код который использует настройку должен работать автономно на основе значения по умолчанию
+ */
+export declare const get: <T = string>(name: string, def: T) => T;
+/**
+ * Прямой доступ к объект в реестре
+ * @example registry('renderer')
+ */
+export declare const registry: <T>(name: string) => T;
+/**
+ * Прямой доступ к языковым меткам
+ * @rules
+ * - языковые метки должны быть загружены заранее и заданы в конструкторе геймплея
+ * - значение по умолчанию должно быть задано обязательно
+ * @example lang('rules', 'Rules @time@:', { @time@ : new Date() })
+ */
+export declare const lang: (slug: string, def: string, replaces?: TLangsReplace) => string;