@drincs/nqtr 0.1.1 → 0.1.3

package/dist/classes/Activity.d.mts

@@ -0,0 +1,199 @@
+import OnRunActivityProps from '../override/OnRunActivityProps.mjs';
+import { GraphicItemType } from '../types/GraphicItem.mjs';
+import '@drincs/pixi-vn';
+
+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 TimeManager.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 TimeManager.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 element. Can be a string or an Element or a Pixi'VN CanvasItem
+     * @default undefined
+     */
+    icon?: GraphicItemType;
+}
+/**
+ * The function that is called when the activity is runned.
+ */
+type OnRunActivityEvent<T> = (activity: T, props?: OnRunActivityProps) => void;
+declare abstract class ActivityStoredAbstract {
+    /**
+     * @param onRun The function that is called when the activity is runned. Have 2 parameters: the runned activity and the yourParams object, that is an object with the parameters that you want to pass to the onRun function.
+     * @param props The activity properties.
+     */
+    constructor(onRun: OnRunActivityEvent<ActivityStoredAbstract>, props: ActivityProps);
+    abstract setStorageProperty<T>(propertyName: string, value: T | undefined): void;
+    abstract getStorageProperty<T>(propertyName: string): T | undefined;
+    abstract get id(): string;
+    private defaultName?;
+    /**
+     * The name
+     */
+    get name(): string;
+    set name(value: string | undefined);
+    private defaultFromHour?;
+    /**
+     * The hour when the activity starts. If the activity is not started yet, it will be hidden.
+     */
+    get fromHour(): number;
+    set fromHour(value: number | undefined);
+    private defaultToHour?;
+    /**
+     * The hour when the activity ends. If the activity is ended yet, it will be hidden.
+     */
+    get toHour(): number;
+    set toHour(value: number | undefined);
+    private defaultFromDay?;
+    /**
+     * The day when the activity starts. If the activity is not started yet, it will be hidden.
+     */
+    get fromDay(): number | undefined;
+    set fromDay(value: number | undefined);
+    private defaultToDay?;
+    /**
+     * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
+     */
+    get toDay(): number | undefined;
+    set toDay(value: number | undefined);
+    private defaultDisabled;
+    /**
+     * Whether is disabled.
+     */
+    get disabled(): boolean;
+    set disabled(value: boolean | string);
+    private defaultHidden;
+    /**
+     * Whether is hidden. If the activity is not started yet, it will be hidden.
+     */
+    get hidden(): boolean;
+    set hidden(value: boolean | string);
+    private _icon?;
+    /**
+     * The icon element.
+     */
+    get icon(): GraphicItemType | undefined;
+    private _onRun;
+    /**
+     * The function that is called when the activity is runned.
+     */
+    get onRun(): () => void;
+    /**
+     * Whether the activity is a deadline.
+     * @returns Whether the activity is a deadline.
+     */
+    isExpired(): boolean;
+    /**
+     * Export the activity properties.
+     * @returns The activity properties.
+     */
+    export(): ActivityProps;
+}
+/**
+ * The activity model.
+ */
+declare class ActivityModel {
+    /**
+     * @param id The activity id, that must be unique.
+     * @param onRun The function that is called when the activity is runned. Have 2 parameters: the runned activity and the yourParams object, that is an object with the parameters that you want to pass to the onRun function.
+     * @param props The activity properties.
+     */
+    constructor(id: string, onRun: OnRunActivityEvent<ActivityModel>, props: ActivityProps);
+    private _id;
+    /**
+     * The activity id, that is unique.
+     */
+    get id(): string;
+    private _name?;
+    /**
+     * The name
+     */
+    get name(): string | undefined;
+    private _fromHour?;
+    /**
+     * The hour when the activity starts. If the activity is not started yet, it will be hidden.
+     */
+    get fromHour(): number | undefined;
+    private _toHour?;
+    /**
+     * The hour when the activity ends. If the activity is ended yet, it will be hidden.
+     */
+    get toHour(): number | undefined;
+    private _fromDay?;
+    /**
+     * The day when the activity starts. If the activity is not started yet, it will be hidden.
+     */
+    get fromDay(): number | undefined;
+    private _toDay?;
+    /**
+     * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
+     */
+    get toDay(): number | undefined;
+    private _disabled?;
+    /**
+     * Whether is disabled.
+     */
+    get disabled(): boolean | undefined;
+    private _hidden;
+    /**
+     * Whether is hidden. If the activity is not started yet, it will be hidden.
+     */
+    get hidden(): boolean;
+    private _icon?;
+    /**
+     * The icon element.
+     */
+    get icon(): GraphicItemType | undefined;
+    private _onRun;
+    /**
+     * The function that is called when the activity is runned.
+     */
+    get onRun(): () => void;
+    /**
+     * Whether the activity is a deadline.
+     * @returns Whether the activity is a deadline.
+     */
+    isDeadline(): boolean;
+    /**
+     * Export the activity properties.
+     * @returns The activity properties.
+     */
+    export(): ActivityProps;
+}
+
+export { type ActivityProps, ActivityStoredAbstract, type OnRunActivityEvent, ActivityModel as default };

