画面にテキスト編集ボックスを表示できるプラグイン – RS_InputDialog.js

============================================================================
Introduction
============================================================================

This plugin adds a robust text input system to your RPG Maker MV games,
allowing players to enter text or numbers directly within the game.
You can use this for character naming, password systems, quiz games,
message input, numeric code entry, and many other interactive features.

The input dialog works in both map scenes and battle scenes, and offers
extensive customization options including size, position, appearance,
and button naming.

============================================================================
Features
============================================================================

- Display a text input dialog anywhere in your game
- Works in both map scenes and battle scenes
- Automatically saves input to a game variable
- Customizable width, height, position and appearance
- Support for mobile devices with proper keyboard handling
- RTL (Right-to-Left) language support
- Custom CSS styling for complete visual control
- Customizable button names and text hints
- Maximum character limit setting

=============================================================================
Plugin Commands
=============================================================================
This plugin allows you to create an <input> field to receive text input from the user.
Below are the available commands and their descriptions:

InputDialog open
- Opens the input dialog window and displays it on the screen.
- This command activates the text input field with all current settings.
- The player can then type text which will be stored in the designated variable.

InputDialog width [number]
- Changes the width of Input Dialog in pixels.
- Example: InputDialog width 488
- Note: The width must be at least 28 pixels to be visible.
- This affects only future dialog openings, not currently open ones.

InputDialog text [text]
- Changes the text hint (placeholder text) shown in the input field.
- Example: InputDialog text Please enter your character name...
- Multiple words are allowed; the entire text after "text" becomes the hint.

InputDialog variableID [number]
- Changes which game variable will store the input result.
- Example: InputDialog variableID 3
- The input text will be stored in this variable when OK is clicked or Enter is pressed.
- If the input contains only numbers, it will be converted to a number type.

InputDialog debug [true/false]
- When set to true, shows a debug message with the input value.
- Example: InputDialog debug true
- Useful during development to verify the input is being captured correctly.

InputDialog maxLength [number]
- Specifies the maximum number of characters allowed in the input field.
- Example: InputDialog maxLength 10
- Valid range is from 1 to 255 characters.

InputDialog pos [position]
- Sets the position of the input dialog on the screen.
- Two formats are supported:
InputDialog pos center (centers the dialog on screen)
InputDialog pos 0 0 (positions at specific x, y coordinates)

Additional Notes:
- Ensure that the specified variable ID is valid and exists in the game database.
- The input field accepts alphanumeric characters unless further restrictions are applied.
- Default settings apply if commands are not used.

============================================================================
Script Calls
============================================================================

RS.InputDialog.createInstance()
- Opens the input dialog programmatically

RS.InputDialog.isEqual(text)
- Checks if the variable value matches the specified text
- Returns true or false
- Example: if(RS.InputDialog.isEqual("PASSWORD")) {
do something
}

this.isEqualInputData(text)
- Same as above but usable in event scripts

============================================================================
Usage Examples
============================================================================

Example 1: Name Entry System
1. Use "InputDialog text Enter character name..." to set hint text
2. Use "InputDialog open" to show the dialog
3. Store player input in Variable #3 (or change with variableID command)
4. Use the variable with \V[3] in messages or for character naming

Example 2: Password System
1. Set up the input dialog with appropriate settings
2. Open the dialog when player interacts with a door/chest
3. Use conditional branch with script: this.isEqualInputData("SECRET")
4. Execute different events based on correct/incorrect password

Example 3: Quiz Game
1. Display a question to the player using Show Text
2. Open input dialog for answer
3. Check if the input matches the correct answer
4. Award points or proceed based on correctness

============================================================================
Compatibility Notes
============================================================================

- Works in both desktop and mobile environments
- Compatible with most other plugins
- Special compatibility with Irina_PerformanceUpgrade plugin
- Optimized for RMMV 1.5.1 and later versions

============================================================================
Technical Notes
============================================================================

- Input is stored as a string by default unless it contains only numbers
- Numeric-only input is automatically converted to number type
- The dialog creates HTML elements that overlay the game canvas
- Mobile optimization includes automatic keyboard display and positioning

=============================================================================
Change Log
=============================================================================
2016.08.09 (v1.0.0) - First Release.
2016.08.09 (v1.0.1) - Added Background Color.
2016.08.10 (v1.0.1a) - Added ID Variables.
2016.08.10 (v1.1.0) - Fixed Window_DialogHelp class into the plugin.
2016.08.16 (v1.1.1) - Added the direction property setting the direction of content flow.
2016.08.16 (v1.1.1a) - Fixed a whitespace bug.
2016.10.14 (v1.1.2) - Fixed the issue that is not working in Battle.
2016.10.14 (v1.1.3) :
- Fixed the bug that does not change the background color.
- Fixed the bug that does not change the variable ID.
2016.10.17 (v1.1.4) - Fixed the frame works of input dialog in battle.
2016.10.18 (v1.1.5) - Fixed an issue that battler's movement is too fast.
2016.10.29 (v1.1.6) - Added the function that allows you to specify the maximum number of character for an input field.
2016.11.13 (v1.1.6a) - Fixed the issue that is directly calling the requestUpdate function of SceneManager.
2016.12.02 (v1.1.6e) :
- Added some style codes such as a text shadow and an outline into the text box.
- Fixed the way that can temporarily stop attack and skill actions with an enemy when the text box is activated in the battle.
- It will not process the text input when the text box is not shown in the battle.
- In the debug mode, It adds the result value to a log window after the text input is done.
2016.12.08 (v1.1.6h) - Removed the text hint window.
2016.12.17 (v1.1.6i) - Fixed an issue that an integer value could not be checked due to the text type issue.
2017.01.30 (v1.1.7) - Fixed an issue that is not working properly if the text dialog has a string to start with a number.
2017.02.16 (v1.1.8) :
- Fixed incorrect position and width, height values in the text box.
- Added new feature that indicates the input dialog at the top position of the screen when pressing any key on your own mobile device.
- Added new feature that automatically returns a result of the text box if you did not press anything.
2018.01.25 (v1.1.8a) - test...
2018.01.30 (v1.1.9) :
- Added the button called 'OK'.
- Added the button called 'Cancel'.
- Removed the feature that can change the background-color of the input dialog.
- Fixed the issue that is not clicking the button in the mobile.
2018.02.03 (v1.1.10) :
- Fixed the issue that is not working in RMMV 1.5.1
- Fixed the default value of the plugin parameter called 'CSS'.
2018.02.06 (v1.1.11) :
- Fixed the issue that is not working in the battle scene.
2018.10.22 (v1.1.15) :
- Added a plugin command that sets the position of the input dialog.
- Added a feature that the keyboard layout is displayed again if you touch the text box from android devices.
- On the mobile device, the font size is now set to 1rem (16px).
- Fixed the default UI-theme is to black.
- In the chromium 69+ more over, The input element is always displayed even though <canvas>'s z-index is large than <input> element's z-index. so I've fixed that.
2019.03.05 (v1.1.16) :
- Fixed the issue that can not create a background when using Irina_PerformanceUpgrade.
2023.04.30 (v1.2.1) :
- Added a feature that can change the font family.
- Added 'const' or 'let' keyword instead of 'var' keyword.
- Added a comment called 'MV'
2024.01.01 (v1.3.0) :
- fixed the issue that can't move cursor by touch on mobile device
2024.10.19 (v1.4) :
- Added a new event listener for onchange event.