@drincs/nqtr 0.2.1 → 0.2.2

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 (105) hide show
  1. package/dist/{StageProps-CkXejAbn.d.mts → StageProps-D002cyay.d.mts} +30 -2
  2. package/dist/{StageProps-BFsiCaZT.d.ts → StageProps-DleWO-vf.d.ts} +30 -2
  3. package/dist/classes/Commitment.d.mts +2 -2
  4. package/dist/classes/Commitment.d.ts +2 -2
  5. package/dist/classes/index.d.mts +4 -4
  6. package/dist/classes/index.d.ts +4 -4
  7. package/dist/classes/index.js +1 -131
  8. package/dist/classes/index.js.map +1 -1
  9. package/dist/classes/index.mjs +3 -132
  10. package/dist/classes/index.mjs.map +1 -1
  11. package/dist/classes/navigation/ActivityRoom.d.mts +2 -2
  12. package/dist/classes/navigation/ActivityRoom.d.ts +2 -2
  13. package/dist/classes/navigation/Location.d.mts +3 -3
  14. package/dist/classes/navigation/Location.d.ts +3 -3
  15. package/dist/classes/navigation/Map.d.mts +3 -3
  16. package/dist/classes/navigation/Map.d.ts +3 -3
  17. package/dist/classes/navigation/Room.d.mts +1 -1
  18. package/dist/classes/navigation/Room.d.ts +1 -1
  19. package/dist/classes/navigation/Room.js +43 -43
  20. package/dist/classes/navigation/Room.js.map +1 -1
  21. package/dist/classes/navigation/Room.mjs +43 -43
  22. package/dist/classes/navigation/Room.mjs.map +1 -1
  23. package/dist/classes/quest/Quest.d.mts +1 -1
  24. package/dist/classes/quest/Quest.d.ts +1 -1
  25. package/dist/classes/quest/Quest.js +107 -25
  26. package/dist/classes/quest/Quest.js.map +1 -1
  27. package/dist/classes/quest/Quest.mjs +107 -25
  28. package/dist/classes/quest/Quest.mjs.map +1 -1
  29. package/dist/classes/quest/Stage.d.mts +1 -1
  30. package/dist/classes/quest/Stage.d.ts +1 -1
  31. package/dist/classes/quest/Stage.js +34 -9
  32. package/dist/classes/quest/Stage.js.map +1 -1
  33. package/dist/classes/quest/Stage.mjs +34 -9
  34. package/dist/classes/quest/Stage.mjs.map +1 -1
  35. package/dist/decorators/ActivityDecorator.d.mts +10 -11
  36. package/dist/decorators/ActivityDecorator.d.ts +10 -11
  37. package/dist/decorators/ActivityDecorator.js +384 -9
  38. package/dist/decorators/ActivityDecorator.js.map +1 -1
  39. package/dist/decorators/ActivityDecorator.mjs +384 -9
  40. package/dist/decorators/ActivityDecorator.mjs.map +1 -1
  41. package/dist/decorators/CommitmentDecorator.d.mts +3 -3
  42. package/dist/decorators/CommitmentDecorator.d.ts +3 -3
  43. package/dist/decorators/QuestDecorator.d.mts +4 -3
  44. package/dist/decorators/QuestDecorator.d.ts +4 -3
  45. package/dist/decorators/QuestDecorator.js +107 -25
  46. package/dist/decorators/QuestDecorator.js.map +1 -1
  47. package/dist/decorators/QuestDecorator.mjs +107 -25
  48. package/dist/decorators/QuestDecorator.mjs.map +1 -1
  49. package/dist/decorators/RoomDecorator.d.mts +3 -3
  50. package/dist/decorators/RoomDecorator.d.ts +3 -3
  51. package/dist/decorators/index.d.mts +3 -3
  52. package/dist/decorators/index.d.ts +3 -3
  53. package/dist/decorators/index.js +328 -115
  54. package/dist/decorators/index.js.map +1 -1
  55. package/dist/decorators/index.mjs +329 -116
  56. package/dist/decorators/index.mjs.map +1 -1
  57. package/dist/functions/ActivityFunctions.d.mts +3 -3
  58. package/dist/functions/ActivityFunctions.d.ts +3 -3
  59. package/dist/functions/ActivityFunctions.js.map +1 -1
  60. package/dist/functions/ActivityFunctions.mjs.map +1 -1
  61. package/dist/functions/NavigationFunctions.d.mts +3 -3
  62. package/dist/functions/NavigationFunctions.d.ts +3 -3
  63. package/dist/functions/NavigationFunctions.js.map +1 -1
  64. package/dist/functions/NavigationFunctions.mjs.map +1 -1
  65. package/dist/functions/QuestFunctions.d.mts +8 -0
  66. package/dist/functions/QuestFunctions.d.ts +8 -0
  67. package/dist/functions/QuestFunctions.js +21 -0
  68. package/dist/functions/QuestFunctions.js.map +1 -0
  69. package/dist/functions/QuestFunctions.mjs +19 -0
  70. package/dist/functions/QuestFunctions.mjs.map +1 -0
  71. package/dist/functions/RoutineFunctions.d.mts +3 -3
  72. package/dist/functions/RoutineFunctions.d.ts +3 -3
  73. package/dist/functions/index.d.mts +4 -3
  74. package/dist/functions/index.d.ts +4 -3
  75. package/dist/functions/index.js +13 -0
  76. package/dist/functions/index.js.map +1 -1
  77. package/dist/functions/index.mjs +13 -1
  78. package/dist/functions/index.mjs.map +1 -1
  79. package/dist/index.d.mts +6 -5
  80. package/dist/index.d.ts +6 -5
  81. package/dist/index.js +254 -165
  82. package/dist/index.js.map +1 -1
  83. package/dist/index.mjs +254 -165
  84. package/dist/index.mjs.map +1 -1
  85. package/dist/interface/CommitmentProps.d.mts +2 -2
  86. package/dist/interface/CommitmentProps.d.ts +2 -2
  87. package/dist/interface/RoomProps.d.mts +2 -2
  88. package/dist/interface/RoomProps.d.ts +2 -2
  89. package/dist/interface/index.d.mts +3 -3
  90. package/dist/interface/index.d.ts +3 -3
  91. package/dist/interface/navigation/LocationProps.d.mts +3 -3
  92. package/dist/interface/navigation/LocationProps.d.ts +3 -3
  93. package/dist/interface/navigation/MapProps.d.mts +3 -3
  94. package/dist/interface/navigation/MapProps.d.ts +3 -3
  95. package/dist/interface/quest/QuestProps.d.mts +1 -1
  96. package/dist/interface/quest/QuestProps.d.ts +1 -1
  97. package/dist/interface/quest/StageProps.d.mts +1 -1
  98. package/dist/interface/quest/StageProps.d.ts +1 -1
  99. package/dist/types/QuestsRequired.d.mts +1 -1
  100. package/dist/types/QuestsRequired.d.ts +1 -1
  101. package/dist/types/index.d.mts +1 -1
  102. package/dist/types/index.d.ts +1 -1
  103. package/package.json +1 -1
  104. package/dist/{Commitment-BJTIpBQ5.d.ts → Commitment-D3LPSbFX.d.ts} +2 -2
  105. package/dist/{Commitment-CtNWnNQX.d.mts → Commitment-Eox2652k.d.mts} +2 -2
