@drincs/pixi-vn 0.4.9 → 0.4.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/dist/classes/CharacterBaseModel.js.map +1 -1
  2. package/dist/classes/CharacterBaseModel.mjs.map +1 -1
  3. package/dist/classes/ChoiceMenuOptionLabel.d.mts +15 -8
  4. package/dist/classes/ChoiceMenuOptionLabel.d.ts +15 -8
  5. package/dist/classes/ChoiceMenuOptionLabel.js +9 -1
  6. package/dist/classes/ChoiceMenuOptionLabel.js.map +1 -1
  7. package/dist/classes/ChoiceMenuOptionLabel.mjs +9 -1
  8. package/dist/classes/ChoiceMenuOptionLabel.mjs.map +1 -1
  9. package/dist/classes/Label.d.mts +4 -3
  10. package/dist/classes/Label.d.ts +4 -3
  11. package/dist/classes/Label.js.map +1 -1
  12. package/dist/classes/Label.mjs.map +1 -1
  13. package/dist/classes/StoredClassModel.js.map +1 -1
  14. package/dist/classes/StoredClassModel.mjs.map +1 -1
  15. package/dist/classes/index.d.mts +3 -3
  16. package/dist/classes/index.d.ts +3 -3
  17. package/dist/classes/index.js +9 -1
  18. package/dist/classes/index.js.map +1 -1
  19. package/dist/classes/index.mjs +9 -1
  20. package/dist/classes/index.mjs.map +1 -1
  21. package/dist/classes/ticker/TickerFadeAlpha.js.map +1 -1
  22. package/dist/classes/ticker/TickerFadeAlpha.mjs.map +1 -1
  23. package/dist/classes/ticker/TickerMove.js.map +1 -1
  24. package/dist/classes/ticker/TickerMove.mjs.map +1 -1
  25. package/dist/classes/ticker/TickerRotate.js.map +1 -1
  26. package/dist/classes/ticker/TickerRotate.mjs.map +1 -1
  27. package/dist/classes/ticker/index.js.map +1 -1
  28. package/dist/classes/ticker/index.mjs.map +1 -1
  29. package/dist/constants.d.mts +1 -1
  30. package/dist/constants.d.ts +1 -1
  31. package/dist/constants.js +1 -1
  32. package/dist/constants.js.map +1 -1
  33. package/dist/constants.mjs +1 -1
  34. package/dist/constants.mjs.map +1 -1
  35. package/dist/decorators/LabelDecorator.d.mts +2 -1
  36. package/dist/decorators/LabelDecorator.d.ts +2 -1
  37. package/dist/decorators/index.d.mts +2 -2
  38. package/dist/decorators/index.d.ts +2 -2
  39. package/dist/functions/DialogueUtility.d.mts +6 -6
  40. package/dist/functions/DialogueUtility.d.ts +6 -6
  41. package/dist/functions/DialogueUtility.js.map +1 -1
  42. package/dist/functions/DialogueUtility.mjs.map +1 -1
  43. package/dist/functions/FlagsUtility.js.map +1 -1
  44. package/dist/functions/FlagsUtility.mjs.map +1 -1
  45. package/dist/functions/GameUtility.js.map +1 -1
  46. package/dist/functions/GameUtility.mjs.map +1 -1
  47. package/dist/functions/ImageUtility.js.map +1 -1
  48. package/dist/functions/ImageUtility.mjs.map +1 -1
  49. package/dist/functions/SavesUtility.d.mts +3 -3
  50. package/dist/functions/SavesUtility.d.ts +3 -3
  51. package/dist/functions/SavesUtility.js +1 -1
  52. package/dist/functions/SavesUtility.js.map +1 -1
  53. package/dist/functions/SavesUtility.mjs +1 -1
  54. package/dist/functions/SavesUtility.mjs.map +1 -1
  55. package/dist/functions/StepLabelUtility.d.mts +2 -1
  56. package/dist/functions/StepLabelUtility.d.ts +2 -1
  57. package/dist/functions/StepLabelUtility.js.map +1 -1
  58. package/dist/functions/StepLabelUtility.mjs.map +1 -1
  59. package/dist/functions/index.d.mts +7 -7
  60. package/dist/functions/index.d.ts +7 -7
  61. package/dist/functions/index.js +1 -1
  62. package/dist/functions/index.js.map +1 -1
  63. package/dist/functions/index.mjs +1 -1
  64. package/dist/functions/index.mjs.map +1 -1
  65. package/dist/index.d.mts +2 -2
  66. package/dist/index.d.ts +2 -2
  67. package/dist/index.js +10 -10
  68. package/dist/index.js.map +1 -1
  69. package/dist/index.mjs +11 -10
  70. package/dist/index.mjs.map +1 -1
  71. package/dist/interface/IDialogueHistory.d.mts +4 -4
  72. package/dist/interface/IDialogueHistory.d.ts +4 -4
  73. package/dist/interface/IHistoryStep.d.mts +2 -2
  74. package/dist/interface/IHistoryStep.d.ts +2 -2
  75. package/dist/interface/ISaveData.d.mts +3 -3
  76. package/dist/interface/ISaveData.d.ts +3 -3
  77. package/dist/interface/export/ExportedStep.d.mts +3 -3
  78. package/dist/interface/export/ExportedStep.d.ts +3 -3
  79. package/dist/interface/export/index.d.mts +3 -3
  80. package/dist/interface/export/index.d.ts +3 -3
  81. package/dist/interface/index.d.mts +4 -4
  82. package/dist/interface/index.d.ts +4 -4
  83. package/dist/managers/StepManager.d.mts +5 -5
  84. package/dist/managers/StepManager.d.ts +5 -5
  85. package/dist/managers/StepManager.js.map +1 -1
  86. package/dist/managers/StepManager.mjs.map +1 -1
  87. package/dist/managers/index.d.mts +4 -4
  88. package/dist/managers/index.d.ts +4 -4
  89. package/dist/managers/index.js.map +1 -1
  90. package/dist/managers/index.mjs.map +1 -1
  91. package/dist/override/StepLabelProps.d.mts +2 -1
  92. package/dist/override/StepLabelProps.d.ts +2 -1
  93. package/dist/override/StepLabelResult.d.mts +2 -1
  94. package/dist/override/StepLabelResult.d.ts +2 -1
  95. package/dist/types/ChoiceMenuOptionsType.d.mts +5 -4
  96. package/dist/types/ChoiceMenuOptionsType.d.ts +5 -4
  97. package/dist/types/LabelRunModeType.d.mts +3 -0
  98. package/dist/types/LabelRunModeType.d.ts +3 -0
  99. package/dist/types/LabelRunModeType.js +4 -0
  100. package/dist/types/LabelRunModeType.js.map +1 -0
  101. package/dist/types/LabelRunModeType.mjs +3 -0
  102. package/dist/types/LabelRunModeType.mjs.map +1 -0
  103. package/dist/types/StepLabelType.d.mts +3 -2
  104. package/dist/types/StepLabelType.d.ts +3 -2
  105. package/dist/types/StorageElementType.d.mts +6 -2
  106. package/dist/types/StorageElementType.d.ts +6 -2
  107. package/dist/types/index.d.mts +3 -3
  108. package/dist/types/index.d.ts +3 -3
  109. package/package.json +1 -1
  110. package/dist/enums/LabelRunModeEnum.d.mts +0 -9
  111. package/dist/enums/LabelRunModeEnum.d.ts +0 -9
  112. package/dist/enums/LabelRunModeEnum.js +0 -12
  113. package/dist/enums/LabelRunModeEnum.js.map +0 -1
  114. package/dist/enums/LabelRunModeEnum.mjs +0 -10
  115. package/dist/enums/LabelRunModeEnum.mjs.map +0 -1
  116. package/dist/enums/index.d.mts +0 -1
  117. package/dist/enums/index.d.ts +0 -1
  118. package/dist/enums/index.js +0 -12
  119. package/dist/enums/index.js.map +0 -1
  120. package/dist/enums/index.mjs +0 -10
  121. package/dist/enums/index.mjs.map +0 -1
