Player Input in ShowText Window Plugin [RMMZ]

じ☆ve冰风

Player Input Text MZ
playerInputText.js

◆ Plugin Overview
This RPG Maker MZ plugin allows players to input their own text into a Show Text window, styled like NPC dialogue.
It offers customizable options including actor image, name, font size, input text color, and placeholder settings.

The plugin enhances interactive storytelling by enabling players to actively participate in conversations and scenarios. It's designed to be flexible and easy to integrate into various game events, making it a versatile tool for RPG creators seeking to add personalized player interaction in their games.





◆ DEMO

https://www.youtube.com/embed/9zRCHZJhGPs

◆ Plugin Commands
▶ inputText


◆ Configurable Arguments
▶ Actor Image
▶ Actor Name
▶ Text Font Size
▶ Text Color
▶ Placeholder text
▶ Placeholder Text Color

◆ Download Plugin code

Spoiler                JavaScript:       

1. /*:
2. * @target MZ
3. * @plugindesc [RPG Maker MZ] [Version 1.1.1] [Gamer Tools Studio]
4. * @author Gamer Tool Studio
5. *
6. * @command PlayerInput
7. * @text Player Input
8. * @desc Allows the player to input their own message.
9. *
10. * @arg actorName
11. * @text Actor Name
12. * @desc The name of the actor. Default is main player name.
13. * @type text
14. * @default
15. *
16. * @arg actorFaceImage
17. * @text Actor Face Image
18. * @desc The face image of the actor. Default is main player image.
19. * @type file
20. * @dir img/faces/
21. * @default
22. *
23. * @arg actorFaceImageIndex
24. * @text Actor Face Image Index
25. * @desc The face image index of the actor. Default is main player face index.
26. * @type number
27. * @default 0
28. *
29. * @arg placeholderText
30. * @text Placeholder Text
31. * @desc The placeholder text. Default is "Enter your message...".
32. * @type text
33. * @default Enter your message...
34. *
35. * @arg inputVariable
36. * @text Input Variable
37. * @desc The variable to store the input text. Default is variable 19.
38. * @type variable
39. * @default 19
40. *
41. * @help PlayerInputText.js
42. *
43. * Allows players to input text in a Show Text window with the style of the game window skins and store it in a custom variable.
44. * Use the plugin command "Player Input" in an event to trigger this feature.
45. */
47. (() => {
48.     const pluginName = "PlayerInputText";
50.     PluginManager.registerCommand(pluginName, "PlayerInput", args => {
51.         const actorName = args.actorName || $gameParty.leader().name();
52.         const actorFaceImage = args.actorFaceImage || $gameParty.leader().faceName();
53.         const actorFaceImageIndex = parseInt(args.actorFaceImageIndex, 10) || $gameParty.leader().faceIndex();
54.         const placeholderText = args.placeholderText ? args.placeholderText : 'Enter your message...';
56.         // Set up the game message with speaker name and face image, but no text.
57.         $gameMessage.setFaceImage(actorFaceImage, actorFaceImageIndex);
58.         $gameMessage.setSpeakerName(actorName);
59.         $gameMessage.add(placeholderText);
61.         // Ensure the message window activates input mode once it's open.
62.         const scene = SceneManager._scene;
63.         if (scene instanceof Scene_Map) {
64.             const messageWindow = scene._messageWindow;
65.             if (messageWindow) {
66.                 messageWindow.prepareInputWindow(args);
67.                 messageWindow.activateInput();
68.             }
69.         }
70.     });
72.     // Prepare Input
73.     Window_Message.prototype.prepareInputWindow = function(args) {
74.         this._inputArgs = args;
75.         this._inputVariable = parseInt(args.inputVariable, 10) || 19;
76.         this._inputLines = [''];
78.         // Set speaker name to actorName each time before displaying the input window.
79.         const actorName = args.actorName || $gameParty.leader().name();
80.         $gameMessage.setSpeakerName(actorName);
82.         this.activateInput();
83.         this.open();
84.         this.setPositionType();
85.         this.refreshInputWindow(); // This will now reflect the updated speakerName
86.     };
88.     Window_Message.prototype.setPositionType = function() {
89.         // Position type: 0 (top), 1 (middle), 2 (bottom)
90.         const positionType = 2; // Force to bottom for input
91.         this.y = this.calculateY(positionType);
92.     };
94.     Window_Message.prototype.calculateY = function(positionType) {
95.         const messageY = {
96.             0: 0, // Top
97.             1: (Graphics.boxHeight - this.height) / 2, // Middle
98.             2: Graphics.boxHeight - this.height // Bottom
99.         };
100.         return messageY[positionType];
101.     };
103.      // Activate Input
104.     Window_Message.prototype.activateInput = function() {
105.         if (this._inputActive) return; // Prevent multiple activations
107.         this._originalKeyMapper = Object.assign({}, Input.keyMapper);
108.         this._overrideKeyMapperForTextInput();
110.         this._inputActive = true;
111.         this._boundHandleInput = this.handleInput.bind(this);
112.         document.addEventListener('keydown', this._boundHandleInput);
114.         this._lastInputTime = 0; // Debounce setup
115.         this.refreshInputWindow();
116.     };
118.     // Deactivate Input
119.     Window_Message.prototype.deactivateInput = function() {
120.         document.removeEventListener('keydown', this._boundHandleInput);
121.         Input.keyMapper = this._originalKeyMapper;
122.         this._inputActive = false;
123.     };
125.     // Temporarily override key mappings for special keys.
126.     Window_Message.prototype._overrideKeyMapperForTextInput = function() {
127.         Input.keyMapper[32] = 'space';
128.         Input.keyMapper[90] = 'z';     
129.         Input.keyMapper[88] = 'x';
130.         Input.keyMapper[87] = 'w';
131.     };
133.     // Handle Input
134.     Window_Message.prototype.handleInput = function(event) {
135.         if (!this._inputActive || !this.isOpen()) return;
137.         const currentLineIndex = this._inputLines.length - 1;
138.         let currentLine = this._inputLines[currentLineIndex];
140.         if (event.key === 'Enter') {
141.             this.processInput();
142.             event.preventDefault();
143.         } else if (event.key === 'Backspace') {
144.             if (currentLine.length > 0) {
145.                 this._inputLines[currentLineIndex] = currentLine.slice(0, -1);
146.             } else if (this._inputLines.length > 1) {
147.                 this._inputLines.pop();
148.             }
149.             this.refreshInputWindow();
150.         } else if (event.key.length === 1) {
151.             if (currentLine.length < 40) {
152.                 this._inputLines[currentLineIndex] += event.key;
153.             } else if (this._inputLines.length < 4) {
154.                 this._inputLines.push(event.key);
155.             }
156.             this.refreshInputWindow();
157.         }
158.     };
160.     // Process Input
161.     Window_Message.prototype.processInput = function() {
162.         const inputText = this._inputLines.join('\n');
163.         $gameVariables.setValue(this._inputVariable, inputText);
164.         this.deactivateInput();
165.         this.close();
167.         // Reset the speakerName after processing the input.
168.         $gameMessage.setSpeakerName('');
169.     };
171.     // Refresh Input Window
172.     Window_Message.prototype.refreshInputWindow = function() {
173.         if (!this._inputLines) {
174.             return; // Guard clause
175.         }
176.         
177.         // Face Image and text input positioning
178.         const faceImageWidth = 144;
179.         const textMargin = 15;
180.         const textStartX = faceImageWidth + textMargin;
183.         // This sets the text to start at the very top of the window.
184.         const textStartY = 0;
187.         // This ensures the actor's face image remains on the screen.
188.         this.contents.clearRect(textStartX, textStartY, this.contents.width - textStartX, this.contents.height);
190.         this.resetFontSettings();
192.         const args = this._inputArgs;
194.         
195.         const textToShow = this._inputLines.join('').trim() !== '' ? this._inputLines.join('\n') : "Enter your message...";
197.         // Draw the text at the calculated position.
198.         this.drawTextEx(textToShow, textStartX, textStartY);
199.     };
201.     // Clear contents
202.     Window_Message.prototype.clear = function() {
203.         this.contents.clear(); // Clears the window's drawing contents
204.         this._textState = null; // Reset text state
205.     };
206. })();

复制代码

◆ Terms of Use
This plugin is released under MIT license.
You can download it by free, make a copy, modify and redistribute it as you want. (However, you should not delete the copyright claim and the MIT license clause written inside the plugin)
❤ Would be great if you put "Gamer Tool Studio " on the credits



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