@@ -75,6 +75,11 @@ declare class StageQuest extends Stage {
75
75
  */
76
76
  get completed(): boolean;
77
77
  set completed(value: boolean);
78
+ /**
79
+ * If the stage is started.
80
+ */
81
+ get started(): boolean;
82
+ set started(value: boolean);
78
83
  /**
79
84
  * The list of goals that the player needs to complete to finish the stage.
80
85
  */
@@ -89,10 +94,14 @@ declare class StageQuest extends Stage {
89
94
  * Check if the stage can start.
90
95
  */
91
96
  get canStart(): boolean;
97
+ /**
98
+ * Inizialize the stage. **This function should be called only by the Quest class.**
99
+ */
100
+ inizialize(): void;
92
101
  /**
93
102
  * The function that will be called when the stage starts.
94
103
  */
95
- get onStart(): undefined | ((props: OnStartStage) => void);
104
+ start(props: OnStartStage): void;
96
105
  }
97
106
 
98
107
  declare class Quest extends StoredClassModel {
@@ -151,12 +160,31 @@ declare class Quest extends StoredClassModel {
151
160
  */
152
161
  start(props: OnStartStage): void;
153
162
  /**
154
- * Try to go to the next stage.
163
+ * Go to the next stage if the current stage is completed.
164
+ * If you want to force the change of stage, use goNextStage.
155
165
  * @param startProps The properties for the start stage. If you not want to pass any property, you can pass an {}.
156
166
  * @param endProps The properties for the end stage. If you not want to pass any property, you can pass an {}.
157
167
  * @returns true if the stage was changed, false otherwise.
158
168
  */
159
169
  tryToGoNextStage(startProps: OnStartStage, endProps: OnEndStage): boolean;
170
+ /**
171
+ * Complete the current stage and go to the next stage.
172
+ * If you want to go to the next stage only if the current stage is completed, use tryToGoNextStage.
173
+ * @param startProps The properties for the start stage. If you not want to pass any property, you can pass an {}.
174
+ * @param endProps The properties for the end stage. If you not want to pass any property, you can pass an {}.
175
+ * @returns true if the stage was changed, false otherwise.
176
+ */
177
+ completeCurrentStageAndGoNext(startProps: OnStartStage, endProps: OnEndStage): boolean;
178
+ /**
179
+ * Go to the next stage without checking if the current stage is completed.
180
+ * If you want to go to the next stage only if the current stage is completed, use tryToGoNextStage.
181
+ * @param startProps
182
+ * @param endProps
183
+ * @returns returns true if the stage was changed, false otherwise.
184
+ */
185
+ goNextStage(startProps: OnStartStage, endProps: OnEndStage): boolean;
186
+ get currentStageMustStart(): boolean;
187
+ startCurrentStage(props: OnStartStage): void;
160
188
  }
161
189
 
162
190
  type QuestsRequiredType = {
@@ -75,6 +75,11 @@ declare class StageQuest extends Stage {
75
75
  */
76
76
  get completed(): boolean;
77
77
  set completed(value: boolean);
78
+ /**
79
+ * If the stage is started.
80
+ */
81
+ get started(): boolean;
82
+ set started(value: boolean);
78
83
  /**
79
84
  * The list of goals that the player needs to complete to finish the stage.
80
85
  */
@@ -89,10 +94,14 @@ declare class StageQuest extends Stage {
89
94
  * Check if the stage can start.
90
95
  */
91
96
  get canStart(): boolean;
97
+ /**
98
+ * Inizialize the stage. **This function should be called only by the Quest class.**
99
+ */
100
+ inizialize(): void;
92
101
  /**
93
102
  * The function that will be called when the stage starts.
94
103
  */
95
- get onStart(): undefined | ((props: OnStartStage) => void);
104
+ start(props: OnStartStage): void;
96
105
  }
97
106
 
98
107
  declare class Quest extends StoredClassModel {
@@ -151,12 +160,31 @@ declare class Quest extends StoredClassModel {
151
160
  */
152
161
  start(props: OnStartStage): void;
153
162
  /**
154
- * Try to go to the next stage.
163
+ * Go to the next stage if the current stage is completed.
164
+ * If you want to force the change of stage, use goNextStage.
155
165
  * @param startProps The properties for the start stage. If you not want to pass any property, you can pass an {}.
156
166
  * @param endProps The properties for the end stage. If you not want to pass any property, you can pass an {}.
157
167
  * @returns true if the stage was changed, false otherwise.
158
168
  */
159
169
  tryToGoNextStage(startProps: OnStartStage, endProps: OnEndStage): boolean;
170
+ /**
171
+ * Complete the current stage and go to the next stage.
172
+ * If you want to go to the next stage only if the current stage is completed, use tryToGoNextStage.
173
+ * @param startProps The properties for the start stage. If you not want to pass any property, you can pass an {}.
174
+ * @param endProps The properties for the end stage. If you not want to pass any property, you can pass an {}.
175
+ * @returns true if the stage was changed, false otherwise.
176
+ */
177
+ completeCurrentStageAndGoNext(startProps: OnStartStage, endProps: OnEndStage): boolean;
178
+ /**
179
+ * Go to the next stage without checking if the current stage is completed.
180
+ * If you want to go to the next stage only if the current stage is completed, use tryToGoNextStage.
181
+ * @param startProps
182
+ * @param endProps
183
+ * @returns returns true if the stage was changed, false otherwise.
184
+ */
185
+ goNextStage(startProps: OnStartStage, endProps: OnEndStage): boolean;
186
+ get currentStageMustStart(): boolean;
187
+ startCurrentStage(props: OnStartStage): void;
160
188
  }
161
189
 
162
190
  type QuestsRequiredType = {
@@ -1,8 +1,8 @@
1
1
  import '@drincs/nqtr/dist/override';
2
2
  import '@drincs/pixi-vn';
3
- export { C as default } from '../Commitment-CtNWnNQX.mjs';
3
+ export { C as default } from '../Commitment-Eox2652k.mjs';
4
4
  import '../types/ExecutionType.mjs';
5
- import './Activity.mjs';
6
5
  import '../ActivityProps-D45DQdcT.mjs';
7
6
  import '../types/OnRunActivityEvent.mjs';
7
+ import './Activity.mjs';
8
8
  import '../types/OnRunCommitmentEvent.mjs';
@@ -1,8 +1,8 @@
1
1
  import '@drincs/nqtr/dist/override';
2
2
  import '@drincs/pixi-vn';
3
- export { C as default } from '../Commitment-BJTIpBQ5.js';
3
+ export { C as default } from '../Commitment-D3LPSbFX.js';
4
4
  import '../types/ExecutionType.js';
5
- import './Activity.js';
6
5
  import '../ActivityProps-BkHX8xkA.js';
7
6
  import '../types/OnRunActivityEvent.js';
7
+ import './Activity.js';
8
8
  import '../types/OnRunCommitmentEvent.js';
@@ -1,11 +1,11 @@
1
- export { default as ActivityModel } from './Activity.mjs';
2
- export { A as ActivityRoom, C as CommitmentBaseModel, L as LocationBaseModel, M as MapBaseModel, R as RoomBaseModel } from '../Commitment-CtNWnNQX.mjs';
1
+ export { A as ActivityRoom, C as CommitmentBaseModel, L as LocationBaseModel, M as MapBaseModel, R as RoomBaseModel } from '../Commitment-Eox2652k.mjs';
3
2
  export { default as Goal } from './quest/Goal.mjs';
4
- export { S as Stage } from '../StageProps-CkXejAbn.mjs';
3
+ export { S as Stage } from '../StageProps-D002cyay.mjs';
5
4
  import '@drincs/nqtr/dist/override';
5
+ import '@drincs/pixi-vn';
6
6
  import '../ActivityProps-D45DQdcT.mjs';
7
7
  import '../types/OnRunActivityEvent.mjs';
8
- import '@drincs/pixi-vn';
8
+ import './Activity.mjs';
9
9
  import '../types/ExecutionType.mjs';
10
10
  import '../types/OnRunCommitmentEvent.mjs';
11
11
  import '../interface/quest/GoalProps.mjs';
@@ -1,11 +1,11 @@
1
- export { default as ActivityModel } from './Activity.js';
2
- export { A as ActivityRoom, C as CommitmentBaseModel, L as LocationBaseModel, M as MapBaseModel, R as RoomBaseModel } from '../Commitment-BJTIpBQ5.js';
1
+ export { A as ActivityRoom, C as CommitmentBaseModel, L as LocationBaseModel, M as MapBaseModel, R as RoomBaseModel } from '../Commitment-D3LPSbFX.js';
3
2
  export { default as Goal } from './quest/Goal.js';
4
- export { S as Stage } from '../StageProps-BFsiCaZT.js';
3
+ export { S as Stage } from '../StageProps-DleWO-vf.js';
5
4
  import '@drincs/nqtr/dist/override';
5
+ import '@drincs/pixi-vn';
6
6
  import '../ActivityProps-BkHX8xkA.js';
7
7
  import '../types/OnRunActivityEvent.js';
8
- import '@drincs/pixi-vn';
8
+ import './Activity.js';
9
9
  import '../types/ExecutionType.js';
10
10
  import '../types/OnRunCommitmentEvent.js';
11
11
  import '../interface/quest/GoalProps.js';
@@ -261,136 +261,7 @@ var TimeManager = class _TimeManager {
261
261
  }
262
262
  };
263
263
 
264
- // src/classes/Activity.ts
265
- var ActivityModel = class {
266
- /**
267
- * @param id The activity id, that must be unique.
268
- * @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.
269
- * @param props The activity properties.
270
- */
271
- constructor(id, onRun, props) {
272
- this._id = id;
273
- this._name = props.name;
274
- this._fromHour = props.fromHour;
275
- this._toHour = props.toHour;
276
- this._fromDay = props.fromDay;
277
- this._toDay = props.toDay;
278
- this._disabled = props.disabled || false;
279
- this._hidden = props.hidden || false;
280
- this._renderIcon = props.renderIcon;
281
- this._onRun = onRun;
282
- }
283
- /**
284
- * The activity id, that is unique.
285
- */
286
- get id() {
287
- return this._id;
288
- }
289
- /**
290
- * The name
291
- */
292
- get name() {
293
- return this._name;
294
- }
295
- /**
296
- * The hour when the activity starts. If the activity is not started yet, it will be hidden.
297
- */
298
- get fromHour() {
299
- return this._fromHour;
300
- }
301
- /**
302
- * The hour when the activity ends. If the activity is ended yet, it will be hidden.
303
- */
304
- get toHour() {
305
- return this._toHour;
306
- }
307
- /**
308
- * The day when the activity starts. If the activity is not started yet, it will be hidden.
309
- */
310
- get fromDay() {
311
- return this._fromDay;
312
- }
313
- /**
314
- * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
315
- */
316
- get toDay() {
317
- return this._toDay;
318
- }
319
- /**
320
- * Whether is disabled.
321
- */
322
- get disabled() {
323
- if (typeof this._disabled === "string") {
324
- return pixiVn.getFlag(this._disabled);
325
- }
326
- return this._disabled;
327
- }
328
- /**
329
- * Whether is hidden. If the activity is not started yet, it will be hidden.
330
- */
331
- get hidden() {
332
- if (this.fromDay && this.fromDay > TimeManager.currentDay) {
333
- return true;
334
- }
335
- if (!this.isDeadline) {
336
- return true;
337
- }
338
- if (typeof this._hidden === "string") {
339
- return pixiVn.getFlag(this._hidden);
340
- }
341
- return this._hidden;
342
- }
343
- /**
344
- * The function for rendering the icon of the activity.
345
- */
346
- get renderIcon() {
347
- let render = this._renderIcon;
348
- if (render === void 0) {
349
- return void 0;
350
- }
351
- if (typeof render === "function") {
352
- return (props) => {
353
- return render(this, props);
354
- };
355
- }
356
- return (props) => render;
357
- }
358
- get _initialOnRun() {
359
- return this._onRun;
360
- }
361
- /**
362
- * The function that is called when the activity is runned.
363
- */
364
- get run() {
365
- return (props) => this._onRun(this, props);
366
- }
367
- /**
368
- * Whether the activity is a deadline.
369
- * @returns Whether the activity is a deadline.
370
- */
371
- isDeadline() {
372
- if (this.toDay && this.toDay <= TimeManager.currentDay) {
373
- return true;
374
- }
375
- return false;
376
- }
377
- /**
378
- * Export the activity properties.
379
- * @returns The activity properties.
380
- */
381
- export() {
382
- return {
383
- name: this._name,
384
- fromHour: this._fromHour,
385
- toHour: this._toHour,
386
- fromDay: this._fromDay,
387
- toDay: this._toDay,
388
- disabled: this._disabled,
389
- hidden: this._hidden,
390
- renderIcon: this._renderIcon
391
- };
392
- }
393
- };
264
+ // src/classes/Commitment.ts
394
265
  var COMMITMENT_CATEGORY = "__nqtr-commitment__";
395
266
  var CommitmentBaseModel = class extends pixiVn.StoredClassModel {
396
267
  /**
@@ -1424,7 +1295,6 @@ var RoomBaseModel = class extends pixiVn.StoredClassModel {
1424
1295
  }
1425
1296
  };
1426
1297
 
1427
- exports.ActivityModel = ActivityModel;
1428
1298
  exports.ActivityRoom = ActivityRoom;
1429
1299
  exports.CommitmentBaseModel = CommitmentBaseModel;
1430
1300
  exports.Goal = Goal;