@drincs/nqtr 0.3.7 → 0.4.1

package/dist/index-B-x-OmU2.d.ts

@@ -0,0 +1,186 @@
+import { C as CommitmentInterface, R as RoomInterface, L as LocationInterface, M as MapInterface } from './RoomInterface-Cwm08AzD.js';
+import { OnRunProps } from '@drincs/nqtr';
+import { Q as QuestInterface } from './StageInterface-LDgQToad.js';
+import { CharacterInterface } from '@drincs/pixi-vn';
+import { TimeSettings, ITimeStlot } from './types/index.js';
+
+declare class TimeManager {
+    initialize(settings: TimeSettings): void;
+    get minDayHours(): number;
+    get maxDayHours(): number;
+    get defaultTimeSpent(): number;
+    get timeSlots(): ITimeStlot[];
+    get weekLength(): number;
+    get weekendStartDay(): number;
+    get weekDaysNames(): string[];
+    /**
+     * Get the current hour
+     */
+    get currentHour(): number;
+    set currentHour(value: number | undefined);
+    /**
+     * Get the current day
+     */
+    get currentDay(): number;
+    set currentDay(value: number | undefined);
+    /**
+     * If the current day is greater than or equal to the weekend start day, then it will return true.
+     */
+    get isWeekend(): boolean;
+    /**
+     * Get the current week day number (1 - {@link weekLength}).
+     * For example, if the week length is 7 and the current day is 10, then the result will be 4.
+     */
+    get currentWeekDayNumber(): number;
+    /**
+     * Get the current week day name. If the week days names are not defined, then it will return undefined.
+     * For example, if the week days names are ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'] and the current day is 10, then the result will be 'Thursday'.
+     * @default ""
+     */
+    get currentDayName(): string;
+    /**
+     * Get the current {@link timeSlots} index.
+     * You can use this property to create "Image that changes based on the time period":
+     * @example
+     * ```tsx
+     * import { weekLength } from '@drincs/nqtr';
+     *
+     * function changeBackground() {
+     *     return (
+     *         <img src={`background-currentTimeSlot.currentTimeSlot.png`} />
+     *     )
+     * }
+     */
+    get currentTimeSlot(): number;
+    /**
+     * This function will increase the current hour by the given time spent.
+     * If the new hour is greater than or equal to the max day hours, then it will increase the day and set the new hour.
+     * @param timeSpent is the time spent in hours (default: {@link defaultTimeSpent})
+     * @returns currentTimeSlot.currentHour
+     */
+    increaseHour(timeSpent?: number): number;
+    /**
+     * This function will increase the current day by the given days.
+     * @param newDayHour is the hour of the new day (default: {@link minDayHours})
+     * @param days is the number of days to increase (default: 1)
+     * @returns timeTracker.currentDay
+     */
+    increaseDay(newDayHour?: number, days?: number): number;
+    /**
+     * This function will check if the current hour is between the given hours.
+     * @param fromHour the starting hour. If the {@link currentHour} is equal to this hour, the function will return true.
+     * @param toHour the ending hour.
+     * @returns true if the current hour is between the given hours, otherwise false.
+     */
+    nowIsBetween(fromHour: number | undefined, toHour: number | undefined): boolean;
+}
+
+declare class RoutineManager {
+    get fixedRoutine(): CommitmentInterface[];
+    /**
+     * Set a commitment as fixed, it will be always available. They cannot be deleted or edit during the game session.
+     */
+    set fixedRoutine(commitments: CommitmentInterface[]);
+    /**
+     * Get the temporary commitments by its id.
+     * @returns The temporary commitments.
+     */
+    get temporaryRoutine(): CommitmentInterface[];
+    get allRoutine(): CommitmentInterface[];
+    /**
+     * This feature adds the commitments during the game session.
+     * @param commitment The commitment or commitments to add.
+     */
+    add(commitment: CommitmentInterface[] | CommitmentInterface): void;
+    /**
+     * Get the commitments added during the game session.
+     * @param id The id of the commitment.
+     * @returns The commitment or undefined if not found.
+     */
+    find(id: string): CommitmentInterface | undefined;
+    /**
+     * Remove the commitments added during the game session.
+     * @param commitment The commitment or commitments to remove.
+     */
+    remove(commitment: CommitmentInterface[] | CommitmentInterface): void;
+    /**
+     * Clear all the expired commitments.
+     */
+    clearExpiredRoutine(): void;
+    /**
+     * Get the current commitments. The hidden commitments are not included.
+     * In case there is a character who has two or more commitments at the same time, will be selected the commitment with the highest priority.
+     * Higher priority commitments are calculated using the following steps:
+     * 1. The commitments that have Commitments BaseModel.priority set to a higher value will be selected first.
+     * 2. If there are commitments with the same priority, the commitments that are not fixed will be selected first.
+     * 3. If there are commitments with the same priority and the same fixed status, priority will be given to the commitment with a lower index.
+     * @returns The current commitments.
+     */
+    get currentRoutine(): CommitmentInterface[];
+    get currentRoomRoutine(): CommitmentInterface[];
+    /**
+     * Get the character commitment.
+     * @param character The character.
+     * @returns The commitment or undefined if not found.
+     */
+    getCommitmentByCharacter(character: CharacterInterface): CommitmentInterface | undefined;
+}
+
+declare class QuestManager {
+    /**
+     * The quests registered in the game.
+     */
+    get quests(): QuestInterface[];
+    /**
+     * The quests that are started, so they are in progress or completed or failed.
+     */
+    get startedQuests(): QuestInterface[];
+    /**
+     * The quests that are in progress.
+     */
+    get inProgressQuests(): QuestInterface[];
+    /**
+     * The quests that are completed.
+     */
+    get completedQuests(): QuestInterface[];
+    /**
+     * The quests that are failed.
+     */
+    get failedQuests(): QuestInterface[];
+    /**
+     * The quests that are not started.
+     */
+    get notStartedQuests(): QuestInterface[];
+    /**
+     * Get the quest by the id.
+     * @param id The id of the quest.
+     * @returns The quest with the id.
+     */
+    find(id: string): QuestInterface | undefined;
+    /**
+     * Start the quests that must start on the current stage.
+     */
+    startsStageMustBeStarted(props: OnRunProps): Promise<void>;
+}
+
+declare class NavigatorManager {
+    get rooms(): RoomInterface[];
+    get locations(): LocationInterface[];
+    get maps(): MapInterface[];
+    get currentRoomId(): string | undefined;
+    get currentRoom(): RoomInterface | undefined;
+    set currentRoom(room: RoomInterface | string);
+    get currentLocation(): LocationInterface | undefined;
+    get currentMap(): MapInterface | undefined;
+    /**
+     * Clear all the expired activities.
+     */
+    clearExpiredActivities(): void;
+}
+
+declare const timeTracker: TimeManager;
+declare const navigator: NavigatorManager;
+declare const routine: RoutineManager;
+declare const questsNotebook: QuestManager;
+
+export { NavigatorManager as N, QuestManager as Q, RoutineManager as R, TimeManager as T, navigator as n, questsNotebook as q, routine as r, timeTracker as t };

