DeadlyEssence01 Immersive Dialogue - v1.01

じ☆ve冰风

DE Immersive Dialogue | v1.01
DeadlyEssence​

Introduction
This plugin allows for implementation of random or sequential dialogue pulled from a txt file so you can easily create a batch text / random text. You can specify subfolders and file names, so each command can have a different text file it reads from.You can use yanfly's text codes and macros with this plugin, I have a long plugin list and have not found an incompatibility or issue yet.


Updates:
v1.01 - Random Dialogue doesn't repeat.
- Added an optional parameter to know which random message the plugin displayed.

Features
- Read a txt file of dialogue.
- Plugin command allows you to specify different files for each command / and pull text files from subfolders.
- Pull random dialogue from a list of options.
- Does support using face images.
- Is compatible with most? of Yanfly's plugins.
- Random dialogue doesn't repeat last used dialogue message.
- Show message number of displayed random dialogue

How to Use
Download the .js and put it in your plugins folder for your project.

You do not have to set the parameters if you don't want to...
If you want to know which message was displayed when using random dialogue, set a gamevariable in the parameters for "dialogue variable" the plugin will push the message number it displayed to your variable to allow for eventing checks.


1. Create a new folder in your project's data folder, name it dialogue.
2. Create a new text file, do not use spaces. The file name will be needed for the plugin command.
3. Insert your dialogue, being sure to use "//" to separate messages.

EX:  (you can copy and paste below if you need...)

Howdy
//Heyo!
//Long time no see!
//Fancy seeing you here.

Or batched text: (without word wrap that should fit in the box)

This is the very first message, that appears in the
message box. And here is some filler continuation
words. You can go beyond the four lines of text
for this, it will automatically batch the text for
you so that it shows.
//And this is message two.


Note: Pressing enter will make a new line break, or you can use Yanfly's <WordWrap>. With word wrap, you can just put the whole message on a single line.


Using Subfolders:
If you'd like to use subfolders, your filename should preface with the subfolder name and a / before the actual filename.
Ex: subfolder/EnoAmsir.txt
Ex: newfolder/HaroldDialogue.txt

Plugin Commands:

Sequential Dialogue Command
Dialogue will read the dialogue in order, for the number of lines specified.

dialogue [FILENAME.txt][lineNumber] [lineCount] [faceImage filename] [faceIndex number]

EX: dialogue NiraAmosirNeutral.txt 0 3 NiraAmosirFace 0
EX: dialogue Gossip.txt 0 3

- Filename should be the name of the .txt file you are trying to pull from the dialogue folder. Be sure to include .txt or it will not work.
- LineNumber is the line of text you want to start on. 0 is the first line!
- LineCount is the number of lines to read. 0 will only show the line specified in lineNumber. 1 will read the next line in the file too.
- Faces: If you want a face image to appear put the name of the file, without the .png. The face index is the number slot the face appears in on the png file. Remember, the left top is 0, not 1.

- If you don't want to count lines, I suggest using Notepad++ it will automatically number the lines for you. However, subtract one from the number on the left.

Random Dialogue Command:
Random dialogue will give you a random response from your text file.

randomdialogue [FILENAME.txt] [faceImage FILENAME] [faceIndex number]

EX: randomdialogue Introductions.txt
EX: randomdialogue Introductions.txt NiraAmosirFace 0
EX: randomdialogue HaroldDialogue.txt Actor1 0


- Filename should be the name of the .txt file you are trying to pull from the dialogue folder.
- Faces: If you want a face image to appear put the name of the file, without the .png. The face index is the number slot the face appears in on the png file. Remember, the left top is 0, not 1.

Script

Spoiler                Code:       

