@drincs/pixi-vn 0.6.0 → 0.6.2

package/dist/decorators/EventDecorator.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/decorators/EventDecorator.ts"],"names":[],"mappings":";AAQO,IAAM,mBAAsF,CAAC;AAQrF,SAAR,eAAgC,MAAoB;AACvD,SAAO,SAAU,QAAiC;AAC9C,QAAI,CAAC,MAAM;AACP,aAAO,OAAO;AAAA,IAClB;AACA,QAAI,iBAAiB,IAAI,GAAG;AACxB,cAAQ,KAAK,mBAAmB,IAAI,yCAAyC;AAAA,IACjF;AACA,qBAAiB,IAAI,IAAI;AAAA,EAC7B;AACJ;AAOO,SAAS,wBAAiE,WAAuC;AACpH,MAAI;AACA,QAAI,YAAY,iBAAiB,SAAS;AAC1C,QAAI,CAAC,WAAW;AACZ,cAAQ,MAAM,mBAAmB,SAAS,YAAY;AACtD;AAAA,IACJ;AACA,QAAI,UAAU;AACd,WAAO;AAAA,EACX,SACO,GAAG;AACN,YAAQ,MAAM,uCAAuC,SAAS,IAAI,CAAC;AACnE;AAAA,EACJ;AACJ;AAOO,SAAS,4BAA8D,WAAuC;AACjH,MAAI;AACA,QAAI,YAAY,iBAAiB,SAAS;AAC1C,QAAI,CAAC,WAAW;AACZ,cAAQ,MAAM,mBAAmB,SAAS,YAAY;AACtD;AAAA,IACJ;AACA,QAAI,QAAQ,IAAI,UAAU;AAC1B,WAAO;AAAA,EACX,SACO,GAAG;AACN,YAAQ,MAAM,uCAAuC,SAAS,IAAI,CAAC;AACnE;AAAA,EACJ;AACJ","sourcesContent":["import { CanvasEvent } from \"../classes\"\nimport CanvasBase from \"../classes/canvas/CanvasBase\"\nimport { CanvasEventNamesType } from \"../types/CanvasEventNamesType\"\nimport { EventIdType } from \"../types/EventIdType\"\n\n/**\n * Canvas Event Register\n */\nexport const registeredEvents: { [name: EventIdType]: typeof CanvasEvent<CanvasEventNamesType> } = {}\n/**\n * Is a decorator that register a event in the game.\n * Is a required decorator for use the event in the game.\n * Thanks to this decoration the game has the possibility of updating the events to the latest modification and saving the game.\n * @param name is th identifier of the event, by default is the name of the class\n * @returns \n */\nexport default function eventDecorator(name?: EventIdType) {\n    return function (target: typeof CanvasEvent<any>) {\n        if (!name) {\n            name = target.name\n        }\n        if (registeredEvents[name]) {\n            console.warn(`[Pixi'VN] Event ${name} already exists, it will be overwritten`)\n        }\n        registeredEvents[name] = target\n    }\n}\n\n/**\n * Get an event type by the class name.\n * @param eventName The name of the class.\n * @returns The event type.\n */\nexport function getEventTypeByClassName<T = typeof CanvasEvent<CanvasBase<any>>>(eventName: EventIdType): T | undefined {\n    try {\n        let eventType = registeredEvents[eventName]\n        if (!eventType) {\n            console.error(`[Pixi'VN] Event ${eventName} not found`)\n            return\n        }\n        new eventType()\n        return eventType as T\n    }\n    catch (e) {\n        console.error(`[Pixi'VN] Error while getting Event ${eventName}`, e)\n        return\n    }\n}\n\n/**\n * Get an event instance by the class name.\n * @param eventName The name of the class.\n * @returns The event instance.\n */\nexport function getEventInstanceByClassName<T = CanvasEvent<CanvasBase<any>>>(eventName: EventIdType): T | undefined {\n    try {\n        let eventType = registeredEvents[eventName]\n        if (!eventType) {\n            console.error(`[Pixi'VN] Event ${eventName} not found`)\n            return\n        }\n        let event = new eventType()\n        return event as T\n    }\n    catch (e) {\n        console.error(`[Pixi'VN] Error while getting Event ${eventName}`, e)\n        return\n    }\n}\n"]}
+{"version":3,"sources":["../../src/decorators/EventDecorator.ts"],"names":[],"mappings":";AAQO,IAAM,mBAAsF,CAAC;AAQrF,SAAR,eAAgC,MAAoB;AACvD,SAAO,SAAU,QAAiC;AAC9C,QAAI,CAAC,MAAM;AACP,aAAO,OAAO;AAAA,IAClB;AACA,QAAI,iBAAiB,IAAI,GAAG;AACxB,cAAQ,KAAK,mBAAmB,IAAI,yCAAyC;AAAA,IACjF;AACA,WAAO,UAAU,KAAK;AACtB,qBAAiB,IAAI,IAAI;AAAA,EAC7B;AACJ;AAOO,SAAS,iBAA0D,SAAqC;AAC3G,MAAI;AACA,QAAI,YAAY,iBAAiB,OAAO;AACxC,QAAI,CAAC,WAAW;AACZ,cAAQ,MAAM,mBAAmB,OAAO,YAAY;AACpD;AAAA,IACJ;AACA,QAAI,UAAU;AACd,WAAO;AAAA,EACX,SACO,GAAG;AACN,YAAQ,MAAM,uCAAuC,OAAO,IAAI,CAAC;AACjE;AAAA,EACJ;AACJ;AAOO,SAAS,qBAAuD,SAAqC;AACxG,MAAI;AACA,QAAI,YAAY,iBAAiB,OAAO;AACxC,QAAI,CAAC,WAAW;AACZ,cAAQ,MAAM,mBAAmB,OAAO,YAAY;AACpD;AAAA,IACJ;AACA,QAAI,QAAQ,IAAI,UAAU;AAC1B,WAAO;AAAA,EACX,SACO,GAAG;AACN,YAAQ,MAAM,uCAAuC,OAAO,IAAI,CAAC;AACjE;AAAA,EACJ;AACJ","sourcesContent":["import { CanvasEvent } from \"../classes\"\nimport CanvasBase from \"../classes/canvas/CanvasBase\"\nimport { CanvasEventNamesType } from \"../types\"\nimport { EventIdType } from \"../types/EventIdType\"\n\n/**\n * Canvas Event Register\n */\nexport const registeredEvents: { [name: EventIdType]: typeof CanvasEvent<CanvasEventNamesType> } = {}\n/**\n * Is a decorator that register a event in the game.\n * Is a required decorator for use the event in the game.\n * Thanks to this decoration the game has the possibility of updating the events to the latest modification and saving the game.\n * @param name is th identifier of the event, by default is the name of the class\n * @returns \n */\nexport default function eventDecorator(name?: EventIdType) {\n    return function (target: typeof CanvasEvent<any>) {\n        if (!name) {\n            name = target.name\n        }\n        if (registeredEvents[name]) {\n            console.info(`[Pixi'VN] Event ${name} already exists, it will be overwritten`)\n        }\n        target.prototype.id = name\n        registeredEvents[name] = target\n    }\n}\n\n/**\n * Get an event by the id.\n * @param eventId The id of the event.\n * @returns The event type.\n */\nexport function getEventTypeById<T = typeof CanvasEvent<CanvasBase<any>>>(eventId: EventIdType): T | undefined {\n    try {\n        let eventType = registeredEvents[eventId]\n        if (!eventType) {\n            console.error(`[Pixi'VN] Event ${eventId} not found`)\n            return\n        }\n        new eventType()\n        return eventType as T\n    }\n    catch (e) {\n        console.error(`[Pixi'VN] Error while getting Event ${eventId}`, e)\n        return\n    }\n}\n\n/**\n * Get an event instance by the id.\n * @param eventId The id of the event.\n * @returns The event instance.\n */\nexport function getEventInstanceById<T = CanvasEvent<CanvasBase<any>>>(eventId: EventIdType): T | undefined {\n    try {\n        let eventType = registeredEvents[eventId]\n        if (!eventType) {\n            console.error(`[Pixi'VN] Event ${eventId} not found`)\n            return\n        }\n        let event = new eventType()\n        return event as T\n    }\n    catch (e) {\n        console.error(`[Pixi'VN] Error while getting Event ${eventId}`, e)\n        return\n    }\n}\n"]}