package/dist/index-CJubtUni.d.mts

@@ -0,0 +1,301 @@
+import { C as CommitmentInterface, A as ActivityInterface } from './RoomInterface-BRA386zn.mjs';
+import { E as ExecutionType, a as OnRunEvent, Q as QuestInterface, d as QuestsRequiredType, S as StageInterface } from './StageInterface-LDgQToad.mjs';
+
+interface ActivityProps {
+    /**
+     * The name
+     * @default ""
+     */
+    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.
+     * @default timeTracker.minDayHours
+     */
+    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.
+     * @default timeTracker.maxDayHours + 1
+     */
+    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.
+     * @default undefined
+     */
+    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.
+     * @default undefined
+     */
+    toDay?: number;
+    /**
+     * Whether is disabled. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    disabled?: boolean | string;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    hidden?: boolean | string;
+    /**
+     * The icon of the activity.
+     * @default undefined
+     */
+    renderIcon?: string;
+}
+
+interface CommitmentProps {
+    /**
+     * The name
+     * @default ""
+     */
+    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.
+     * @default timeTracker.minDayHours
+     */
+    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.
+     * @default timeTracker.maxDayHours + 1
+     */
+    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.
+     * @default undefined
+     */
+    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.
+     * @default undefined
+     */
+    toDay?: number;
+    /**
+     * The image ofthe Commitment.
+     */
+    image?: string;
+    /**
+     * 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.
+     * If you set "automatic" remember to remove the commitment when it is no longer needed, because otherwise it repeats itself every time.
+     * @default "interaction"
+     */
+    executionType?: ExecutionType;
+    /**
+     * Is a function that is called when the player interacts with the character.
+     * @param commitment
+     * @returns
+     * @default undefined
+     */
+    onRun?: OnRunEvent<CommitmentInterface>;
+    /**
+     * 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.
+     * @default false
+     */
+    disabled?: boolean | string;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    hidden?: boolean | string;
+    /**
+     * The icon of the commitment.
+     */
+    icon?: string;
+    /**
+     * The priority. The higher the number, the higher the priority.
+     * To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.
+     * @default 0
+     */
+    priority?: number;
+}
+
+interface LocationBaseModelProps {
+    /**
+     * The name
+     * @default ""
+     */
+    name?: string;
+    /**
+     * Whether is disabled. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    disabled?: boolean | string;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    hidden?: boolean | string;
+    /**
+     * The icon of the location.
+     * @default undefined
+     */
+    icon?: string;
+    /**
+     * The activities that are available in this location.
+     * @default []
+     */
+    activities?: ActivityInterface[];
+}
+
+interface MapBaseModelProps {
+    /**
+     * The name
+     * @default ""
+     */
+    name?: string;
+    /**
+     * The image of the map.
+     * @default undefined
+     */
+    image?: string;
+    /**
+     * The activities that are available in this map.
+     * @default []
+     */
+    activities?: ActivityInterface[];
+}
+
+interface RoomBaseModelProps {
+    /**
+     * The name
+     * @default ""
+     */
+    name?: string;
+    /**
+     * The image of the room.
+     * @default undefined
+     */
+    image?: string;
+    /**
+     * The activities that are available in this room.
+     * @default []
+     */
+    activities?: ActivityInterface[];
+    /**
+     * Whether is disabled. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    disabled?: boolean | string;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    hidden?: boolean | string;
+    /**
+     * The icon of the room.
+     * @default undefined
+     */
+    icon?: string;
+}
+
+interface QuestProps {
+    /**
+     * The name of the quest.
+     * @default ""
+     */
+    name?: string;
+    /**
+     * The description of the quest.
+     * @default ""
+     */
+    description?: string;
+    /**
+     * The icon of the quest.
+     * @default undefined
+     */
+    icon?: string;
+    /**
+     * The image of the quest.
+     */
+    image?: string;
+    /**
+     * If the quest is in development.
+     * @default false
+     */
+    inDevelopment?: boolean;
+    /**
+     * The function that will be executed when the quest starts.
+     */
+    onStart?: OnRunEvent<QuestInterface>;
+    /**
+     * The function that will be executed when a stage end in the quest.
+     */
+    onNextStage?: OnRunEvent<QuestInterface>;
+}
+
+interface StageFlags {
+    /**
+     * The flag for checking if the condition is met.
+     */
+    flag: string;
+    /**
+     * The description of the flag.
+     */
+    description: string;
+}
+
+interface StageProps {
+    /**
+     * The flags of the stage.
+     * @default []
+     */
+    flags?: StageFlags[];
+    /**
+     * The name of the stage.
+     * @default ""
+     */
+    name?: string;
+    /**
+     * The description of the stage.
+     * @default ""
+     */
+    description?: string;
+    /**
+     * The advice description of the stage.
+     * @default ""
+     */
+    adviceDescription?: string;
+    /**
+     * The image of the stage.
+     */
+    image?: string;
+    /**
+     * The day required to start the stage.
+     * @example If the value is 3, and the previous stage ends on day 1, the stage will start on day 4.
+     */
+    daysRequiredToStart?: number;
+    /**
+     * The flags required to start the stage.
+     * @default []
+     */
+    flagsRequiredToStart?: StageFlags[];
+    /**
+     * The quests required to start the stage.
+     * @default []
+     */
+    questsRequiredToStart?: QuestsRequiredType[];
+    /**
+     * The description to request to start the stage.
+     * @default ""
+     */
+    requestDescriptionToStart?: string;
+    /**
+     * The function that will be executed when the stage starts.
+     */
+    onStart?: OnRunEvent<StageInterface>;
+    /**
+     * The function that will be executed when the stage ends.
+     */
+    onEnd?: OnRunEvent<StageInterface>;
+}
+
+export type { ActivityProps as A, CommitmentProps as C, LocationBaseModelProps as L, MapBaseModelProps as M, QuestProps as Q, RoomBaseModelProps as R, StageProps as S, StageFlags as a };