@@ -6,7 +6,8 @@
6
6
  * // pixi-vn.types.ts
7
7
  * declare module '@drincs/pixi-vn/dist/override' {
8
8
  * interface StepLabelProps {
9
- * navigate: (route: string) => void
9
+ * navigate: (route: string) => void,
10
+ * [key: string]: any
10
11
  * }
11
12
  * }
12
13
  * ```
@@ -6,7 +6,8 @@
6
6
  * // pixi-vn.types.ts
7
7
  * declare module '@drincs/pixi-vn/dist/override' {
8
8
  * interface StepLabelProps {
9
- * navigate: (route: string) => void
9
+ * navigate: (route: string) => void,
10
+ * [key: string]: any
10
11
  * }
11
12
  * }
12
13
  * ```
@@ -7,7 +7,8 @@
7
7
  * // pixi-vn.types.ts
8
8
  * declare module '@drincs/pixi-vn/dist/override' {
9
9
  * interface StepLabelResult {
10
- * newRoute: string
10
+ * newRoute?: string,
11
+ * [key: string]: any
11
12
  * }
12
13
  * }
13
14
  * ```
@@ -7,7 +7,8 @@
7
7
  * // pixi-vn.types.ts
8
8
  * declare module '@drincs/pixi-vn/dist/override' {
9
9
  * interface StepLabelResult {
10
- * newRoute: string
10
+ * newRoute?: string,
11
+ * [key: string]: any
11
12
  * }
12
13
  * }
13
14
  * ```