package/dist/decorators/EventDecorator.mjs

@@ -6,40 +6,41 @@ function eventDecorator(name) {
       name = target.name;
     }
     if (registeredEvents[name]) {
-      console.warn(`[Pixi'VN] Event ${name} already exists, it will be overwritten`);
+      console.info(`[Pixi'VN] Event ${name} already exists, it will be overwritten`);
     }
+    target.prototype.id = name;
     registeredEvents[name] = target;
   };
 }
-function getEventTypeByClassName(eventName) {
+function getEventTypeById(eventId) {
   try {
-    let eventType = registeredEvents[eventName];
+    let eventType = registeredEvents[eventId];
     if (!eventType) {
-      console.error(`[Pixi'VN] Event ${eventName} not found`);
+      console.error(`[Pixi'VN] Event ${eventId} not found`);
       return;
     }
     new eventType();
     return eventType;
   } catch (e) {
-    console.error(`[Pixi'VN] Error while getting Event ${eventName}`, e);
+    console.error(`[Pixi'VN] Error while getting Event ${eventId}`, e);
     return;
   }
 }
-function getEventInstanceByClassName(eventName) {
+function getEventInstanceById(eventId) {
   try {
-    let eventType = registeredEvents[eventName];
+    let eventType = registeredEvents[eventId];
     if (!eventType) {
-      console.error(`[Pixi'VN] Event ${eventName} not found`);
+      console.error(`[Pixi'VN] Event ${eventId} not found`);
       return;
     }
     let event = new eventType();
     return event;
   } catch (e) {
-    console.error(`[Pixi'VN] Error while getting Event ${eventName}`, e);
+    console.error(`[Pixi'VN] Error while getting Event ${eventId}`, e);
     return;
   }
 }
 
-export { eventDecorator as default, getEventInstanceByClassName, getEventTypeByClassName, registeredEvents };
+export { eventDecorator as default, getEventInstanceById, getEventTypeById, registeredEvents };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=EventDecorator.mjs.map

package/dist/decorators/EventDecorator.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/decorators/EventDecorator.ts"],"names":[],"mappings":";AAQO,IAAM,mBAAsF,CAAC;AAQrF,SAAR,eAAgC,MAAoB;AACvD,SAAO,SAAU,QAAiC;AAC9C,QAAI,CAAC,MAAM;AACP,aAAO,OAAO;AAAA,IAClB;AACA,QAAI,iBAAiB,IAAI,GAAG;AACxB,cAAQ,KAAK,mBAAmB,IAAI,yCAAyC;AAAA,IACjF;AACA,qBAAiB,IAAI,IAAI;AAAA,EAC7B;AACJ;AAOO,SAAS,wBAAiE,WAAuC;AACpH,MAAI;AACA,QAAI,YAAY,iBAAiB,SAAS;AAC1C,QAAI,CAAC,WAAW;AACZ,cAAQ,MAAM,mBAAmB,SAAS,YAAY;AACtD;AAAA,IACJ;AACA,QAAI,UAAU;AACd,WAAO;AAAA,EACX,SACO,GAAG;AACN,YAAQ,MAAM,uCAAuC,SAAS,IAAI,CAAC;AACnE;AAAA,EACJ;AACJ;AAOO,SAAS,4BAA8D,WAAuC;AACjH,MAAI;AACA,QAAI,YAAY,iBAAiB,SAAS;AAC1C,QAAI,CAAC,WAAW;AACZ,cAAQ,MAAM,mBAAmB,SAAS,YAAY;AACtD;AAAA,IACJ;AACA,QAAI,QAAQ,IAAI,UAAU;AAC1B,WAAO;AAAA,EACX,SACO,GAAG;AACN,YAAQ,MAAM,uCAAuC,SAAS,IAAI,CAAC;AACnE;AAAA,EACJ;AACJ","sourcesContent":["import { CanvasEvent } from \"../classes\"\nimport CanvasBase from \"../classes/canvas/CanvasBase\"\nimport { CanvasEventNamesType } from \"../types/CanvasEventNamesType\"\nimport { EventIdType } from \"../types/EventIdType\"\n\n/**\n * Canvas Event Register\n */\nexport const registeredEvents: { [name: EventIdType]: typeof CanvasEvent<CanvasEventNamesType> } = {}\n/**\n * Is a decorator that register a event in the game.\n * Is a required decorator for use the event in the game.\n * Thanks to this decoration the game has the possibility of updating the events to the latest modification and saving the game.\n * @param name is th identifier of the event, by default is the name of the class\n * @returns \n */\nexport default function eventDecorator(name?: EventIdType) {\n    return function (target: typeof CanvasEvent<any>) {\n        if (!name) {\n            name = target.name\n        }\n        if (registeredEvents[name]) {\n            console.warn(`[Pixi'VN] Event ${name} already exists, it will be overwritten`)\n        }\n        registeredEvents[name] = target\n    }\n}\n\n/**\n * Get an event type by the class name.\n * @param eventName The name of the class.\n * @returns The event type.\n */\nexport function getEventTypeByClassName<T = typeof CanvasEvent<CanvasBase<any>>>(eventName: EventIdType): T | undefined {\n    try {\n        let eventType = registeredEvents[eventName]\n        if (!eventType) {\n            console.error(`[Pixi'VN] Event ${eventName} not found`)\n            return\n        }\n        new eventType()\n        return eventType as T\n    }\n    catch (e) {\n        console.error(`[Pixi'VN] Error while getting Event ${eventName}`, e)\n        return\n    }\n}\n\n/**\n * Get an event instance by the class name.\n * @param eventName The name of the class.\n * @returns The event instance.\n */\nexport function getEventInstanceByClassName<T = CanvasEvent<CanvasBase<any>>>(eventName: EventIdType): T | undefined {\n    try {\n        let eventType = registeredEvents[eventName]\n        if (!eventType) {\n            console.error(`[Pixi'VN] Event ${eventName} not found`)\n            return\n        }\n        let event = new eventType()\n        return event as T\n    }\n    catch (e) {\n        console.error(`[Pixi'VN] Error while getting Event ${eventName}`, e)\n        return\n    }\n}\n"]}
+{"version":3,"sources":["../../src/decorators/EventDecorator.ts"],"names":[],"mappings":";AAQO,IAAM,mBAAsF,CAAC;AAQrF,SAAR,eAAgC,MAAoB;AACvD,SAAO,SAAU,QAAiC;AAC9C,QAAI,CAAC,MAAM;AACP,aAAO,OAAO;AAAA,IAClB;AACA,QAAI,iBAAiB,IAAI,GAAG;AACxB,cAAQ,KAAK,mBAAmB,IAAI,yCAAyC;AAAA,IACjF;AACA,WAAO,UAAU,KAAK;AACtB,qBAAiB,IAAI,IAAI;AAAA,EAC7B;AACJ;AAOO,SAAS,iBAA0D,SAAqC;AAC3G,MAAI;AACA,QAAI,YAAY,iBAAiB,OAAO;AACxC,QAAI,CAAC,WAAW;AACZ,cAAQ,MAAM,mBAAmB,OAAO,YAAY;AACpD;AAAA,IACJ;AACA,QAAI,UAAU;AACd,WAAO;AAAA,EACX,SACO,GAAG;AACN,YAAQ,MAAM,uCAAuC,OAAO,IAAI,CAAC;AACjE;AAAA,EACJ;AACJ;AAOO,SAAS,qBAAuD,SAAqC;AACxG,MAAI;AACA,QAAI,YAAY,iBAAiB,OAAO;AACxC,QAAI,CAAC,WAAW;AACZ,cAAQ,MAAM,mBAAmB,OAAO,YAAY;AACpD;AAAA,IACJ;AACA,QAAI,QAAQ,IAAI,UAAU;AAC1B,WAAO;AAAA,EACX,SACO,GAAG;AACN,YAAQ,MAAM,uCAAuC,OAAO,IAAI,CAAC;AACjE;AAAA,EACJ;AACJ","sourcesContent":["import { CanvasEvent } from \"../classes\"\nimport CanvasBase from \"../classes/canvas/CanvasBase\"\nimport { CanvasEventNamesType } from \"../types\"\nimport { EventIdType } from \"../types/EventIdType\"\n\n/**\n * Canvas Event Register\n */\nexport const registeredEvents: { [name: EventIdType]: typeof CanvasEvent<CanvasEventNamesType> } = {}\n/**\n * Is a decorator that register a event in the game.\n * Is a required decorator for use the event in the game.\n * Thanks to this decoration the game has the possibility of updating the events to the latest modification and saving the game.\n * @param name is th identifier of the event, by default is the name of the class\n * @returns \n */\nexport default function eventDecorator(name?: EventIdType) {\n    return function (target: typeof CanvasEvent<any>) {\n        if (!name) {\n            name = target.name\n        }\n        if (registeredEvents[name]) {\n            console.info(`[Pixi'VN] Event ${name} already exists, it will be overwritten`)\n        }\n        target.prototype.id = name\n        registeredEvents[name] = target\n    }\n}\n\n/**\n * Get an event by the id.\n * @param eventId The id of the event.\n * @returns The event type.\n */\nexport function getEventTypeById<T = typeof CanvasEvent<CanvasBase<any>>>(eventId: EventIdType): T | undefined {\n    try {\n        let eventType = registeredEvents[eventId]\n        if (!eventType) {\n            console.error(`[Pixi'VN] Event ${eventId} not found`)\n            return\n        }\n        new eventType()\n        return eventType as T\n    }\n    catch (e) {\n        console.error(`[Pixi'VN] Error while getting Event ${eventId}`, e)\n        return\n    }\n}\n\n/**\n * Get an event instance by the id.\n * @param eventId The id of the event.\n * @returns The event instance.\n */\nexport function getEventInstanceById<T = CanvasEvent<CanvasBase<any>>>(eventId: EventIdType): T | undefined {\n    try {\n        let eventType = registeredEvents[eventId]\n        if (!eventType) {\n            console.error(`[Pixi'VN] Event ${eventId} not found`)\n            return\n        }\n        let event = new eventType()\n        return event as T\n    }\n    catch (e) {\n        console.error(`[Pixi'VN] Error while getting Event ${eventId}`, e)\n        return\n    }\n}\n"]}

