An open library of RPG Maker MZ plugins, powered by the community.

PGMZ - The Community-Driven Plugin Library for RPG Maker MZ

MZ plugins

Novel Game UI - NovelGameUI.js

Plugin desc : Provides a novel-game like interface.

License : MIT License

Author : nz_prism

Website : https://github.com/nz-prism/RPG-Maker-MZ/blob/master/NovelGameUI/js/plugins/NovelGameUI.js

Desc page : https://github.com/nz-prism/RPG-Maker-MZ/blob/master/NovelGameUI/js/plugins/NovelGameUI.js

Download Page : https://raw.githubusercontent.com/nz-prism/RPG-Maker-MZ/master/NovelGameUI/js/plugins/NovelGameUI.js

File name : NovelGameUI.js

Help of plugin :

* @target MZ
 * @plugindesc Provides a novel-game like interface.
 * @author nz_prism
 * @url https://github.com/nz-prism/RPG-Maker-MZ/blob/master/NovelGameUI/js/plugins/NovelGameUI.js
 * @base OptionEx
 * @orderAfter OptionEx
 *
 * @help NovelGameUI.js
 * ver. 1.3.4
 * 
 * [History]
 * 02/20/2022 1.0.0 Released
 * 02/21/2022 1.0.1 Fixed an error in the battle.
 * 03/12/2022 1.0.2 Fixed minor issues and supported ClickAnimation.js
 * 03/16/2022 1.1.0 Added Hide UI functionality.
 * 03/22/2022 1.1.1 Fixed conflicts against other plugins.
 * 08/20/2022 1.2.0 Added functionalities to limit the number of logs and to
 *                  add logs manually. Fixed an issue when Scrolling Text is
 *                  shown.
 * 11/16/2022 1.3.0 Added Game End functionality.
 *                  Added functionalities to switch the visibility of pictures
 *                  when the UI is hidden.
 * 11/17/2022 1.3.1 Added default values for the new plugin parameters.
 * 01/03/2023 1.3.2 Fixed an error when using a keyboard/gamepad.
 * 01/29/2023 1.3.3 Now auto-mode is cleared when disabling control buttons.
 * 09/10/2023 1.3.4 Fixed an issue that the message paused right after
 *                  auto-mode was switched to ON.
 * 
 * This plugin provides a novel-game like interface usable when an event is
 * running on a map.
 * 
 * It requires OptionEx.js ver. 1.2.2 or later. Insert this plugin under
 * OptionEx.
 * 
 * It provides 8 functionalities;
 * 
 * 1. Options
 * 2. Save
 * 3. Load
 * 4. Log
 * 5. Skip
 * 6. Auto
 * 7. Hide UI
 * 8. Game End
 * 
 * You can select which functionality to use for the game. For example, you
 * can set it up to use only Log.
 * 
 * Each functionality corresponds to a button shown on the screen. Those
 * buttons appear only when the message window is shown. By tapping or clicking
 * the button, the corresponding functionality will be invoked. Also, you can
 * assign keys of a keyboard and buttons of a gamepad to the functionalities
 * to be used to invoke them by pressing.
 * If this plugin is enabled, players can use LT/RT/Menu/View buttons (as in
 *  XBox controller) of a gamepad, which are basically disabled by MZ default.
 * LT button is used as tab key, RT as control key, Menu as alt key and View as
 * F6 key. Therefore, you can assign the functionalities to the 8 buttons; X,
 * Y, LB, RB, LT, RT, Menu and View by using the plugin parameters.
 * Note when a message window is shown, players can usually proceed the message
 * by pressing either OK or Cancel button. However, if this plugin is enabled,
 * only OK button can be used for it. Thank you for your understanding!
 * 
 * By executing the plugin command ”Disable Control Buttons”, those buttons
 * will disappear. The corresponding keys/buttons will not work, either.
 * By executing the plugin command ”Enable Control Buttons”, the buttons will
 * appear and the corresponding keys/buttons will work again.
 * 
 * You can set pictures to each of the buttons. 2 patterns, selected and
 * unselected buttons, can be set.
 * 
 * 
 * 1. Options
 * The option scene will be invoked.
 * 
 * 
 * 2. Save
 * The save scene will be invoked even if an event is running. Note if save
 * access is disabled, the save scene won’t be called and the buzzer SE will be
 * played.
 * 
 * 
 * 3. Load
 * The load scene will be invoked even if an event is running.
 * 
 * 
 * 4. Log
 * A back log scene will be invoked. If the plugin parameter ”Use Log” is set
 * true, the texts shown by the event commands ”Show Text” and ”Show Scrolling
 * Text” will be stored. The log scene will show all the stored texts. Also, by
 * setting the plugin parameter ”Add Log Command”, the log scene can be invoked
 * from the menu, which enables players to see the log even after events finish
 * running. Since the stored texts are to be saved, they can be seen even after
 * loading. If the number of the stored logs exceeds the value of the plugin
 * parameter ”Max Storable Logs”, the oldest one will be deleted. if the value
 * is set 0 (it defaults 0), no logs are automatically deleted. In this case,
 * delete logs by using the plugin command ”Delete Logs”. Even though logs can
 * be stored unlimitedly, periodical delete is recommended to save save files’
 * volume.
 * 
 * By using the plugin command ”Disable Logging”, texts will not be stored
 * thereafter. By using the plugin command ”Enable Logging”, it restores the
 * default behavior and texts will be stored again.
 * 
 * You can control whether the text being shown will be appear on the log scene
 * by setting the plugin parameter ”Exclude Text Being Shown”. Note if this
 * value is true and the log scene is invoked during a message event, the
 * number of logs to be displayed will be the value of ”Max Storable Logs” - 1.
 * 
 * If no logs are stored, the log scene can’t be invoked and a buzzer SE will
 * be played. The log command on the menu is also disabled. Note if ”Exclude
 * Text Being Shown” is true, this will happen when the first message is shown.
 * 
 * You can add logs manually without displaying event messages by using the
 * plugin command ”Add Logs”. This command is useful when you display messages
 * as a picture without any message events.
 * 
 * 
 * 5. Skip
 * Event commands at a range can be skipped. To use this functionality, you
 * have to set an event command ”Label”. To use labels for it, the label names
 * must be unique digits. First, set a label event with an integer name greater
 * than 0 as a starting point, such as ”1”. You can set any event commands,
 * like Show Text, to be skipped under it. Under them, set a label event as an
 * ending pont with a name of an integer for the starting point + 1, such as
 * ”2”. I call the event commands between the starting and ending points ”Label
 * Sandwich”. Since label sandwiches can be skipped by players, you shouldn’t
 * set event commands required for the game flow, such as Control Switches. If
 * an event has 2 label sandwiches and you want to set event commands required
 * for the game flow between the sandwiches;
 * 
 *   Label:1
 *   Text:Reid, Actor1(0), Window, Bottom
 *     :Hello!
 *   Label:2
 *   Text:Priscilla, Actor1(1), Window, Bottom
 *     :(A message too important to be skipped)
 *   Control Switches:#0001 = ON
 *   Label:3
 *   Text:Gale, Actor1(2), Window, Bottom
 *     :Hello, Reid, Priscilla!
 *   Label:4
 * 
 * I call the first label sandwich ”A” and the second ”B”. The ending point
 * of A is ”2” and the starting point of B is ”3”. The event commands
 * between A and B, Text and Control Switches, can be skkiped since the label
 * names are sequential digits. To make them unskippable;
 * 
 *   Label:1
 *   Text:Reid, Actor1(0), Window, Bottom
 *     :Hello!
 *   Label:2
 *   Text:Priscilla, Actor1(1), Window, Bottom
 *     :(A message too important to be skipped)
 *   Control Switches:#0001 = ON
 *   Label:4
 *   Text:Gale, Actor1(2), Window, Bottom
 *     :Hello, Reid, Priscilla!
 *   Label:5
 * 
 * In this case, the commands can’t be skipped since A and B aren’t sequential
 * digits.
 * 
 * By default, players can skip only if the event contents have already been
 * seen. It regards them as ”already seen” if the ending point label has been
 * passed. Since it uses the label names, some event commands can be skipped
 * unintentionally if there are duplicate label names. I recommend you to take
 * notes for used label names not to use them again!
 * 
 * If the plugin parameter ”Make Master Save File” is set true (true by
 * default), it creates a new save file ”master.rmmzsave”, which stores passed
 * label names. To share passed flags, it will be loaded whichever save slot is
 * loaded, or a new game is started.
 * 
 * As mentioned above, players can skip only seen events by deafult. However,
 * if the option item ”Only Seen Events Skippable” is set OFF, they can skip
 * even unseen events. By setting the plugin parameter ”Use Only Seen Events
 * Skippable” true (true by default), the option item will be added to the
 * option scene. If you wouldn’t like players to skip unseen events, set the
 * parameter false in order not to add the command. Plus, set the plugin
 * parameter ”Default Only Seen Events Skippable” true (true by default).
 * 
 * If an event command being running is unskippable, the ”Disabled” button
 * pictures will be shown while ”Enabled” picture will appear if it’s
 * skippable. They visually help players to see if it’s skippable.
 * 
 * 
 * 6. Auto
 * If this functionality is invoked, the message window will move forward
 * automatically. It will not pause at the end of text and the control
 * character ”¥!” but wait for a specified frames. You can specify the frames
 * by the plugin parameter ”Pause Frames”.
 * 
 * If Auto is on, the ”On” button picture will be shown while ”Off” picture
 * will appear if auto is off. They visually help players to see if auto is
 * toggled.
 * 
 * 
 * 7. Hide UI
 * If this functionality is invoked, the UI components, such as windows or
 * control buttons, will be invisible and the message stops. If players
 * left/right-click or press OK/Cancel button, the UI components will be shown
 * and the message continues again. By setting picture IDs to the plugin
 * parameter ”Picture IDs to be Shown”, the pictures will usually be invisible
 * but visible only when the UI is hidden. Use it to show watermarks on a
 * picture. By setting picture IDs to the plugin parameter ”Picture IDs to be
 * Hidden”, the pictures will usually visible but invisible only when the UI is
 * hidden. Use it to hide UI components which are created by using the picture
 * commands.
 * 
 * 
 * 8. Game End
 * If this functionality is invoked, a dialog to return to the title will be
 * called. Unlike pressing F5, which immediately makes it return, this
 * functionality enables players to cancel returning.
 * 
 * 
 * This plugin is released under MIT license.
 * https://opensource.org/licenses/mit-license.php
 * 
 * 
 * @param buttonOpacity
 * @text Button Opacity
 * @desc The opacity for each control buttons.
 * @type number
 * @default 192
 * 
 * @param options
 * @text Options
 * @desc The settings for Options.
 * 
 * @param useOptions
 * @text Use Options
 * @desc If true, Options functionality can be used.
 * @parent options
 * @type boolean
 * @default true
 * 
 * @param optionsKey
 * @text Options Key
 * @desc A key of a keyboard and a button of a gamepad assigned to Options.
 * @parent options
 * @default menu
 * @type select
 * @option shift key/X button
 * @value shift
 * @option X key/Y button
 * @value menu
 * @option pageup key/LB button
 * @value pageup
 * @option pagedown key/RB button
 * @value pagedown
 * @option tab key/LT button
 * @value tab
 * @option control key/RT button
 * @value control
 * @option alt key/Menu button
 * @value alt
 * @option F6 key/View button
 * @value function
 * 
 * @param optionsButtonImages
 * @text Button Images
 * @desc The image settings for Options button.
 * @parent options
 * 
 * @param optionsButtonUnselectedImageName
 * @text Options Button Unselected Image
 * @desc The image for unselected Options button.
 * @parent optionsButtonImages
 * @type file
 * @dir img/system
 * 
 * @param optionsButtonSelectedImageName
 * @text Options Button Selected Image
 * @desc The image for selected Options button.
 * @parent optionsButtonImages
 * @type file
 * @dir img/system
 * 
 * @param optionsButtonCoordinates
 * @text Button Coordinates
 * @desc The coordinate settings for Options button.
 * @parent options
 * 
 * @param optionsButtonX
 * @text Option Button X
 * @desc The X coordinate for Options Button.
 * @parent optionsButtonCoordinates
 * @type number
 * @default 268
 * 
 * @param optionsButtonY
 * @text Option Button Y
 * @desc The Y coordinate for Options Button.
 * @parent optionsButtonCoordinates
 * @type number
 * @default 556
 * 
 * @param optionsButtonOrigin
 * @text Options Button Origin
 * @desc The origin for Options button.
 * @parent optionsButtonCoordinates
 * @default 0.5
 * @type select
 * @option Upper Left
 * @value 0
 * @option Center
 * @value 0.5
 * 
 * @param save
 * @text Save
 * @desc The settings for Save.
 * 
 * @param useSave
 * @text Use Save
 * @desc If true, Save functionality can be used.
 * @parent save
 * @type boolean
 * @default true
 * 
 * @param saveKey
 * @text Save Key
 * @desc A key of a keyboard and a button of a gamepad assigned to Save.
 * @parent save
 * @default control
 * @type select
 * @option shift key/X button
 * @value shift
 * @option X key/Y button
 * @value menu
 * @option pageup key/LB button
 * @value pageup
 * @option pagedown key/RB button
 * @value pagedown
 * @option tab key/LT button
 * @value tab
 * @option control key/RT button
 * @value control
 * @option alt key/Menu button
 * @value alt
 * @option F6 key/View button
 * @value function
 * 
 * @param saveButtonImages
 * @text Button Images
 * @desc The image settings for Save button.
 * @parent save
 * 
 * @param saveButtonUnselectedImageName
 * @text Save Button Unselected Image
 * @desc The image for unselected Save button.
 * @parent saveButtonImages
 * @type file
 * @dir img/system
 * 
 * @param saveButtonSelectedImageName
 * @text Save Button Selected Image
 * @desc The image for selected Save button.
 * @parent saveButtonImages
 * @type file
 * @dir img/system
 * 
 * @param saveButtonCoordinates
 * @text Button Coordinates
 * @desc The coordinate settings for Save button.
 * @parent save
 * 
 * @param saveButtonX
 * @text Save Button X
 * @desc The X coordinate for Save Button.
 * @parent saveButtonCoordinates
 * @type number
 * @default 364
 * 
 * @param saveButtonY
 * @text Save Button Y
 * @desc The Y coordinate for Save Button.
 * @parent saveButtonCoordinates
 * @type number
 * @default 556
 * 
 * @param saveButtonOrigin
 * @text Save Button Origin
 * @desc The origin for Save button.
 * @parent saveButtonCoordinates
 * @default 0.5
 * @type select
 * @option Upper Left
 * @value 0
 * @option Center
 * @value 0.5
 * 
 * @param load
 * @text Load
 * @desc The settings for Load.
 * 
 * @param useLoad
 * @text Use Load
 * @desc If true, Load functionality can be used.
 * @parent load
 * @type boolean
 * @default true
 * 
 * @param loadKey
 * @text Load Key
 * @desc A key of a keyboard and a button of a gamepad assigned to Load.
 * @parent load
 * @default tab
 * @type select
 * @option shift key/X button
 * @value shift
 * @option X key/Y button
 * @value menu
 * @option pageup key/LB button
 * @value pageup
 * @option pagedown key/RB button
 * @value pagedown
 * @option tab key/LT button
 * @value tab
 * @option control key/RT button
 * @value control
 * @option alt key/Menu button
 * @value alt
 * @option F6 key/View button
 * @value function
 * 
 * @param loadButtonImages
 * @text Button Images
 * @desc The image settings for Load button.
 * @parent load
 * 
 * @param loadButtonUnselectedImageName
 * @text Load Button Unselected Image
 * @desc The image for unselected Load button.
 * @parent loadButtonImages
 * @type file
 * @dir img/system
 * 
 * @param loadButtonSelectedImageName
 * @text Load Button Selected Image
 * @desc The image for selected Load button.
 * @parent loadButtonImages
 * @type file
 * @dir img/system
 * 
 * @param loadButtonCoordinates
 * @text Button Coordinates
 * @desc The coordinates settings for Load button.
 * @parent load
 * 
 * @param loadButtonX
 * @text Load Button X
 * @desc The X coordinate for Load button.
 * @parent loadButtonCoordinates
 * @type number
 * @default 460
 * 
 * @param loadButtonY
 * @text Load Button Y
 * @desc The Y coordinate for Load button.
 * @parent loadButtonCoordinates
 * @type number
 * @default 556
 * 
 * @param loadButtonOrigin
 * @text Load Button Origin
 * @desc The origin for Load button.
 * @parent loadButtonCoordinates
 * @default 0.5
 * @type select
 * @option Upper Left
 * @value 0
 * @option Center
 * @value 0.5
 * 
 * @param log
 * @text Log
 * @desc The settings for Log.
 * 
 * @param useLog
 * @text Use Log
 * @desc If true, Log functionality can be used.
 * @parent log
 * @type boolean
 * @default true
 * 
 * @param logKey
 * @text Log Key
 * @desc A key of a keyboard and a button of a gamepad assigned to Log.
 * @parent log
 * @default pageup
 * @type select
 * @option shift key/X button
 * @value shift
 * @option X key/Y button
 * @value menu
 * @option pageup key/LB button
 * @value pageup
 * @option pagedown key/RB button
 * @value pagedown
 * @option tab key/LT button
 * @value tab
 * @option control key/RT button
 * @value control
 * @option alt key/Menu button
 * @value alt
 * @option F6 key/View button
 * @value function
 * 
 * @param excludeCurrentMessage
 * @text Exclude Text Being Shown
 * @desc If true, the text being shown will not be added to the log scene.
 * @parent log
 * @type boolean
 * @default true
 * 
 * @param maxStorableLogs
 * @text Max Storable Logs
 * @desc If the number of the stored logs exceeds this value, the oldest one will be deleted. If set 0, no logs are deleted.
 * @parent log
 * @type number
 * @default 0
 * @min 0
 * 
 * @param logSpeakerNameHeader
 * @text Speaker Name Header String
 * @desc The string added before the speaker name usable to change size/color of the font.
 * @parent log
 * @type string
 * @default ¥C[14]¥FS[20]
 * 
 * @param logMessagePads
 * @text Text Indent Spaces
 * @desc Number of spaces added before each lne. If the speaker name is blank, none will be added.
 * @parent log
 * @type number
 * @default 2
 * @min 0
 * 
 * @param addLogCommand
 * @text Add Log Command
 * @desc Add Log command to the menu.
 * @parent log
 * @type boolean
 * @default true
 * 
 * @param logCommandName
 * @text Log Command Name
 * @desc The name of the command to invoke the Log scene.
 * @parent addLogCommand
 * @type string
 * @default Back Log
 * 
 * @param logButtonImages
 * @text Button Images
 * @desc The settings for Log button.
 * @parent log
 * 
 * @param logButtonUnselectedImageName
 * @text Log Button Unselected Image
 * @desc The image for unselected Log button.
 * @parent logButtonImages
 * @type file
 * @dir img/system
 * 
 * @param logButtonSelectedImageName
 * @text Log Button Selected Image
 * @desc The image for selected Log button.
 * @parent logButtonImages
 * @type file
 * @dir img/system
 * 
 * @param logButtonCoordinates
 * @text Button Coordinates
 * @desc The coordinate settings for Log button.
 * @parent log
 * 
 * @param logButtonX
 * @text Log Button X
 * @desc The X coordinate for Log button.
 * @parent logButtonCoordinates
 * @type number
 * @default 556
 * 
 * @param logButtonY
 * @text Log Button Y
 * @desc The Y coordinate for Log button.
 * @parent logButtonCoordinates
 * @type number
 * @default 556
 * 
 * @param logButtonOrigin
 * @text Log Button Origin
 * @desc The origin for Log buton.
 * @parent logButtonCoordinates
 * @default 0.5
 * @type select
 * @option Upper Left
 * @value 0
 * @option Center
 * @value 0.5
 * 
 * @param skip
 * @text Skip
 * @desc The settings for Skip.
 * 
 * @param useSkip
 * @text Use Skip
 * @desc If true, Skip functionality can be used.
 * @parent skip
 * @type boolean
 * @default true
 * 
 * @param skipKey
 * @text Skip Key
 * @desc A key of a keyboard and a button of a gamepad assigned to Skip.
 * @parent skip
 * @default pagedown
 * @type select
 * @option shift key/X button
 * @value shift
 * @option X key/Y button
 * @value menu
 * @option pageup key/LB button
 * @value pageup
 * @option pagedown key/RB button
 * @value pagedown
 * @option tab key/LT button
 * @value tab
 * @option control key/RT button
 * @value control
 * @option alt key/Menu button
 * @value alt
 * @option F6 key/View button
 * @value function
 * 
 * @param makeMasterInfo
 * @text Make Master Save File
 * @desc Creates a master save file to share seen event information.
 * @parent skip
 * @default true
 * @type boolean
 * 
 * @param skipButtonImages
 * @text Button Images
 * @desc The image settings for Skip button.
 * @parent skip
 * 
 * @param skipButtonUnselectedDisabledImageName
 * @text Skip Button (Disabled) Unselected Image
 * @desc The image for unselected and disabled Skip button.
 * @parent skipButtonImages
 * @type file
 * @dir img/system
 * 
 * @param skipButtonSelectedDisabledImageName
 * @text Skip Button (Disabled) Selected Image
 * @desc The image for selected and disabled Skip button.
 * @parent skipButtonImages
 * @type file
 * @dir img/system
 * 
 * @param skipButtonUnselectedEnabledImageName
 * @text Skip Button (Enabled) Unselected Image
 * @desc The image for unselected and enabled Skip button.
 * @parent skipButtonImages
 * @type file
 * @dir img/system
 * 
 * @param skipButtonSelectedEnabledImageName
 * @text Skip Button (Enabled) Selected Image
 * @desc The image for selected and enabled Skip button.
 * @parent skipButtonImages
 * @type file
 * @dir img/system
 * 
 * @param skipButtonCoordinates
 * @text Button Coordinates
 * @desc The coordinate settings for Skip button.
 * @parent skip
 * 
 * @param skipButtonX
 * @text Skip Button X
 * @desc The X coordinate for Skip button.
 * @parent skipButtonCoordinates
 * @type number
 * @default 642
 * 
 * @param skipButtonY
 * @text Skip Button Y
 * @desc The Y coordinate for Skip button.
 * @parent skipButtonCoordinates
 * @type number
 * @default 556
 * 
 * @param skipButtonOrigin
 * @text Skip Button Origin
 * @desc The origin for Skip button.
 * @parent skipButtonCoordinates
 * @default 0.5
 * @type select
 * @option Upper Left
 * @value 0
 * @option Center
 * @value 0.5
 * 
 * @param skipOptions
 * @text Skip Option
 * @desc The settings for Skip option.
 * @parent skip
 * 
 * @param useLimitSkip
 * @text Use Only Seen Events Skippable
 * @desc If true, Only Seen Events Skippable option will be added to the options scene.
 * @parent skipOptions
 * @default true
 * @type boolean
 * 
 * @param limitSkipName
 * @text Only Seen Events Skippable Name
 * @desc The name for Only Seen Events Skippable option.
 * @default Only Seen Events Skippable
 * @parent skipOptions
 * @type string
 * 
 * @param defaultLimitSkip
 * @text Default Only Seen Events Skippable
 * @desc The default value for Only Seen Events Skippable option.
 * @parent skipOptions
 * @default true
 * @type boolean
 * 
 * @param auto
 * @text Auto
 * @desc The settings for Auto.
 * 
 * @param useAuto
 * @text Use Auto
 * @desc If true, Auto functionality can be used.
 * @parent auto
 * @type boolean
 * @default true
 * 
 * @param autoKey
 * @text Auto Key
 * @desc A key of a keyboard and a button of a gamepad assigned to Auto.
 * @parent auto
 * @default shift
 * @type select
 * @option shift key/X button
 * @value shift
 * @option X key/Y button
 * @value menu
 * @option pageup key/LB button
 * @value pageup
 * @option pagedown key/RB button
 * @value pagedown
 * @option tab key/LT button
 * @value tab
 * @option control key/RT button
 * @value control
 * @option alt key/Menu button
 * @value alt
 * @option F6 key/View button
 * @value function
 * 
 * @param autoPauseFrames
 * @text Pause Frames
 * @desc The frames to wait of the message windoow.
 * @parent auto
 * @type number
 * @default 30
 * 
 * @param autoButtonImages
 * @text Button Images
 * @desc The image settings for Auto button.
 * @parent auto
 * 
 * @param autoButtonUnselectedOffImageName
 * @text Auto Button (Off) Unselected Image
 * @desc The image for unselected and off Auto button.
 * @parent autoButtonImages
 * @type file
 * @dir img/system
 * 
 * @param autoButtonSelectedOffImageName
 * @text Auto Button (Off) Selected Image
 * @desc The image for selected and off Auto button.
 * @parent autoButtonImages
 * @type file
 * @dir img/system
 * 
 * @param autoButtonUnselectedOnImageName
 * @text Auto Button (On) Unselected Image
 * @desc The image for unselected and on Auto button.
 * @parent autoButtonImages
 * @type file
 * @dir img/system
 * 
 * @param autoButtonSelectedOnImageName
 * @text Auto Button (On) Selected Image
 * @desc The image for selected and on Auto button.
 * @parent autoButtonImages
 * @type file
 * @dir img/system
 * 
 * @param autoButtonCoordinates
 * @text Button Coordinates
 * @desc The coordinate settings for Auto button.
 * @parent auto
 * 
 * @param autoButtonX
 * @text Auto Button X
 * @desc The X coordinate for Auto button.
 * @parent autoButtonCoordinates
 * @type number
 * @default 748
 * 
 * @param autoButtonY
 * @text Auto Button Y
 * @desc The Y coordinate for Auto button.
 * @parent autoButtonCoordinates
 * @type number
 * @default 556
 * 
 * @param autoButtonOrigin
 * @text Auto Button Origin
 * @desc The origin for Auto button.
 * @parent autoButtonCoordinates
 * @default 0.5
 * @type select
 * @option Upper Left
 * @value 0
 * @option Center
 * @value 0.5
 * 
 * @param hideUi
 * @text Hide UI
 * @desc The settings for Hide UI.
 * 
 * @param useHideUi
 * @text Use Hide UI
 * @desc If true, Hide UI functionality can be used.
 * @parent hideUi
 * @type boolean
 * @default true
 * 
 * @param hideUiKey
 * @text Hide UI Key
 * @desc A key of a keyboard and a button of a gamepad assigned to Hide UI.
 * @parent hideUi
 * @default alt
 * @type select
 * @option shift key/X button
 * @value shift
 * @option X key/Y button
 * @value menu
 * @option pageup key/LB button
 * @value pageup
 * @option pagedown key/RB button
 * @value pagedown
 * @option tab key/LT button
 * @value tab
 * @option control key/RT button
 * @value control
 * @option alt key/Menu button
 * @value alt
 * @option F6 key/View button
 * @value function
 * 
 * @param hideUiPictures
 * @text Pictures
 * @desc The settngs to switch the visibility of pictures when the UI is hidden.
 * @parent hideUi
 * 
 * @param hideUiVisiblePictureIds
 * @text Picture IDs to be Shown
 * @desc The picture IDs which are usually hidden but will be shown only when the UI is hidden.
 * @parent hideUiPictures
 * @type number[]
 * @min 1
 * @default []
 * 
 * @param hideUiInvisiblePictureIds
 * @text Picture IDs to be Hidden
 * @desc The picture IDs which are usually shown but will be hidden only when the UI is hidden.
 * @parent hideUiPictures
 * @type number[]
 * @min 1
 * @default []
 * 
 * @param hideUiButtonImages
 * @text Button Images
 * @desc The image settings for Hide UI button.
 * @parent hideUi
 * 
 * @param hideUiButtonUnselectedImageName
 * @text Hide UI Button Unselected Image
 * @desc The image for unselected Hide UI button.
 * @parent hideUiButtonImages
 * @type file
 * @dir img/system
 * 
 * @param hideUiButtonSelectedImageName
 * @text Hide UI Button Selected Image
 * @desc The image for selected Hide UI button.
 * @parent hideUiButtonImages
 * @type file
 * @dir img/system
 * 
 * @param hideUiButtonCoordinates
 * @text Button Coordinates
 * @desc The coordinate settings for Hide UI button.
 * @parent hideUi
 * 
 * @param hideUiButtonX
 * @text Hide UI Button X
 * @desc The X coordinate for Hide UI Button.
 * @parent hideUiButtonCoordinates
 * @type number
 * @default 172
 * 
 * @param hideUiButtonY
 * @text Hide UI Button Y
 * @desc The Y coordinate for Hide UI Button.
 * @parent hideUiButtonCoordinates
 * @type number
 * @default 556
 * 
 * @param hideUiButtonOrigin
 * @text Hide UI Button Origin
 * @desc The origin for Hide UI button.
 * @parent hideUiButtonCoordinates
 * @default 0.5
 * @type select
 * @option Upper Left
 * @value 0
 * @option Center
 * @value 0.5
 * 
 * @param gameEnd
 * @text Game End
 * @desc The settings for Game End functionality.
 * 
 * @param useGameEnd
 * @text Use Game End
 * @desc If true, Game End functionality can be used.
 * @parent gameEnd
 * @type boolean
 * @default true
 * 
 * @param gameEndKey
 * @text Game End Key
 * @desc A key of a keyboard and a button of a gamepad assigned to Game End.
 * @parent gameEnd
 * @default function
 * @type select
 * @option shift key/X button
 * @value shift
 * @option X key/Y button
 * @value menu
 * @option pageup key/LB button
 * @value pageup
 * @option pagedown key/RB button
 * @value pagedown
 * @option tab key/LT button
 * @value tab
 * @option control key/RT button
 * @value control
 * @option alt key/Menu button
 * @value alt
 * @option F6 key/View button
 * @value function
 * 
 * @param gameEndButtonImages
 * @text Button Images
 * @desc The image settings for Game End button.
 * @parent gameEnd
 * 
 * @param gameEndButtonUnselectedImageName
 * @text Game End Button Unselected Image
 * @desc The image for unselected Game End button.
 * @parent gameEndButtonImages
 * @type file
 * @dir img/system
 * 
 * @param gameEndButtonSelectedImageName
 * @text Game End Button Selected Image
 * @desc The image for selected Game End button.
 * @parent gameEndButtonImages
 * @type file
 * @dir img/system
 * 
 * @param gameEndButtonCoordinates
 * @text Button Coordinates
 * @desc The coordinate settings for Game End button.
 * @parent gameEnd
 * 
 * @param gameEndButtonX
 * @text Game End Button X
 * @desc The X coordinate for Game End Button.
 * @parent gameEndButtonCoordinates
 * @type number
 * @default 240
 * 
 * @param gameEndButtonY
 * @text Game End Button Y
 * @desc The Y coordinate for Game End Button.
 * @parent gameEndButtonCoordinates
 * @type number
 * @default 400
 * 
 * @param gameEndButtonOrigin
 * @text Game End Button Origin
 * @desc The origin for Game End button.
 * @parent gameEndButtonCoordinates
 * @default 0.5
 * @type select
 * @option Upper Left
 * @value 0
 * @option Center
 * @value 0.5
 * 
 * @command enableControlButtons
 * @text Enable Control Buttons
 * @desc Enables each control button.
 * 
 * @command disableControlButtons
 * @text Disable Control Buttons
 * @desc Disables each control button.
 * 
 * @command enableLogging
 * @text Enable Logging
 * @desc The texts will be stored.
 * 
 * @command disableLogging
 * @text Disable Logging
 * @desc The texts will not be stored until enabling logging.
 * 
 * @command clearBackLogs
 * @text Delete Logs
 * @desc Deletes all the stored logs.
 * 
 * @command addBackLogs
 * @text Add Logs
 * @desc Adds specified texts as a log.
 * 
 * @arg logSpeaker
 * @text Log Speaker
 * @desc The speaker of this log. If not necessary, set it blank.
 * @type text
 * 
 * @arg logTexts
 * @text Log Texts
 * @desc The texts to be logged. Control characters can be used. Multiple lines can be set.
 * @type text[]
 *

スポンサードリンク

-MZ plugins

Copyright© PGMZ - The Community-Driven Plugin Library for RPG Maker MZ , 2026 All Rights Reserved.