@drincs/nqtr 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,547 @@
+import { CanvasBase, StoredClassModel, CharacterBaseModel } from '@drincs/pixi-vn';
+
+type GraphicItemType<TCanvasItem extends CanvasBase<any> = CanvasBase<any>> = string | HTMLElement | TCanvasItem;
+
+interface ActivityProps {
+    /**
+     * The name
+     */
+    name?: string;
+    /**
+     * The hour when the activity starts. If the activity is not started yet, it will be hidden.
+     * If you set 3, the activity will be hidden into hours 1 and 2, and will be shown from hour 3.
+     */
+    fromHour?: number;
+    /**
+     * The hour when the activity ends. If the activity is ended yet, it will be hidden.
+     * If you set 3, the activity will be shown into hours 1 and 2 and will be hidden from hour 3.
+     */
+    toHour?: number;
+    /**
+     * The day when the activity starts. If the activity is not started yet, it will be hidden.
+     * If you set 3, the activity will be hidden into days 1 and 2, and will be shown from day 3.
+     */
+    fromDay?: number;
+    /**
+     * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
+     * If you set 3, the activity will be shown into days 1 and 2 and will be deleted or hidden from day 3.
+     */
+    toDay?: number;
+    /**
+     * Whether is disabled. You can also pass a Pixi'VN flag name.
+     */
+    disabled?: boolean | string;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     */
+    hidden?: boolean | string;
+    /**
+     * The icon element. Can be a string or an HTMLElement or a Pixi'VN CanvasItem
+     */
+    iconElement?: GraphicItemType;
+}
+declare abstract class ActivityStoredAbstract {
+    constructor(onRun: (activity: ActivityModel) => void, props: ActivityProps);
+    abstract setStorageProperty<T>(propertyName: string, value: T | undefined): void;
+    abstract getStorageProperty<T>(propertyName: string): T | undefined;
+    abstract get id(): string;
+    private defaultName?;
+    get name(): string;
+    set name(value: string | undefined);
+    private defaultFromHour?;
+    get fromHour(): number;
+    set fromHour(value: number | undefined);
+    private defaultToHour?;
+    get toHour(): number;
+    set toHour(value: number | undefined);
+    private defaultFromDay?;
+    get fromDay(): number | undefined;
+    set fromDay(value: number | undefined);
+    private defaultToDay?;
+    get toDay(): number | undefined;
+    set toDay(value: number | undefined);
+    private defaultDisabled;
+    get disabled(): boolean;
+    set disabled(value: boolean | string);
+    private defaultHidden;
+    get hidden(): boolean;
+    set hidden(value: boolean | string);
+    private _iconElement?;
+    get iconElement(): GraphicItemType | undefined;
+    private _onRun;
+    get onRun(): (activity: ActivityModel) => void;
+    isExpired(): boolean;
+    export(): ActivityProps;
+}
+declare class ActivityModel {
+    constructor(id: string, onRun: (activity: ActivityModel) => void, props: ActivityProps);
+    private _id;
+    get id(): string;
+    private _name?;
+    get name(): string | undefined;
+    private _fromHour?;
+    get fromHour(): number | undefined;
+    private _toHour?;
+    get toHour(): number | undefined;
+    private _fromDay?;
+    get fromDay(): number | undefined;
+    private _toDay?;
+    get toDay(): number | undefined;
+    private _disabled?;
+    get disabled(): boolean | undefined;
+    private _hidden;
+    get hidden(): boolean;
+    private _iconElement?;
+    get iconElement(): GraphicItemType | undefined;
+    private _onRun;
+    get onRun(): (activity: ActivityModel) => void;
+    isDeadline(): boolean;
+    export(): ActivityProps;
+}
+
+interface MapBaseModelProps<TMap extends MapBaseModel = MapBaseModel> {
+    /**
+     * The name
+     */
+    name?: string;
+    /**
+     * The image. It can be a string, an HTMLElement or a Pixi'VN Canvas Item.
+     * Or an object to manage multiple image types. For example to have a image based on time.
+     * @example
+     * ```ts
+     * {
+     *    "morning": "morning-background.jpg",
+     *    "afternoon": "afternoon-background.jpg",
+     *    "evening": "evening-background.jpg",
+     *    "night": "night-background.jpg"
+     * }
+     * ```
+     */
+    image?: GraphicItemType | {
+        [key: string]: GraphicItemType;
+    };
+    /**
+     * The neighboring maps that are available in this map.
+     * @example
+     * ```ts
+     * {
+     *    "north": atlantaMap,
+     *    "south": miamiMap,
+     *    "east": savannahMap,
+     *    "west": birminghamMap
+     * }
+     * ```
+     */
+    neighboringMaps?: {
+        [key: string]: TMap;
+    };
+    /**
+     * Whether is disabled. You can also pass a Pixi'VN flag name.
+     */
+    disabled?: boolean | string;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     */
+    hidden?: boolean | string;
+}
+declare class MapBaseModel extends StoredClassModel {
+    constructor(id: string, props: MapBaseModelProps);
+    private defaultName;
+    get name(): string;
+    set name(value: string);
+    private defaultImage?;
+    get image(): GraphicItemType | {
+        [key: string]: GraphicItemType;
+    } | undefined;
+    set image(value: GraphicItemType | {
+        [key: string]: GraphicItemType;
+    } | undefined);
+    private defaultDisabled;
+    get disabled(): boolean;
+    set disabled(value: boolean | string);
+    private defaultHidden;
+    get hidden(): boolean;
+    set hidden(value: boolean | string);
+}
+
+declare enum ExecutionTypeEnum {
+    AUTOMATIC = "automatic",
+    INTERACTION = "interaction"
+}
+
+interface CommitmentBaseModelProps {
+    /**
+     * The name
+     */
+    name?: string;
+    /**
+     * The hour when the commitment starts. If the commitment is not started yet, it will be hidden.
+     * If you set 3, the commitment will be hidden into hours 1 and 2, and will be shown from hour 3.
+     */
+    fromHour?: number;
+    /**
+     * The hour when the commitment ends. If the commitment is ended yet, it will be hidden.
+     * If you set 3, the commitment will be shown into hours 1 and 2 and will be hidden from hour 3.
+     */
+    toHour?: number;
+    /**
+     * The day when the commitment starts. If the commitment is not started yet, it will be hidden.
+     * If you set 3, the commitment will be hidden into days 1 and 2, and will be shown from day 3.
+     */
+    fromDay?: number;
+    /**
+     * The day when the commitment ends. If the commitment is ended yet, it will be deleted or hidden.
+     * If you set 3, the commitment will be shown into days 1 and 2 and will be deleted or hidden from day 3.
+     */
+    toDay?: number;
+    /**
+     * The image. It can be a string, an HTMLElement or a Pixi'VN Canvas Item.
+     * Or an object to manage multiple image types. For example to have a image based on time.
+     * @example
+     * ```ts
+     * {
+     *    "morning": "morning-background.jpg",
+     *    "afternoon": "afternoon-background.jpg",
+     *    "evening": "evening-background.jpg",
+     *    "night": "night-background.jpg"
+     * }
+     * ```
+     */
+    image?: GraphicItemType | {
+        [key: string]: GraphicItemType;
+    };
+    /**
+     * Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function.
+     */
+    executionType?: ExecutionTypeEnum;
+    /**
+     * Is a function that is called when the player interacts with the character.
+     * @param commitment
+     * @returns
+     */
+    onRun?: (commitment: CommitmentBaseModel) => void;
+    /**
+     * Whether is disabled. You can also pass a Pixi'VN flag name.
+     * If it is disabled this commitment will not be taken into consideration. So the characters will not be in the room, but will be busy with other commitments.
+     */
+    disabled?: boolean | string;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     */
+    hidden?: boolean | string;
+}
+declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = CharacterBaseModel, TRoom extends RoomBaseModel = RoomBaseModel> extends StoredClassModel {
+    constructor(id: string, character: TCharacter | TCharacter[] | undefined, room: TRoom, props: CommitmentBaseModelProps);
+    private _characters;
+    get characters(): TCharacter[];
+    private _room;
+    get room(): TRoom;
+    private _name;
+    get name(): GraphicItemType;
+    private defaultFromHour?;
+    get fromHour(): number;
+    set fromHour(value: number | undefined);
+    private defaultToHour?;
+    get toHour(): number;
+    set toHour(value: number | undefined);
+    private defaultFromDay?;
+    get fromDay(): number | undefined;
+    set fromDay(value: number | undefined);
+    private defaultToDay?;
+    get toDay(): number | undefined;
+    set toDay(value: number | undefined);
+    private _image?;
+    get image(): GraphicItemType | {
+        [key: string]: GraphicItemType;
+    } | undefined;
+    private _executionType;
+    get executionType(): ExecutionTypeEnum;
+    private _onRun?;
+    onRun(): void;
+    private defaultDisabled;
+    get disabled(): boolean;
+    set disabled(value: boolean | string);
+    private defaultHidden;
+    get hidden(): boolean;
+    set hidden(value: boolean | string);
+    isExpired(): boolean;
+}
+
+declare class ActivityRoom<TRoom extends RoomBaseModel = RoomBaseModel> extends ActivityStoredAbstract {
+    constructor(id: string, room: TRoom, onRun: (activity: ActivityModel) => void, props: ActivityProps);
+    setStorageProperty<T>(_: string, __: T | undefined): void;
+    getStorageProperty<T>(propertyName: string): T | undefined;
+    private _id;
+    get id(): string;
+    private _room;
+    get room(): TRoom;
+    export(): object;
+}
+
+interface RoomBaseModelProps {
+    /**
+     * The name
+     */
+    name?: string;
+    /**
+     * The image. It can be a string, an HTMLElement or a Pixi'VN Canvas Item.
+     * Or an object to manage multiple image types. For example to have a image based on time.
+     * @example
+     * ```ts
+     * {
+     *    "morning": "morning-background.jpg",
+     *    "afternoon": "afternoon-background.jpg",
+     *    "evening": "evening-background.jpg",
+     *    "night": "night-background.jpg"
+     * }
+     * ```
+     */
+    image?: GraphicItemType | {
+        [key: string]: GraphicItemType;
+    };
+    /**
+     * The activities that are available in this room.
+     */
+    defaultActivities?: ActivityModel[];
+    /**
+     * Whether is disabled. You can also pass a Pixi'VN flag name.
+     */
+    disabled?: boolean | string;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     */
+    hidden?: boolean | string;
+    /**
+     * The icon element. Can be a string or an HTMLElement or a Pixi'VN CanvasItem
+     */
+    iconElement?: GraphicItemType;
+}
+declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseModel> extends StoredClassModel {
+    constructor(id: string, location: TLocation, props: RoomBaseModelProps);
+    private _location;
+    get location(): TLocation;
+    private defaultName;
+    get name(): string;
+    set name(value: string);
+    private defaultImage?;
+    get image(): GraphicItemType | {
+        [key: string]: GraphicItemType;
+    } | undefined;
+    set image(value: GraphicItemType | {
+        [key: string]: GraphicItemType;
+    } | undefined);
+    private defaultActivityIds;
+    get defaultActivities(): ActivityRoom<this>[];
+    get activityIds(): string[];
+    get activities(): ActivityRoom<this>[];
+    getActivityMemory(id: string): object | undefined;
+    getActivity(id: string): ActivityRoom<this> | undefined;
+    setActivity(activity: ActivityRoom): void;
+    addActivity(activity: ActivityModel): void;
+    removeActivity(activity: ActivityModel | string): void;
+    clearExpiredActivities(): void;
+    private defaultDisabled;
+    get disabled(): boolean;
+    set disabled(value: boolean | string);
+    private defaultHidden;
+    get hidden(): boolean;
+    set hidden(value: boolean | string);
+    private _iconElement?;
+    get iconElement(): GraphicItemType | undefined;
+    getRoutine<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(): TCommitment[];
+}
+
+interface LocationBaseModelProps {
+    /**
+     * The name
+     */
+    name?: string;
+    /**
+     * Whether is disabled. You can also pass a Pixi'VN flag name.
+     */
+    disabled?: boolean | string;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     */
+    hidden?: boolean | string;
+    /**
+     * The icon element. Can be a string or an HTMLElement or a Pixi'VN CanvasItem
+     */
+    iconElement?: GraphicItemType;
+}
+declare class LocationBaseModel<TMap extends MapBaseModel = MapBaseModel> extends StoredClassModel {
+    constructor(id: string, map: TMap, entrance: RoomBaseModel, props: LocationBaseModelProps);
+    private _entrance;
+    get entrance(): RoomBaseModel;
+    private defaultName;
+    get name(): string;
+    set name(value: string);
+    private defaultDisabled;
+    get disabled(): boolean;
+    set disabled(value: boolean | string);
+    private defaultHidden;
+    get hidden(): boolean;
+    set hidden(value: boolean | string);
+    private _iconElement?;
+    get iconElement(): GraphicItemType | undefined;
+    private _map;
+    get map(): TMap;
+}
+
+interface GoalProps {
+    description: string;
+    need?: number;
+    have?: number;
+}
+interface IGoal {
+    description: string;
+    need: number;
+    have: number;
+}
+declare class Goal implements IGoal {
+    constructor(props: GoalProps);
+    private _description;
+    get description(): string;
+    need: number;
+    have: number;
+    get isComplete(): boolean;
+    setComplete(): void;
+    find(): void;
+    get export(): IGoal;
+}
+
+type QuestsRequiredType<TQuest extends QuestBaseModel = QuestBaseModel> = {
+    quest: TQuest;
+    stageNumber: number;
+} | TQuest;
+
+interface StageBaseModelProps {
+    goals?: Goal[];
+    name?: string;
+    description?: string;
+    adviceDescription?: string;
+    image?: string;
+    daysRequiredToStart: number;
+    flagsRequired: string[];
+    questsRequired: QuestsRequiredType[];
+    requestDescription?: string;
+    onStart: () => void;
+    onEnd: () => void;
+}
+declare class StageBaseModel extends StoredClassModel {
+    constructor(id: string, props: StageBaseModelProps);
+    private _completed;
+    get completed(): boolean;
+    private _active;
+    get active(): boolean;
+    private defaultGoals;
+    get goals(): Goal[];
+    set goals(value: Goal[]);
+    private _name;
+    get name(): string;
+    private _description;
+    get description(): string;
+    private _adviceDescription;
+    get adviceDescription(): string;
+    private _image;
+    get image(): string;
+    private _daysRequiredToStart;
+    get daysRequiredToStart(): number;
+    private _flagsRequired;
+    get flagsRequired(): string[];
+    private _questsRequired;
+    get questsRequired(): QuestsRequiredType[];
+    private _requestDescription;
+    get requestDescription(): string;
+    private _onStart;
+    get onStart(): () => void;
+    private _onEnd;
+    get onEnd(): () => void;
+}
+
+interface QuestBaseModelProps {
+    name?: string;
+    description?: string;
+    icon?: string;
+    image?: string;
+    isInDevelopment?: boolean;
+}
+declare class QuestBaseModel<TStage extends StageBaseModel = StageBaseModel> extends StoredClassModel {
+    constructor(id: string, stages: TStage[], props: QuestBaseModelProps);
+    private _stages;
+    get stages(): TStage[];
+    private _name;
+    get name(): string;
+    private _description;
+    get description(): string;
+    private _icon;
+    get icon(): string;
+    private _image;
+    get image(): string;
+    private _isInDevelopment;
+    get isInDevelopment(): boolean;
+}
+
+declare function saveActivity(activity: ActivityModel | ActivityModel[]): void;
+declare function getActivityById(id: string): ActivityModel | undefined;
+
+declare function saveCommitment<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(commitment: TCommitment | TCommitment[]): void;
+declare function getCommitmentById<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(id: string): TCommitment | undefined;
+declare function setFixedCommitments<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(commitments: TCommitment[] | TCommitment): void;
+declare function addTemporaryCommitment<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(commitment: TCommitment[] | TCommitment): void;
+declare function getFixedCommitments<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(): TCommitment[];
+declare function getTemporaryCommitments<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(): TCommitment[];
+
+declare function saveRoom<TRoom extends RoomBaseModel = RoomBaseModel>(room: TRoom | TRoom[]): void;
+declare function getRoomById<TRoom extends RoomBaseModel = RoomBaseModel>(id: string): TRoom | undefined;
+
+declare function clearExpiredActivities(): void;
+declare function currentActivities(): ActivityRoom[];
+
+declare function setCurrentRoom<TRoom extends RoomBaseModel = RoomBaseModel>(room: TRoom): void;
+declare function getCurrentRoom<TRoom extends RoomBaseModel = RoomBaseModel>(): TRoom | undefined;
+declare function getCurrenrLocation<TLocation extends LocationBaseModel = LocationBaseModel>(): TLocation | undefined;
+declare function getCueerntMap<TMap extends MapBaseModel = MapBaseModel>(): TMap | undefined;
+
+declare function clearExpiredRoutine(): void;
+declare function getCurrentCommitments<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(): TCommitment[];
+declare function getCommitmentByCharacter<TCommitment extends CommitmentBaseModel = CommitmentBaseModel, TCharacter extends CharacterBaseModel = CharacterBaseModel>(character: TCharacter): TCommitment | undefined;
+
+interface ITimeSettings {
+    minDayHour?: number;
+    maxDayHour?: number;
+    defaultTimeSpent?: number;
+    timeSlots?: ITimeStlot[];
+    weekLength?: number;
+    newDayHour?: number;
+    weekendStartDay?: number;
+    weekDaysNames?: string[];
+}
+interface ITimeStlot {
+    name: string;
+    startHour: number;
+}
+declare class TimeManager {
+    private constructor();
+    static set editSettings(value: ITimeSettings);
+    static get minDayHour(): number;
+    static get maxDayHour(): number;
+    static get defaultTimeSpent(): number;
+    static get newDayHour(): number;
+    static get timeSlots(): ITimeStlot[];
+    static get weekLength(): number;
+    static get weekendStartDay(): number;
+    static get weekDaysNames(): string[];
+    static get currentHour(): number;
+    static set currentHour(value: number | undefined);
+    static get currentDay(): number;
+    static set currentDay(value: number | undefined);
+    static get isWeekend(): boolean;
+    static get weekDayNumber(): number;
+    static get weekDayName(): string | undefined;
+    static newHour(timeSpent?: number): number;
+    static newDay(days?: number): number;
+    static nowIsBetween(fromHour: number, toHour: number): boolean;
+}
+
+export { ActivityModel, type ActivityProps, ExecutionTypeEnum, TimeManager as GameStepManager, Goal, type GoalProps, type ITimeSettings, LocationBaseModel, type LocationBaseModelProps, MapBaseModel, type MapBaseModelProps, QuestBaseModel, type QuestBaseModelProps, type QuestsRequiredType, RoomBaseModel, type RoomBaseModelProps, StageBaseModel, type StageBaseModelProps, addTemporaryCommitment, clearExpiredActivities, clearExpiredRoutine, currentActivities, getActivityById, getCommitmentByCharacter, getCommitmentById, getCueerntMap, getCurrenrLocation, getCurrentCommitments, getCurrentRoom, getFixedCommitments, getRoomById, getTemporaryCommitments, saveActivity, saveCommitment, saveRoom, setCurrentRoom, setFixedCommitments };