1. //===================
2. // DeadlyEssence01 Immersive Dialogue v1.01
3. //===================
5. var Imported = Imported || {} ;
6. Imported.DE_ImmersiveDialogue = true;
8. var DE_ImmersiveDialogue = DE_ImmersiveDialogue || {} ;
9. DE_ImmersiveDialogue.version = 1.01;
11. /*:
12. *
13. *@plugindesc Allows for random or sequential dialogue through a txt file. Easily batch or randomize text.
14. * @author DeadlyEssence01
15. *
16. * @param Dialogue Variable
17. * @type variable
18. * @desc If using random dialogue, the plugin will print the random message number chosen to your determined variable. 0 = not in use.
19. * @default 0
20. *
21. * @help
22. *===================
23. * Info:
24. *===================
25. *
26. * This plugin is compatible with (I believe) all of Yanfly's plugins.
27. * All text codes are supported. You also have the ability to use <WordWrap> from Yanfly's messagecore. This plugin should be put after Yanfly's to use Yanfly's textcodes.
28. *
29. *===================
30. *Instructions:
31. *===================
32. *
33. * 1. Create a new folder in your project's data folder, name it dialogue.
34. * 2. Create a new text file, do not use spaces. the file name (including .txt) will be needed for the plugin command.
35. * 3. Create your dialogue.
36. *
37. *Input your text in the new text file:
38. * Howdy
39. * //Heyo!
40. * //How are you doing???
41. *
42. * Note: Pressing enter will make a new line break, or you can use Yanfly's <WordWrap>. With word wrap, you can just put the whole message on a single line.
43. * Make sure to start each new message with //
44. *
45. * SUBFOLDERS:
46. * If you'd like to use subfolders, your filename should preface with the subfolder name and a / before the actual filename.
47. * Ex: subfolder/EnoAmsir.txt
48. * Ex: newfolder/HaroldDialogue.txt
49. *
50. *Some uses for this plugin...
51. *
52. *Create generic text for citizens, put all generic intros in an intro file, and let the plugin pull a random one. Just specify the actor image in the event's plugin commmand. Event all  * your conditional statements.
53. *
54. *Give characters more depth by giving them their own random dialogue file. For extra depth, set conditional branches on various game variables to pull different dialogue files.
55. *
56. *
57. *===================
58. *Plugin Commands:
59. *===================
60. * --------------
61. * dialogue [FILENAME.txt][lineNumber] [lineCount] [faceImage filename] [faceIndex number]
62. * --------------
63. *
64. * EX: dialogue NiraAmosirNeutral.txt 0 3 NiraAmosirFace 0
65. * EX: dialogue Gossip.txt 0 3
66. *
67. * dialogue will read the dialogue in order, for the number of lines specified.
68. *
69. * Filename should be the name of the .txt file you are trying to pull from the dialogue folder. Be sure to include .txt or it will not work.
70. * lineNumber is the line of text you want to start on. 0 is the first line! line count is the number of lines to read. 0 will only show the line specified in lineNumber. 1 will read the * next line in the file * too.
71. * If you want a face image to appear put the name of the file, without the .png. The face index is the number slot the face appears in on the png file. Remember, the left top is 0, not 1.
72. *
73. * If you don't want to count lines, I suggest using Notepad++ it will automatically number the lines for you. However, subtract one from the number on the left.
74. *
75. * OR
76. * --------------
77. * randomdialogue [FILENAME.txt] [faceImage FILENAME] [faceIndex number]
78. * ---------------
79. *
80. * EX: randomdialogue Introductions.txt
81. * EX: randomdialogue Introductions.txt NiraAmosirFace 0
82. * EX: randomdialogue HaroldDialogue.txt Actor1 0
83. *
84. * Random dialogue will give you a random response from your text file.
85. *
86. * Filename should be the name of the .txt file you are trying to pull from the dialogue folder.
87. * If you want a face image to appear put the name of the file, without the .png. The face index is the number slot the face appears in on the png file. Remember, the left top is 0, not 1.
88. *
89. *
90. *===================
91. *Terms of Use:
92. *===================
93. *
94. * Free for commercial or non-commercial projects.
95. * You may edit this plugin to fit your needs, but please do not redistribute it. You may make an extension plugin and link it in the forums if you'd like to share changes/alterations.
96. *
97. *===================
98. *Changelog
99. *===================
100. *
101. *
102. * v1.01 No more repeated randoms. Added variable to display number of random message shown.
103. * v1.00 Released plugin!
104. *
105. */
109. (function() {
110.     "use strict"
112.     var _params = PluginManager.parameters('DE_ImmersiveDialogue');
113.     var _dialoguevariable = Number(_params['Dialogue Variable']) || 0;
114.     var _lastUsedRandom;
115.    
116.     var DE_ImmersiveD_PluginCommand = Game_Interpreter.prototype.pluginCommand;
118.     Game_Interpreter.prototype.pluginCommand = function(command, args)
119.     {
120.         DE_ImmersiveD_PluginCommand.call(this,command,args);
121.    
122.         if (command === 'randomdialogue') {
123.             var filename = String(args[0]);
124.             var faceImage = String(args[1]);
125.             var faceIndex = parseInt(args[2]);
126.       
127.         var xhr = new XMLHttpRequest();
128.         xhr.open("GET","data/dialogue/" + filename, false);
129.         xhr.send(null);
130.         var fileContent = xhr.responseText;
131.       
132.         //divide up the txt file into an array based on //
133.         var dia = fileContent.split("//")
134.       
135.         //set face image if there
136.             if (args.length > 1) {
137.             $gameMessage.setFaceImage(faceImage, faceIndex);
138.             }
139.       
140.         //Choose and display random dialogue message.
141.         var line = Math.randomInt(dia.length); if (_lastUsedRandom === line) { if (line + 1 > dia.length) {--line;} else if (line - 1 < 0)  {++line; } else { line + 1; } }
142.         var msg = dia[line];
143.         this.setWaitMode('message');
144.         $gameMessage.add(msg);
145.         setDialogueVariable(line);
146.         _lastUsedRandom = line;
147.     } //end if random dialogue command   
149.         if (command === 'dialogue') {
150.             var filename = String(args[0]);
151.             var line = parseInt(args[1]);
152.             var lineCount = parseInt(args[2]);
153.             var faceImage = String(args[3]);
154.             var faceIndex = parseInt(args[4]);
155.            
156.         var xhr = new XMLHttpRequest();
157.         xhr.open("GET","data/dialogue/" + filename, false);
158.         xhr.send(null);
159.         var fileContent = xhr.responseText;
160.       
161.         //divide up the txt file into an array based on //
162.         var dia = fileContent.split("//")
163.       
164.         //check for line exists
165.         if (line > dia.length) {
166.             console.log("Immersive Dialogue Plugin: Your line does not exist. Please specify a correct line number.");
167.             }
168.       
169.       
170.             if (args.length > 3) {
171.             $gameMessage.setFaceImage(faceImage, faceIndex);
172.             }
173.       
174.         if (lineCount !== 0) {
175.             if (line + lineCount > dia.length) {console.log("Your lineCount exceeds your dialogue entries. Please change your lineCount.") }
176.         for (var i = 0; i <= lineCount; i++) {
177.             var msg = dia[line];
178.             this.setWaitMode('message');
179.             $gameMessage.newPage();
180.             $gameMessage.add(msg);
181.             line++;
182.             }
183.         }
184.         else {
185.             var msg = dia[line];
186.             this.setWaitMode('message');
187.             $gameMessage.add(msg);   
188.             }   
190.         }// end if command = dialogue
191.    
192.    
193. } //end game_interpreter
195.     function setDialogueVariable(line) {
196.         if (_dialoguevariable !== 0) {
197.             $gameVariables.setValue(_dialoguevariable, line);
198.         }
199.     }
200.    
203. })();

复制代码

FAQ
None yet...

Q:
A:

Credit and Thanks
- DeadlyEssence01

Terms of Use
This plugin is free for both non-commercial and commercial use.
You can give me credit as DeadlyEssence01 if you'd like.
You may edit this plugin to fit your needs, but please do not redistribute it. You may make an extension plugin and link it in the forums if you'd like to share changes/alterations.

Author's Notes
This plugin comes how it is. I may not update it at all, or provide support for it I am just deciding to share a resource I made for my project. However, as for right now I am open to feedback. You can try asking questions / reporting problems in this thread first, and if I do not respond, I suggest taking it to the plugin support thread and posting there.


本贴来自国际rpgmaker官方论坛作者:DeadlyEssence01处,因国际论坛即将永久关站,为了存档多年珍贵资料,署名转载到本论坛存档,由于官方帖子为英文原帖，需要中文翻译请点击论坛顶部切换语言为中文就可以将帖子翻译成中文浏览,方便大家随时查看,原文地址：https://forums.rpgmakerweb.com/threads/deadlyessence01-immersive-dialogue-v1-01.116578/