Menu Sub Command - MenuSubCommand.js

Plugin desc : Menu screen subcommand plugin

License : MIT License

Author : Triacontane

Website : https://triacontane.blogspot.com

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

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

File name : MenuSubCommand.js

Help of plugin :

@target MZ
@url https://github.com/triacontane/RPGMakerMV/tree/mz_master/MenuSubCommand.js
@plugindesc Menu screen subcommand 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
-----

MenuSubCommand.js

You can add any number of commands with custom names to the main menu screen，
and any number of subcommands displayed in a tree structure.
Executing (confirming) a subcommand will either execute a script，
or move to a specified map (both are possible).

Scripts are primarily used to transition to other screens created by scripts.
Of course， you can also transition to screens added by other plugins.
Map transitions are primarily used to transition to custom menu screens
triggered by events.
To return from a custom menu screen， simply reopen the menu.
The original menu location is saved separately， so you don’t need to worry
about it.

In addition to the standard vertical layout and menu screen， this plugin also
supports horizontal menu screens created by plugins.

If all subcommands are hidden， the parent item itself will also be hidden.
If all subcommands are disabled， the parent item itself will also be disabled.

If there is only one subcommand， the subcommand window will not be displayed，
and the subcommand will be executed when the parent command is selected.

This plugin does not have any plugin commands.

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 subCommands
@text Subcommands
@desc Subcommand information.
@type struct<SubCommand>[]

@param commandPosition
@text Command addition position
@desc The position where the subcommands are added. If you specify 0， they are added to the top of the window.
@type number
@default 0

@param subMenuWidth
@text Submenu width
@desc The width of the window in which the submenu is displayed. If not specified， the default value ”240” is applied.
@type number
@default 0

@param selectActorIdVariable
@text Selected Actor ID variable
@desc This is the variable number that stores the actor’s ID when an actor is selected from a subcommand.
@type variable
@default 0

@param windowSkin
@text Window Skin
@desc Sets a dedicated skin for the subcommand window.
@type file
@require 1
@dir img/system/

@param hideOption
@text Option Clear
@desc Clear the option from the main menu.
@type boolean
@default false

@param hideGameEnd
@text End game and delete
@desc Clears the exit game from the main menu.
@type boolean
@default false

@param horizontalSubMenu
@text Side by side
@desc Arranges commands in submenus horizontally.
@type boolean
@default false

@param clearSubMenuOneByObe
@text Clear when command is selected
@desc The window will be cleared when you select the subcommand.
@type boolean
@default true

@param subMenuX
@text Submenu X coordinate
@desc If specified， the X coordinate of the subcommand will be a fixed value.
@type number
@default 0

@param subMenuY
@text Submenu Y coordinate
@desc If specified， the Y coordinate of the subcommand will be a fixed value.
@type number
@default 0

@param adjustX
@text Submenu X coordinate correction
@desc Corrects the X coordinate of the subcommand by the specified value.
@type number
@default 0
@min -9999

@param adjustY
@text Submenu Y coordinate correction
@desc Corrects the Y coordinate of the subcommand by the specified value.
@type number
@default 0
@min -9999

@param subMenuAlign
@text Submenu Alignment
@desc Sets the alignment of the subcommand.
@type select
@option Left-justified
@value left
@option Centered (default)
@value center
@option Right-justified
@value right

@param overlapOther
@text Overlay on other windows
@desc Makes the submenu window transparent， allowing you to see windows behind it.
@type boolean
@default true

@param openAnimation
@text Opening and closing animation display
@desc Displays opening and closing animations when displaying submenu windows.
@type boolean
@default false

@param anotherPicInMenuMap
@text Menu picture management
@desc The display state of the menu map and normal map pictures is managed separately.
@type boolean
@default false

@param autoTransparent
@text Automatic transparency
@desc Automatically makes the player invisible when moving between sub-maps.
@type boolean
@default true

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.