@@ -1,15 +1,16 @@
1
1
  import ChoiceMenuOptionLabel from '../classes/ChoiceMenuOptionLabel.mjs';
2
- import '../enums/LabelRunModeEnum.mjs';
3
- import './LabelIdType.mjs';
2
+ import { StorageObjectType } from './StorageElementType.mjs';
4
3
  import '../classes/Label.mjs';
5
- import './StepHistoryDataType.mjs';
6
4
  import './StepLabelType.mjs';
7
5
  import '@drincs/pixi-vn/dist/override';
6
+ import './StepHistoryDataType.mjs';
7
+ import './LabelRunModeType.mjs';
8
+ import './LabelIdType.mjs';
8
9
 
9
10
  /**
10
11
  * Munu is a type that contains a list of Label that a player can choose from.
11
12
  * For Ren'py this is the equivalent of a menu.
12
13
  */
13
- type ChoiceMenuOptionsType = ChoiceMenuOptionLabel[];
14
+ type ChoiceMenuOptionsType<T extends StorageObjectType = {}> = ChoiceMenuOptionLabel<T>[];
14
15
 
15
16
  export type { ChoiceMenuOptionsType };
@@ -1,15 +1,16 @@
1
1
  import ChoiceMenuOptionLabel from '../classes/ChoiceMenuOptionLabel.js';
2
- import '../enums/LabelRunModeEnum.js';
3
- import './LabelIdType.js';
2
+ import { StorageObjectType } from './StorageElementType.js';
4
3
  import '../classes/Label.js';
5
- import './StepHistoryDataType.js';
6
4
  import './StepLabelType.js';
7
5
  import '@drincs/pixi-vn/dist/override';
6
+ import './StepHistoryDataType.js';
7
+ import './LabelRunModeType.js';
8
+ import './LabelIdType.js';
8
9
 
9
10
  /**
10
11
  * Munu is a type that contains a list of Label that a player can choose from.
11
12
  * For Ren'py this is the equivalent of a menu.
12
13
  */
13
- type ChoiceMenuOptionsType = ChoiceMenuOptionLabel[];
14
+ type ChoiceMenuOptionsType<T extends StorageObjectType = {}> = ChoiceMenuOptionLabel<T>[];
14
15
 
15
16
  export type { ChoiceMenuOptionsType };