package/dist/decorators/LabelDecorator.d.mts

@@ -1,14 +1,15 @@
-import { StepLabelType } from '../types/StepLabelType.mjs';
 import { LabelIdType } from '../types/LabelIdType.mjs';
 import Label from '../classes/Label.mjs';
-import '@drincs/pixi-vn/dist/override';
+import { StepLabelType } from '../types/StepLabelType.mjs';
 import '../types/StepHistoryDataType.mjs';
+import '@drincs/pixi-vn/dist/override';
 
 declare const registeredLabels: {
     [key: LabelIdType]: Label<any>;
 };
 /**
- * Creates a new label and registers it in the system
+ * Creates a new label and registers it in the system.
+ * **This function must be called at least once at system startup to register the label, otherwise the system cannot be used.**
  * @param id The id of the label, it must be unique
  * @param steps The steps of the label
  * @param onStepRun is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached

package/dist/decorators/LabelDecorator.d.ts

@@ -1,14 +1,15 @@
-import { StepLabelType } from '../types/StepLabelType.js';
 import { LabelIdType } from '../types/LabelIdType.js';
 import Label from '../classes/Label.js';
-import '@drincs/pixi-vn/dist/override';
+import { StepLabelType } from '../types/StepLabelType.js';
 import '../types/StepHistoryDataType.js';
+import '@drincs/pixi-vn/dist/override';
 
 declare const registeredLabels: {
     [key: LabelIdType]: Label<any>;
 };
 /**
- * Creates a new label and registers it in the system
+ * Creates a new label and registers it in the system.
+ * **This function must be called at least once at system startup to register the label, otherwise the system cannot be used.**
  * @param id The id of the label, it must be unique
  * @param steps The steps of the label
  * @param onStepRun is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached