Map Name Extend - MapNameExtend.js

Plugin desc : Map name display extension plugin

License : MIT License

Author : Triacontane

Website : https://triacontane.blogspot.com

Desc page : https://github.com/triacontane/RPGMakerMV/tree/mz_master/MapNameExtend.js

Download Page : https://raw.githubusercontent.com/munokura/triacontane-MZ-plugins/refs/heads/main/MapNameExtend.js

File name : MapNameExtend.js

Help of plugin :

@target MZ
@url https://github.com/triacontane/RPGMakerMV/tree/mz_master/MapNameExtend.js
@plugindesc Map name display extension plugin
@author Triacontane
@license MIT License

@help
English Help Translator: munokura
This is an unofficial English translation of the plugin help,
created to support global RPG Maker users.
Feedback is welcome to improve translation quality
(see: https://github.com/munokura/triacontane-MZ-plugins ).
Original plugin by Triacontane.
Please check the latest official version at:
https://triacontane.blogspot.com
-----

MapNameExtend.js

Extends the map name display function.

Feature List
1. You can make the map background a window or change it to a custom picture.
2. You can specify detailed settings such as display position， movement
method， and fade speed.
3. You can use control characters in map names.
4. You can display two or more map names consecutively.
5. You can display map names as their ”real names” in the editor tree view.

To use feature 4， enter the following in the map name memo field:
<MapName2:aaa> # ”aaa” will be added after the map name.
<MapName2:aaa> # Same as above.
* If you want to display three or more maps， use ”<MNE_MapName3:aaa>”.

This plugin requires the base plugin ”PluginCommonBase.js.”
”PluginCommonBase.js” is located in the following folder
under the RPG Maker MZ installation folder:
dlc/BasicResources/plugins/official

Terms of Use:
You may modify and redistribute this plugin without permission from the
author， and there are no restrictions on its use (commercial， 18+， etc.).
This plugin is now yours.

@param positionX
@text X coordinate
@desc Enter the X coordinate if you want to specify it.
@type number
@default 0

@param positionY
@text Y coordinate
@desc Enter the Y coordinate if you want to specify it.
@type number
@default 0

@param centering
@text centering
@desc The map name is displayed in the center of the screen.
@type boolean
@default false

@param moveXInFade
@text Move X during fade
@desc The number of pixels to move in the X direction during the fade in/out.
@type number
@default 0

@param moveYInFace
@text Move Y during fade
@desc The number of pixels to move in the Y direction during the fade in or out.
@type number
@default 0

@param allDuration
@text Total number of frames
@desc The total number of frames until the map name is displayed and disappears. If you want it to be displayed forever， enter ”Infinity”.
@type number
@default 300
@min 1

@param fadeInSpeed
@text Fade-in Speed
@desc Map name fade-in speed (default 16)
@type number
@default 0

@param viewDelay
@text Display Delay
@desc Delays the display of the map name by the specified number of frames.
@type number
@default 0

@param width
@text Width
@desc Enter the width if you want to specify it.
@type number
@default 0

@param height
@text height
@desc Enter the height if you want to specify it.
@type number
@default 0

@param showWindow
@text Window Display
@desc Window the map name display.
@type boolean
@default false

@param backgroundImage
@text background image
@desc Specify the file name of the dedicated background image (img/pictures). No extension required.
@type file
@require 1
@dir img/pictures/

@param showReal
@text Real name display
@desc If the editor’s ”Display Name” is not specified， the map name will be displayed as the ”Real Name” displayed in the tree.
@type boolean
@default false

@param mapNameFormat
@text Map Name Format
@desc Display format of map name. Various control characters can be used. %1 will be replaced with the map name.
@type string

@param useControlCharacter
@text Use of control characters
@desc Enables the use of control characters in map name display. The function to automatically adjust the map name display width is disabled and the map name is forced to be left-justified.
@type boolean
@default false

@param noSameNameDisplay
@text Do not output the same map name
@desc When moving to a new location， if the map display name is the same as the map before moving， the map name will not be output.
@type boolean
@default false

@param hideSwitch
@text Hidden Switch
@desc If the total number of frames is set to Infinity， the map name will be hidden when the specified switch is ON.
@type switch
@default 0

@param hideInEventRunning
@text Not displayed during event execution
@desc If the total number of frames is set to Infinity， the map name will be hidden while the event is running.
@type boolean
@default false

@param showOnMessage
@text Displayed even when a message is displayed
@desc The map name will be displayed even while the message window is displayed (it will be automatically hidden by default).
@type boolean
@default false

munokura

Welcome to PGMZ! My goal is to make it easy for everyone to find and share great plugins for creating amazing games. As a plugin developer myself, I'm excited to grow this community with all of you.