@@ -0,0 +1,3 @@
1
+ type LabelRunModeType = "call" | "jump";
2
+
3
+ export type { LabelRunModeType as default };
@@ -0,0 +1,3 @@
1
+ type LabelRunModeType = "call" | "jump";
2
+
3
+ export type { LabelRunModeType as default };
@@ -0,0 +1,4 @@
1
+ 'use strict';
2
+
3
+ //# sourceMappingURL=out.js.map
4
+ //# sourceMappingURL=LabelRunModeType.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"names":[],"mappings":""}
@@ -0,0 +1,3 @@
1
+
2
+ //# sourceMappingURL=out.js.map
3
+ //# sourceMappingURL=LabelRunModeType.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"names":[],"mappings":""}
@@ -1,10 +1,11 @@
1
1
  import { StepLabelResult, StepLabelProps } from '@drincs/pixi-vn/dist/override';
2
+ import { StorageObjectType } from './StorageElementType.mjs';
2
3
 
3
4
  type StepLabelResultType = StepLabelResult | void;
4
- type StepLabelPropsType = StepLabelProps;
5
+ type StepLabelPropsType<T extends {} | StorageObjectType = {}> = StepLabelProps & T;
5
6
  /**
6
7
  * StepLabel is a function that will be executed as the game continues.
7
8
  */
8
- type StepLabelType = ((props?: StepLabelPropsType) => StepLabelResultType | Promise<StepLabelResultType>);
9
+ type StepLabelType<T extends {} | StorageObjectType = {}> = ((props?: StepLabelPropsType<T>) => StepLabelResultType | Promise<StepLabelResultType>);
9
10
 
10
11
  export type { StepLabelPropsType, StepLabelResultType, StepLabelType };
@@ -1,10 +1,11 @@
1
1
  import { StepLabelResult, StepLabelProps } from '@drincs/pixi-vn/dist/override';
2
+ import { StorageObjectType } from './StorageElementType.js';
2
3
 
3
4
  type StepLabelResultType = StepLabelResult | void;
4
- type StepLabelPropsType = StepLabelProps;
5
+ type StepLabelPropsType<T extends {} | StorageObjectType = {}> = StepLabelProps & T;
5
6
  /**
6
7
  * StepLabel is a function that will be executed as the game continues.
7
8
  */
8
- type StepLabelType = ((props?: StepLabelPropsType) => StepLabelResultType | Promise<StepLabelResultType>);
9
+ type StepLabelType<T extends {} | StorageObjectType = {}> = ((props?: StepLabelPropsType<T>) => StepLabelResultType | Promise<StepLabelResultType>);
9
10
 
10
11
  export type { StepLabelPropsType, StepLabelResultType, StepLabelType };
@@ -5,6 +5,10 @@ type StorageElementInternalType = StorageElementPrimaryType | Record<string | nu
5
5
  */
6
6
  type StorageElementType = StorageElementInternalType | Record<string | number | symbol, StorageElementInternalType> | {
7
7
  [key: string | number | symbol]: StorageElementType;
8
- };
8
+ } | StorageObjectType[];
9
+ /**
10
+ * StorageObjectType are all the types that can be stored in the storage
11
+ */
12
+ type StorageObjectType = Record<string | number | symbol, StorageElementType>;
9
13
 
10
- export type { StorageElementType };
14
+ export type { StorageElementType, StorageObjectType };
@@ -5,6 +5,10 @@ type StorageElementInternalType = StorageElementPrimaryType | Record<string | nu
5
5
  */
6
6
  type StorageElementType = StorageElementInternalType | Record<string | number | symbol, StorageElementInternalType> | {
7
7
  [key: string | number | symbol]: StorageElementType;
8
- };
8
+ } | StorageObjectType[];
9
+ /**
10
+ * StorageObjectType are all the types that can be stored in the storage
11
+ */
12
+ type StorageObjectType = Record<string | number | symbol, StorageElementType>;
9
13
 
10
- export type { StorageElementType };
14
+ export type { StorageElementType, StorageObjectType };
@@ -1,12 +1,12 @@
1
1
  export { CanvasEventNamesType } from './CanvasEventNamesType.mjs';
