forked from Rotomeca/RPG-Maker-MZ-plugins
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathRotomecaQuestSystem.js
3200 lines (2846 loc) · 101 KB
/
RotomecaQuestSystem.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//=============================================================================
// RotomecaQuestSystem.js
//=============================================================================
/*:
* @target MZ
* @plugindesc (V1.0.0) Add a quest system
* @author Rotomeca
* @url https://github.com/Rotomeca/RPG-Maker-MZ-plugins
* @base RotomecaCore
* @orderAfter RotomecaCore
* @orderAfter RotomecaItemDurability
*
*
* @param Quests
* @text Quests
* @desc Quests database
* @default
* @type struct<Quest>[]
*
* @param Starting quests
* @text Starting quest
* @desc Quest already in the quest book at the start of the game
* @type number[]
*
* @param Default Quest Enabled
* @text Menu Quest Enabled
* @desc Quest menu enabled by default ?
* @default true
* @type boolean
*
* @param Auto update
* @text Auto update ?
* @desc Quests updating after get game datas ?
* @default true
* @type boolean
*
* @param Update When Menu
* @text Update When Menu
* @desc Quests update when entering in the quest menu ?
* @default true
* @type boolean
*
* @param ShowQuestNotif
* @text Show quest notif ?
* @desc Show notification when a quest is done, failed or acquired ?
* @default true
* @type boolean
*
* @param ShowStepUpdated
* @text Show step notif ?
* @desc Show a notification when a step is updated ?
* @default true
* @type boolean
*
* @param --------LANG-------
* @desc
* @default
* @type string
*
* @param LANG:QUEST
* @desc Text showed in the main menu
* @default Quests
* @type string
*
* @param LANG:LOCATION
* @desc Text showed for quest location
* @default Go to
* @type string
*
* @param LANG:PERSON
* @desc Text showed for draw the client name
* @default Talking to
* @type string
*
* @param LANG:KILL_MONSTER
* @desc Text showed who show the number of monster killed
* @default killed on
* @type string
*
* @param LANG:STEP
* @desc Text showed befores all steps
* @default Step
* @type string
*
* @param STEP:INCLUDE:S
* @desc Plural for LANG:STEP ?
* @default true
* @type boolean
*
* @param LANG:REWARD
* @desc Text showed befores all rewards
* @default Reward
* @type string
*
* @param REWARD:INCLUDE:S
* @desc Plural for LANG:REWARD
* @default true
* @type boolean
*
* @command DisableQuestMenu
* @desc Disable the quest menu in the main menu
* @text Disable Quest Menu
*
* @command EnableQuestMenu
* @desc Enable the quest menu in the main menu
* @text Enable Quest Menu
*
* @command Update
* @desc Update all quests advancement
* @text Update
*
* @arg async
* @text Async
* @desc Not wait the update is finished before continue
* @type boolean
* @default false
*
* @command Add
* @desc Add a quest in the questbook
* @text Add
*
* @arg id
* @text Id
* @desc Id of quest to add.
* @type number
* @default 1
*
* @command Validate
* @desc Validate a quest in the quest book
* @text Validate
*
* @arg id
* @text Id
* @desc Id of quest to validate.
* @type number
* @default 1
*
* @command ValidateStep
* @desc Validate a step of a quest in the questbook
* @text Validate Step
*
* @arg id
* @text Id
* @desc Id of the quest.
* @type number
* @default 1
*
* @arg stepId
* @text Id
* @desc Id of the step to validate.
* @type number
* @default 1
*
*
* @command FailStep
* @desc Fail a step of a quest in the questbook
* @text Fail Step
*
* @arg id
* @text Id
* @desc Id of the quest.
* @type number
* @default 1
*
* @arg stepId
* @text Id
* @desc Id of the quest.
* @type number
* @default 1
*
* @command Fail
* @desc Fail a quest in the questbook
* @text Fail
*
* @arg id
* @text Id
* @desc Id of the quest to fail.
* @type number
* @default 1
*
* @command Create
* @desc Create a quest in the quest database
* @text Create
*
* @arg Quest
* @text Quest
* @desc Quest added in the database
* @type struct<Quest>
*
* @command CreateQuests
* @desc Create quests in the quest database
* @text CreateQuests
*
* @arg Quests
* @text Quests
* @desc Quests added in the database
* @type struct<Quest>[]
*
* @command openquestmenu
* @desc Open the quest menu, with the possibilty to focus a quest.
* @text Open quest menu
*
* @arg id
* @text Id
* @desc Open the quest menu with focusing this quest. If this quest is not in the quest book, only the quest menu is open.
* @type number
* @default null
*
* @help
* =============================================================================
* ### Rotomeca Quest System ###
* Author - Rotomeca
* Version - 1.0.0
* Updated - 30/03/2022
* =============================================================================
*
* Add a quest system in your game.
*
* Use the parameter 'Quests' for add quests in your game.
* Id of the quest is the number in front of the quest.
*
* Commands :
* - Désactiver le menu de quête
* => Désactive le menu de quête dans le menu
*
* - Activer le menu de quête
* => Active le menu de quête dans le menu
*
* - MAJ
* => Met à jours l'avancement de toute les quêtes obtenu
* => Le paramètres 'Asynchrone' permet d'activer ou non la fin de la commande avant de faire d'autre chose
*
* - Valider/Echouer
* => Valide ou échoue une quête
* => Le paramètre 'id' correspond à l'id de la quête
*
* - Valider une étape/Echouer une étape
* => Valide ou échoue une étape/un objectif d'une quête
* => Le paramètre 'id' correspond à l'id de la quête qui possède l'étape
* => Le paramètre 'Id de l'étape' correspond à l'id de l'étape (le nombre devant la liste des étapes d'une quête)
*
* - Ajouter
* => Ajoute une quête au livre de quête
* => Le paramètre 'Id' correspond à l'id de la quête dans la base de données
*
* If commands :
* Lorsque vous faites une branche conditionnel, choisssez 'script' et écrivez :
* - $questExist(id)
* => Vérifie si une quête éxiste dans la base de données
* => id : Id de la quête dans la base de données
* => Renvoie vrai (true) si elle existe, faux (false) sinon
*
* - $questHave(id)
* => Vérifie si une quête est dans le livre de quête
* => id : Id de la quête dans la base de données
* => Renvoie vrai (true) si elle y est, faux (false) sinon
* - $questValidate(id)/$questFailed(id)/$questInProgress(id)
* =>Vérifie si une quête dans le livre de quête est validée, échouée ou en cours
* => id : Id de la quête dans la base de données
* => Renvoie vrai (true) si elle est validée, échouée ou en cours, faux (false) sinon
*
* - $questIsAdded()
* => A utiliser après la commande Ajouter
* => Renvoie vrai (true) si la quête n'est pas dans le livre de quête, faux (false) sinon.
*
*/
/*~struct~QuestReward:
* @param type
* @text Reward type
* @type select
* @default Variable
* @option Game variable
* @value Variable
* @option Game Switch
* @value Switch
* @option Gold
* @value Gold
* @option Item
* @value Item
* @option Armor
* @value Armor
* @option Weapon
* @value Weapon
* @option Quest
* @value Quest
* @option Custom
* @value Custom
*
* @param amount
* @text Amount
* @type number
*
* @param id
* @text Id of the reward
* @type number
* @desc by type
*
*
*/
/*~struct~QuestStep:
* @param type
* @text Step type
* @desc Step to do for validate the quest
* @type select
* @default Variable
* @option Game variable
* @value Variable
* @option Game Switch
* @value Switch
* @option Location
* @value Location
* @option Talking to
* @value Talking
* @option Kill x ennemy(ies)
* @value Ennemy
* @option Get item(s)
* @value Items
* @option Get weapon(s)
* @value Weapons
* @option Get armor(s)
* @value Armors
* @option Custom
* @value Custom
*
* @param Game Data Id
* @text Game data id
* @desc Id in the RPG MAKER MZ database
* @type number
*
* @param Step desc
* @text Step desc
* @desc Location/Person name/Desc
* @type text
*
* @param Amount
* @text Amout
* @desc Amount (Except for game switch/Location/Talking to)
* @type number
*
* @param Is Hidden
* @text Is Hidden ?
* @desc Step hidden ? (Put true if in 'Next Step(s)')
* @default false
* @type boolean
*
* @param Next Step(s)
* @text Next Step(s)
* @desc Next step(s) showed when validate
* @type number[]
*
*/
/*~struct~Quest:
*
* @param Quest Name
* @text Quest Name
* @desc Name showed in the menu
* @type text
*
* @param Quest desc
* @text Quest desc
* @desc Quest desc
* @type multiline_string
*
* @param Main quest
* @text Main Quest ?
* @default true
* @type boolean
*
* @param Giver
* @text Giver
* @desc Person who give the quest
* @type text
*
* @param Location
* @text Location
* @desc Quest location
* @type text
*
* @param Steps
* @text Steps
* @type struct<QuestStep>[]
*
* @param Rewards
* @text Rewards
* @desc Rewards get when the quest is validate
* @type struct<QuestReward>[]
*
*/
/*:fr
* @target MZ
* @plugindesc (V1.0.0) Ajoute un système de quête
* @author Rotomeca
* @url https://github.com/Rotomeca/RPG-Maker-MZ-plugins
*
* @param Quests
* @text Quêtes
* @desc Base de données des quêtes
* @default
* @type struct<Quest>[]
*
* @param Starting quests
* @text Quêtes de départ
* @desc Les quêtes déjà dans le menu de quête au lancement de la partie.
* @type number[]
*
* @param Default Quest Enabled
* @text Activer le menu de quête
* @desc Le menu de quête est activé par défaut ?
* @default true
* @type boolean
*
* @param Auto update
* @text MAJ des quêtes automatique ?
* @desc Les quêtes sont mises à jours à chaque "évènements"
* @default true
* @type boolean
*
* @param Update When Menu
* @text MAJ des quêtes dans le menu ?
* @desc Les quêtes sont mises à jours à l'entrée du menu des quêtes ?
* @default true
* @type boolean
*
* @param ShowQuestNotif
* @text Afficher les notifications des quêtes ?
* @desc Affiche une notification lorsqu'une quête est finie, échouée ou obtenu ?
* @default true
* @type boolean
*
* @param ShowStepUpdated
* @text Afficher les notifications des étapes ?
* @desc Affiche une notification lorsqu'une étape est mise à jours ?
* @default true
* @type boolean
*
* @param --------LANG-------
* @desc
* @default
* @type string
*
* @param LANG:QUEST
* @desc Texte affiché dans le menu.
* @default Quêtes
* @type string
*
* @param LANG:LOCATION
* @desc Texte affiché avant la localisation dans le menu de quête
* @default Aller à
* @type string
*
* @param LANG:PERSON
* @desc Texte affiché avant la personne à aller parler dans le menu de quête
* @default Parler à
* @type string
*
* @param LANG:KILL_MONSTER
* @desc Texte affiché pour définir le nombre de monstres tués dans le menu de quête
* @default tué(s) sur
* @type string
*
* @param LANG:STEP
* @desc Texte affiché avant la liste des étapes dans le menu de quête
* @default Etape
* @type string
*
* @param STEP:INCLUDE:S
* @desc Prendre en compte le pluriel pour LANG:STEP
* @default true
* @type boolean
*
* @param LANG:REWARD
* @desc Texte affiché avant la liste des récompenses dans le menu de quête
* @default Récompense
* @type string
*
* @param REWARD:INCLUDE:S
* @desc Prendre en compte le pluriel pour LANG:REWARD
* @default true
* @type boolean
*
* @command DisableQuestMenu
* @desc Désactive le menu de quête dans le menu
* @text Désactiver le menu de quête
*
* @command EnableQuestMenu
* @desc Active le menu de quête dans le menu
* @text Activer le menu de quête
*
* @command Update
* @desc Met à jours l'avancement des quêtes
* @text MAJ
*
* @arg async
* @text Asynchrone
* @desc N'attend pas que la mise à jours suit fini avant de passer à la ligne suivante
* @type boolean
* @default false
*
* @command Add
* @desc Ajoute une quête au livre de quête
* @text Ajouter
*
* @arg id
* @text Id
* @desc Id de la quête à ajouter.
* @type number
* @default 1
*
* @command Validate
* @desc Valide une quête du livre de quête
* @text Valider
*
* @arg id
* @text Id
* @desc Id de la quête à valider.
* @type number
* @default 1
*
* @command ValidateStep
* @desc Valide une étape d'une quête du livre de quête
* @text Valider une étape
*
* @arg id
* @text Id
* @desc Id de la quête.
* @type number
* @default 1
*
* @arg stepId
* @text Id
* @desc Id de l'étape à valider.
* @type number
* @default 1
*
* @command FailStep
* @desc Echoue une étape d'une quête du livre de quête
* @text Echouer une étape
*
* @arg id
* @text Id
* @desc Id de la quête.
* @type number
* @default 1
*
* @arg stepId
* @text Id de l'étape
* @desc Id de l'étape à echouer.
* @type number
* @default 1
*
* @command Fail
* @desc Echoue une quête du livre de quête
* @text Echouer
*
* @arg id
* @text Id
* @desc Id de la quête à echouer.
* @type number
* @default 1
*
* @command Create
* @desc Créé une quête
* @text Créer
*
* @arg Quest
* @text Quête
* @desc Quête qui sera ajouter à la base de données des quêtes.
* @type struct<Quest>
*
* @command CreateQuests
* @desc Créé plusieurs quêtes
* @text Créer plusieurs quêtes
*
* @arg Quests
* @text Quêtes
* @desc Quêtes qui sera ajouter à la base de données des quêtes.
* @type struct<Quest>[]
*
* @command openquestmenu
* @desc Ouvre le menu de quête, avec la possibilité de mettre en avant une quête en particulier.
* @text Ouvrir le menu de quête
*
* @arg id
* @text Id
* @desc Ouvre le menu de quête sur cette quête. Si elle n'est pas dans le livre de quête, seul le menu de quête sera ouvert.
* @type number
* @default null
*
* @base RotomecaCore
* @orderAfter RotomecaCore
* @orderAfter RotomecaItemDurability
*
* @help
* =============================================================================
* ### Rotomeca Quest System ###
* Author - Rotomeca
* Version - (V1.0.0)
* Updated - 04/03/2022
* =============================================================================
*
* Ajoute un système de quête au jeu.
*
* Utilisez le paramètre 'Quêtes' pour ajouter des quêtes à votre jeu.
* L'id de la quête correspond au nombre en face de la quête.
*
* Commandes :
* - Désactiver le menu de quête
* => Désactive le menu de quête dans le menu
*
* - Activer le menu de quête
* => Active le menu de quête dans le menu
*
* - MAJ
* => Met à jours l'avancement de toute les quêtes obtenu
* => Le paramètres 'Asynchrone' permet d'activer ou non la fin de la commande avant de faire d'autre chose
*
* - Valider/Echouer
* => Valide ou échoue une quête
* => Le paramètre 'id' correspond à l'id de la quête
*
* - Valider une étape/Echouer une étape
* => Valide ou échoue une étape/un objectif d'une quête
* => Le paramètre 'id' correspond à l'id de la quête qui possède l'étape
* => Le paramètre 'Id de l'étape' correspond à l'id de l'étape (le nombre devant la liste des étapes d'une quête)
*
* - Ajouter
* => Ajoute une quête au livre de quête
* => Le paramètre 'Id' correspond à l'id de la quête dans la base de données
*
* Commandes conditionnels :
* Lorsque vous faites une branche conditionnel, choisssez 'script' et écrivez :
* - $questExist(id)
* => Vérifie si une quête éxiste dans la base de données
* => id : Id de la quête dans la base de données
* => Renvoie vrai (true) si elle existe, faux (false) sinon
*
* - $questHave(id)
* => Vérifie si une quête est dans le livre de quête
* => id : Id de la quête dans la base de données
* => Renvoie vrai (true) si elle y est, faux (false) sinon
* - $questValidate(id)/$questFailed(id)/$questInProgress(id)
* =>Vérifie si une quête dans le livre de quête est validée, échouée ou en cours
* => id : Id de la quête dans la base de données
* => Renvoie vrai (true) si elle est validée, échouée ou en cours, faux (false) sinon
*
* - $questIsAdded()
* => A utiliser après la commande Ajouter
* => Renvoie vrai (true) si la quête n'est pas dans le livre de quête, faux (false) sinon.
*
* -----------------------------------------------------------------------------------------------------------
* Ce qu'il reste à faire :
* - Traduction du help anglais
* - MAJ du help anglais
*/
/*~struct~QuestReward:fr
* @param type
* @text Type de récompense
* @desc Type de récompense qui sera obtenu après validation de la quête
* @type select
* @default Variable
* @option Variable de jeu
* @value Variable
* @option Interrupteur de jeu
* @value Switch
* @option Or (le thune quoi $$)
* @value Gold
* @option Objet
* @value Item
* @option Armure
* @value Armor
* @option Arme
* @value Weapon
* @option Quête
* @value Quest
* @option Créer par l'utilisateur (script)
* @value Custom
*
* @param amount
* @text Montant
* @type number
* @desc Nombre de récompense(s) que l'équipe obtient
*
* @param id
* @text Id de la récompense
* @type number
* @desc En fonction du type
*
* @param durability
* @text Durabilitée (RotomecaItemDurability)
* @type struct<DurabilityOptions>
* @desc Si le plugin RotomecaItemDurability est activé et pour le type 'Arme' et 'Armure'. Permet d'avoir un équipement avec une durabilitée modifiée.
*
*/
/*~struct~DurabilityOptions:fr
* @param active
* @text Actif
* @desc Si la durabilitée doit être changée ou non
* @default false
* @type boolean
*
* @param durability
* @text Durabilitée
* @desc Durabilitée de l'arme ou de l'armure
* @type number
* @default 1
* @min 1
*
* @param update_max
* @text Changer la durabilitée maximum
* @desc -1 pour auto, 0 pour non, sinon, valeur de la nouvelle durabilitée
* @type number
* @default 0
* @min -1
*
*/
/*~struct~QuestStep:fr
* @param type
* @text Type d'étape
* @desc Objectif à faire pour valider la quête
* @type select
* @default Variable
* @option Variable de jeu
* @value Variable
* @option Intérrupteur de jeu
* @value Switch
* @option Localisation
* @value Location
* @option Parler à
* @value Talking
* @option Tuer des monstres
* @value Ennemy
* @option Obtenir un(des) objet(s)
* @value Items
* @option Obtenir une(des) arme(s)
* @value Weapons
* @option Obtenir une(des) armure(s)
* @value Armors
* @option Créer par l'utilisateur (script)
* @value Custom
*
* @param Game Data Id
* @text Id de la données de jeu
* @desc Id dans la base de données
* @type number
*
* @param Step desc
* @text Description de l'étape
* @desc Nom de la localisation/Nom de la personne à aller parler/Description de l'étape
* @type text
*
* @param Amount
* @text Montant
* @desc Valeur à atteindre (sauf pour Intérrupteur de jeu/Localisation/Parler à)
* @type number
*
* @param Is Hidden
* @text Etape cachée
* @desc L'étape est cachée ? (Mettre vrai si elle se trouve dans le tableau 'Prochaine(s) étape(s)')
* @default false
* @type boolean
*
* @param Next Step(s)
* @text Prochaine(s) étape(s)
* @desc Prochaines étapes qui seront affichés après que cette étape sera validée.
* @type number[]
*
*/
/*~struct~Quest:fr
*
* @param Quest Name
* @text Nom de la quête
* @desc Nom qui sera affiché
* @type text
*
* @param Quest desc
* @text Description de la quête
* @desc Description de la quête. (Pensez à vérifier le retour à la ligne en jeu.)
* @type multiline_string
*
* @param Main quest
* @text Est une quête principale ?
* @desc Si vrai, elle sera affiché dans le menu des quêtes principales, sinon, des secondaires.
* @default true
* @type boolean
*
* @param Giver
* @text Client
* @desc Personne qui donne la quête
* @type text
*
* @param Location
* @text Localisation
* @desc Où on a reçut la quête/où il faut aller
* @type text
*
* @param Steps
* @text Etapes
* @desc Les étapes/objectifs de la quête
* @type struct<QuestStep>[]
*
* @param Rewards
* @text Récompenses
* @desc Récompenses de la quête
* @type struct<QuestReward>[]
*
*/
//=============================================================================
// ** Constantes
//=============================================================================
const r_rqs_plugin_name = 'RotomecaQuestSystem';
//r => Rotomeca
//rqs => RotomecaQuestSystem
//_default => Valeur par défaut
//###########################################################################//
//############################### Paramètres ################################//
//###########################################################################//
const r_rqs_param_lang_quest = 'LANG:QUEST';
const r_rqs_param_lang_quest_default = 'Quêtes';
const r_rqs_param_menu_enabled_at_start = 'Default Quest Enabled';
const r_rqs_param_menu_enabled_at_start_default = true;
const r_rqs_param_quests = 'Quests';
const r_rqs_param_quests_default = '[]';
const r_rqs_param_auto_update = 'Auto update';
const r_rqs_param_auto_update_default = true;
const r_rqs_param_update_when_menu = 'Update When Menu';
const r_rqs_param_update_when_menu_default = true;
const r_rqs_param_struct_quest_name = 'Quest Name';
const r_rqs_param_struct_quest_desc = 'Quest desc';
const r_rqs_param_struct_quest_is_main = 'Main quest';
const r_rqs_param_struct_quest_giver = 'Giver';
const r_rqs_param_struct_quest_location = 'Location';
const r_rqs_param_struct_quest_rewards = 'Rewards';
const r_rqs_param_struct_quest_steps = 'Steps';
const r_rqs_param_struct_reward_type = 'type';
const r_rqs_param_struct_id = 'id';
//###########################################################################//
//############################### Commandes #################################//
//###########################################################################//
const r_rqs_command_update = 'Update';
const r_rqs_command_add = 'Add';
const r_rqs_command_validate = 'Validate';
const r_rqs_command_validate_step = 'ValidateStep';
const r_rqs_command_fail = 'Fail';
const r_rqs_command_fail_step = 'FailStep';
const r_rqs_command_create = 'Create';
const r_rqs_command_create_quests = 'CreateQuests';
const r_rqs_command_disable_quest_menu = 'DisableQuestMenu';
const r_rqs_command_enable_quest_menu = 'EnableQuestMenu';
const r_rqs_command_open_quest_menu = 'openquestmenu';
//###########################################################################//
//################################## Lang ###################################//
//###########################################################################//
const r_rqs_lang_location = 'LOCATION';
const r_rqs_lang_person = 'PERSON';
const r_rqs_lang_kill_monster = 'KILL_MONSTER';
//###########################################################################//
//################################ Events ###################################//
//###########################################################################//
const r_rqs_event_rotomeca_quest_step_updated = 'rotomeca.quest.step.updated';
const r_rqs_event_rotomeca_quest_step_validate = 'rotomeca.quest.step.validate';
const r_rqs_event_rotomeca_quest_step_failed = 'rotomeca.quest.step.failed';
const r_rqs_event_monster_killed = 'Monster.Killed';
const r_rqs_event_scene_menu_create_command_window_after = 'Scene_Menu.createCommandWindow.after';
//###########################################################################//
//################################ Steps ####################################//
//###########################################################################//
const r_rqs_step_saved_state_in_progress = 0;
const r_rqs_step_saved_state_valid = 1;
const r_rqs_step_saved_state_failed = 2;
const r_rqs_step_type_location = 'Location';
const r_rqs_step_type_talking = 'Talking';
const r_rqs_step_game_data_id = 'Game Data Id';
const r_rqs_step_desc = 'Step desc';
const r_rqs_step_is_hidden = 'Is Hidden';
const r_rqs_step_amount = 'Amount';
const r_rqs_step_nexts = 'Next Step(s)';
//###########################################################################//
//################################ Rewards ##################################//
//###########################################################################//
const r_rqs_reward_type_quest = 'Quest';
//###########################################################################//
//################################ Quests ###################################//
//###########################################################################//
const r_rqs_quest_done = 'quest.done';
const r_rqs_quest_failed = 'quest.failed';
const r_rqs_quest_added = 'quest.added';
const r_rqs_quest_saved_state_in_progress = 0;
const r_rqs_quest_saved_state_valid = 1;
const r_rqs_quest_saved_state_failed = 2;
const r_rqs_quest_setup_custom = 'Custom';
//###########################################################################//
//################################ Game #####################################//
//###########################################################################//
const r_rqs_game_gold = 'Gold';
const r_rqs_game_variable = 'Variable';
const r_rqs_game_switch = 'Switch';
const r_rqs_game_item = 'Item';
const r_rqs_game_armor = 'Armor';
const r_rqs_game_weapon = 'Weapon';
const r_rqs_game_items = r_rqs_game_item + 's';
const r_rqs_game_armors = r_rqs_game_armor + 's';
const r_rqs_game_weapons = r_rqs_game_weapon + 's';
const r_rqs_game_ennemy = 'Ennemy';
//###########################################################################//
//################################ Menu #####################################//
//###########################################################################//
const r_rqs_window_command_quest_symbol = 'quest';
const r_rqs_window_command_main_symbol = 'main';
const r_rqs_window_command_side_symbol = 'side';
const r_rqs_window_command_done_symbol = 'done';
const r_rqs_window_command_failed_symbol = 'failed';
//=============================================================================
// ** PLUGIN PARAMETERS
//=============================================================================
var Imported = Imported || {};
Imported.RotomecaQuestSystem = true;
var Rotomeca = Rotomeca || {};
/**
* Permet d'utiliser les commandes de Rpg Maker MZ
* @type {Game_Interpreter}
*/
Rotomeca.interpreter = Rotomeca.interpreter || new Game_Interpreter();
/**
* Paramètres ou divers variables globales du plugin
*/
Rotomeca.RotomecaQuestSystem = {}
/**
* Paramètres du plugin
*/
Rotomeca.RotomecaQuestSystem.parameters = PluginManager.parameters(r_rqs_plugin_name);
Rotomeca.RotomecaQuestSystem.parameters.quest_text = String(Rotomeca.RotomecaQuestSystem.parameters[r_rqs_param_lang_quest] || r_rqs_param_lang_quest_default);
Rotomeca.RotomecaQuestSystem.parameters.default_quest_enabled = Boolean(Rotomeca.RotomecaQuestSystem.parameters[r_rqs_param_menu_enabled_at_start] || r_rqs_param_menu_enabled_at_start_default);
Rotomeca.RotomecaQuestSystem.parameters.quests_database = Rotomeca.RotomecaQuestSystem.parameters[r_rqs_param_quests] || r_rqs_param_quests_default;
Rotomeca.RotomecaQuestSystem.parameters.auto_update = Boolean(Rotomeca.RotomecaQuestSystem.parameters[r_rqs_param_auto_update] || r_rqs_param_auto_update_default);
Rotomeca.RotomecaQuestSystem.parameters.update_in_menu = Boolean(Rotomeca.RotomecaQuestSystem.parameters[r_rqs_param_update_when_menu] || r_rqs_param_update_when_menu_default);
/**
* Si le menu de quête est actif ou non.
* @type {boolean}
*/
Rotomeca.RotomecaQuestSystem.isQuestEnabled = Rotomeca.RotomecaQuestSystem.parameters.default_quest_enabled;
/**
* Base de données des quêtes
* @type {QuestDatabase}
*/
var $gameQuests = null;
//=============================================================================
// ** Rotomeca.RotomecaQuestSystem **
//=============================================================================
/**
* Créer la base de données des quêtes
*/
Rotomeca.RotomecaQuestSystem.createGameQuest = function() {
$gameQuests = new QuestDatabase(Rotomeca.RotomecaQuestSystem.parameters.quests_database);
},
/**
* Récupère les données de langue pour ce plugin
* @param {string} text Clé
* @returns {string} Texte récupérer depuis les paramètres du plugin
*/
Rotomeca.RotomecaQuestSystem.gettext = function gettext(text) {
return Rotomeca.gettext(text, r_rqs_plugin_name);
}
/**
* Récupère les paramètres de langue pour ce plugin
* @param {string} text Clé
* @param {string} param Clé du paramètre
* @returns {string} valeur récupérée depuis les paramètres du plugin
*/
Rotomeca.RotomecaQuestSystem.lang_param = function lang_param(text, param) {
return Rotomeca.lang_param(text, param, false, r_rqs_plugin_name);
}
//=============================================================================
// ** PluginManager **
//=============================================================================
PluginManager.registerCommand(r_rqs_plugin_name, r_rqs_command_update, data => {
if (data.async) $gameParty._quests.updateQuestsAsync();
else $gameParty._quests.updateQuests();
});
PluginManager.registerCommand(r_rqs_plugin_name, r_rqs_command_add, data => {
$questIsAdded.val = QuestDatabase.tryAddQuestToParty(data.id);
});