package/dist/classes/Activity.d.ts

@@ -0,0 +1,199 @@
+import OnRunActivityProps from '../override/OnRunActivityProps.js';
+import { GraphicItemType } from '../types/GraphicItem.js';
+import '@drincs/pixi-vn';
+
+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 TimeManager.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 TimeManager.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 element. Can be a string or an Element or a Pixi'VN CanvasItem
+     * @default undefined
+     */
+    icon?: GraphicItemType;
+}
+/**
+ * The function that is called when the activity is runned.
+ */
+type OnRunActivityEvent<T> = (activity: T, props?: OnRunActivityProps) => void;
+declare abstract class ActivityStoredAbstract {
+    /**
+     * @param onRun The function that is called when the activity is runned. Have 2 parameters: the runned activity and the yourParams object, that is an object with the parameters that you want to pass to the onRun function.
+     * @param props The activity properties.
+     */
+    constructor(onRun: OnRunActivityEvent<ActivityStoredAbstract>, props: ActivityProps);
+    abstract setStorageProperty<T>(propertyName: string, value: T | undefined): void;
+    abstract getStorageProperty<T>(propertyName: string): T | undefined;
+    abstract get id(): string;
+    private defaultName?;
+    /**
+     * The name
+     */
+    get name(): string;
+    set name(value: string | undefined);
+    private defaultFromHour?;
+    /**
+     * The hour when the activity starts. If the activity is not started yet, it will be hidden.
+     */
+    get fromHour(): number;
+    set fromHour(value: number | undefined);
+    private defaultToHour?;
+    /**
+     * The hour when the activity ends. If the activity is ended yet, it will be hidden.
+     */
+    get toHour(): number;
+    set toHour(value: number | undefined);
+    private defaultFromDay?;
+    /**
+     * The day when the activity starts. If the activity is not started yet, it will be hidden.
+     */
+    get fromDay(): number | undefined;
+    set fromDay(value: number | undefined);
+    private defaultToDay?;
+    /**
+     * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
+     */
+    get toDay(): number | undefined;
+    set toDay(value: number | undefined);
+    private defaultDisabled;
+    /**
+     * Whether is disabled.
+     */
+    get disabled(): boolean;
+    set disabled(value: boolean | string);
+    private defaultHidden;
+    /**
+     * Whether is hidden. If the activity is not started yet, it will be hidden.
+     */
+    get hidden(): boolean;
+    set hidden(value: boolean | string);
+    private _icon?;
+    /**
+     * The icon element.
+     */
+    get icon(): GraphicItemType | undefined;
+    private _onRun;
+    /**
+     * The function that is called when the activity is runned.
+     */
+    get onRun(): () => void;
+    /**
+     * Whether the activity is a deadline.
+     * @returns Whether the activity is a deadline.
+     */
+    isExpired(): boolean;
+    /**
+     * Export the activity properties.
+     * @returns The activity properties.
+     */
+    export(): ActivityProps;
+}
+/**
+ * The activity model.
+ */
+declare class ActivityModel {
+    /**
+     * @param id The activity id, that must be unique.
+     * @param onRun The function that is called when the activity is runned. Have 2 parameters: the runned activity and the yourParams object, that is an object with the parameters that you want to pass to the onRun function.
+     * @param props The activity properties.
+     */
+    constructor(id: string, onRun: OnRunActivityEvent<ActivityModel>, props: ActivityProps);
+    private _id;
+    /**
+     * The activity id, that is unique.
+     */
+    get id(): string;
+    private _name?;
+    /**
+     * The name
+     */
+    get name(): string | undefined;
+    private _fromHour?;
+    /**
+     * The hour when the activity starts. If the activity is not started yet, it will be hidden.
+     */
+    get fromHour(): number | undefined;
+    private _toHour?;
+    /**
+     * The hour when the activity ends. If the activity is ended yet, it will be hidden.
+     */
+    get toHour(): number | undefined;
+    private _fromDay?;
+    /**
+     * The day when the activity starts. If the activity is not started yet, it will be hidden.
+     */
+    get fromDay(): number | undefined;
+    private _toDay?;
+    /**
+     * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
+     */
+    get toDay(): number | undefined;
+    private _disabled?;
+    /**
+     * Whether is disabled.
+     */
+    get disabled(): boolean | undefined;
+    private _hidden;
+    /**
+     * Whether is hidden. If the activity is not started yet, it will be hidden.
+     */
+    get hidden(): boolean;
+    private _icon?;
+    /**
+     * The icon element.
+     */
+    get icon(): GraphicItemType | undefined;
+    private _onRun;
+    /**
+     * The function that is called when the activity is runned.
+     */
+    get onRun(): () => void;
+    /**
+     * Whether the activity is a deadline.
+     * @returns Whether the activity is a deadline.
+     */
+    isDeadline(): boolean;
+    /**
+     * Export the activity properties.
+     * @returns The activity properties.
+     */
+    export(): ActivityProps;
+}
+
+export { type ActivityProps, ActivityStoredAbstract, type OnRunActivityEvent, ActivityModel as default };