2
2
  export { ChoiceMenuOptionsType } from './ChoiceMenuOptionsType.mjs';
3
+ export { default as LabelRunModeType } from './LabelRunModeType.mjs';
3
4
  export { Pause, PauseType, PauseValueType } from './PauseType.mjs';
4
5
  export { Repeat, RepeatType } from './RepeatType.mjs';
5
6
  export { StepLabelType } from './StepLabelType.mjs';
6
- export { StorageElementType } from './StorageElementType.mjs';
7
+ export { StorageElementType, StorageObjectType } from './StorageElementType.mjs';
7
8
  import '../classes/ChoiceMenuOptionLabel.mjs';
8
- import '../enums/LabelRunModeEnum.mjs';
9
- import './LabelIdType.mjs';
10
9
  import '../classes/Label.mjs';
11
10
  import './StepHistoryDataType.mjs';
11
+ import './LabelIdType.mjs';
12
12
  import '@drincs/pixi-vn/dist/override';
@@ -1,12 +1,12 @@
1
1
  export { CanvasEventNamesType } from './CanvasEventNamesType.js';
2
2
  export { ChoiceMenuOptionsType } from './ChoiceMenuOptionsType.js';
3
+ export { default as LabelRunModeType } from './LabelRunModeType.js';
3
4
  export { Pause, PauseType, PauseValueType } from './PauseType.js';
4
5
  export { Repeat, RepeatType } from './RepeatType.js';
5
6
  export { StepLabelType } from './StepLabelType.js';
6
- export { StorageElementType } from './StorageElementType.js';
7
+ export { StorageElementType, StorageObjectType } from './StorageElementType.js';
7
8
  import '../classes/ChoiceMenuOptionLabel.js';
8
- import '../enums/LabelRunModeEnum.js';
9
- import './LabelIdType.js';
10
9
  import '../classes/Label.js';
11
10
  import './StepHistoryDataType.js';
11
+ import './LabelIdType.js';
12
12
  import '@drincs/pixi-vn/dist/override';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@drincs/pixi-vn",
3
- "version": "0.4.9",
3
+ "version": "0.4.11",
4
4
  "description": "Pixi'VN is a npm package that provides various features for creating visual novels.",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",
