@drincs/nqtr 0.1.15 → 0.1.17

package/dist/ActivityProps-BoJeWa2B.d.mts

@@ -0,0 +1,124 @@
+import { OnRenderGraphicItemProps, GraphicItemType, OnRunProps } from '@drincs/nqtr/dist/override';
+import { OnRunActivityEvent } from './types/OnRunActivityEvent.mjs';
+
+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 _renderIcon?;
+    /**
+     * The function for rendering the icon of the activity.
+     */
+    get renderIcon(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
+    private _onRun;
+    /**
+     * The function that is called when the activity is runned.
+     */
+    get onRun(): (props: OnRunProps) => 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;
+}
+
+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
+     */
+    renderIcon?: GraphicItemType | ((activity: ActivityStoredAbstract, props: OnRenderGraphicItemProps) => GraphicItemType);
+}
+
+export { type ActivityProps as A, ActivityStoredAbstract as a };

package/dist/ActivityProps-_79x9-BX.d.ts

@@ -0,0 +1,124 @@
+import { OnRenderGraphicItemProps, GraphicItemType, OnRunProps } from '@drincs/nqtr/dist/override';
+import { OnRunActivityEvent } from './types/OnRunActivityEvent.js';
+
+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 _renderIcon?;
+    /**
+     * The function for rendering the icon of the activity.
+     */
+    get renderIcon(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
+    private _onRun;
+    /**
+     * The function that is called when the activity is runned.
+     */
+    get onRun(): (props: OnRunProps) => 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;
+}
+
+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
+     */
+    renderIcon?: GraphicItemType | ((activity: ActivityStoredAbstract, props: OnRenderGraphicItemProps) => GraphicItemType);
+}
+
+export { type ActivityProps as A, ActivityStoredAbstract as a };