@@ -1,9 +0,0 @@
1
- /**
2
- * Enumeration of label modes that occurred during the progression of the steps.
3
- */
4
- declare enum LabelRunModeEnum {
5
- OpenByCall = "openbycall",
6
- OpenByJump = "openbyjump"
7
- }
8
-
9
- export { LabelRunModeEnum };
@@ -1,9 +0,0 @@
1
- /**
2
- * Enumeration of label modes that occurred during the progression of the steps.
3
- */
4
- declare enum LabelRunModeEnum {
5
- OpenByCall = "openbycall",
6
- OpenByJump = "openbyjump"
7
- }
8
-
9
- export { LabelRunModeEnum };
@@ -1,12 +0,0 @@
1
- 'use strict';
2
-
3
- // src/enums/LabelRunModeEnum.ts
4
- var LabelRunModeEnum = /* @__PURE__ */ ((LabelRunModeEnum2) => {
5
- LabelRunModeEnum2["OpenByCall"] = "openbycall";
6
- LabelRunModeEnum2["OpenByJump"] = "openbyjump";
7
- return LabelRunModeEnum2;
8
- })(LabelRunModeEnum || {});
9
-
10
- exports.LabelRunModeEnum = LabelRunModeEnum;
11
- //# sourceMappingURL=out.js.map
12
- //# sourceMappingURL=LabelRunModeEnum.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/enums/LabelRunModeEnum.ts"],"names":["LabelRunModeEnum"],"mappings":";AAGO,IAAK,mBAAL,kBAAKA,sBAAL;AACH,EAAAA,kBAAA,gBAAa;AACb,EAAAA,kBAAA,gBAAa;AAFL,SAAAA;AAAA,GAAA","sourcesContent":["/**\n * Enumeration of label modes that occurred during the progression of the steps.\n */\nexport enum LabelRunModeEnum {\n OpenByCall = \"openbycall\",\n OpenByJump = \"openbyjump\",\n}\n"]}
@@ -1,10 +0,0 @@
1
- // src/enums/LabelRunModeEnum.ts
2
- var LabelRunModeEnum = /* @__PURE__ */ ((LabelRunModeEnum2) => {
3
- LabelRunModeEnum2["OpenByCall"] = "openbycall";
4
- LabelRunModeEnum2["OpenByJump"] = "openbyjump";
5
- return LabelRunModeEnum2;
6
- })(LabelRunModeEnum || {});
7
-
8
- export { LabelRunModeEnum };
9
- //# sourceMappingURL=out.js.map
10
- //# sourceMappingURL=LabelRunModeEnum.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/enums/LabelRunModeEnum.ts"],"names":["LabelRunModeEnum"],"mappings":";AAGO,IAAK,mBAAL,kBAAKA,sBAAL;AACH,EAAAA,kBAAA,gBAAa;AACb,EAAAA,kBAAA,gBAAa;AAFL,SAAAA;AAAA,GAAA","sourcesContent":["/**\n * Enumeration of label modes that occurred during the progression of the steps.\n */\nexport enum LabelRunModeEnum {\n OpenByCall = \"openbycall\",\n OpenByJump = \"openbyjump\",\n}\n"]}
@@ -1 +0,0 @@
1
- export { LabelRunModeEnum } from './LabelRunModeEnum.mjs';
@@ -1 +0,0 @@
1
- export { LabelRunModeEnum } from './LabelRunModeEnum.js';
@@ -1,12 +0,0 @@
1
- 'use strict';
2
-
3
- // src/enums/LabelRunModeEnum.ts
4
- var LabelRunModeEnum = /* @__PURE__ */ ((LabelRunModeEnum2) => {
5
- LabelRunModeEnum2["OpenByCall"] = "openbycall";
6
- LabelRunModeEnum2["OpenByJump"] = "openbyjump";
7
- return LabelRunModeEnum2;
8
- })(LabelRunModeEnum || {});
9
-
10
- exports.LabelRunModeEnum = LabelRunModeEnum;
11
- //# sourceMappingURL=out.js.map
12
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/enums/LabelRunModeEnum.ts"],"names":["LabelRunModeEnum"],"mappings":";AAGO,IAAK,mBAAL,kBAAKA,sBAAL;AACH,EAAAA,kBAAA,gBAAa;AACb,EAAAA,kBAAA,gBAAa;AAFL,SAAAA;AAAA,GAAA","sourcesContent":["/**\n * Enumeration of label modes that occurred during the progression of the steps.\n */\nexport enum LabelRunModeEnum {\n OpenByCall = \"openbycall\",\n OpenByJump = \"openbyjump\",\n}\n"]}
@@ -1,10 +0,0 @@
1
- // src/enums/LabelRunModeEnum.ts
2
- var LabelRunModeEnum = /* @__PURE__ */ ((LabelRunModeEnum2) => {
3
- LabelRunModeEnum2["OpenByCall"] = "openbycall";
4
- LabelRunModeEnum2["OpenByJump"] = "openbyjump";
5
- return LabelRunModeEnum2;
6
- })(LabelRunModeEnum || {});
7
-
8
- export { LabelRunModeEnum };
9
- //# sourceMappingURL=out.js.map
10
- //# sourceMappingURL=index.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/enums/LabelRunModeEnum.ts"],"names":["LabelRunModeEnum"],"mappings":";AAGO,IAAK,mBAAL,kBAAKA,sBAAL;AACH,EAAAA,kBAAA,gBAAa;AACb,EAAAA,kBAAA,gBAAa;AAFL,SAAAA;AAAA,GAAA","sourcesContent":["/**\n * Enumeration of label modes that occurred during the progression of the steps.\n */\nexport enum LabelRunModeEnum {\n OpenByCall = \"openbycall\",\n OpenByJump = \"openbyjump\",\n}\n"]}