development:technical-details:patches:maniac:modified-maniac-commands
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| development:technical-details:patches:maniac:modified-maniac-commands [2026/10/01 12:36] – carbonara | development:technical-details:patches:maniac:modified-maniac-commands [2026/11/09 15:01] (current) – carbonara | ||
|---|---|---|---|
| Line 2: | Line 2: | ||
| This page lists the commands that received new features in the [[..: | This page lists the commands that received new features in the [[..: | ||
| + | |||
| + | Those commands can be written either through the Maniac Patch editor, through the [[..: | ||
| FIXME //This page is currently a stub, most commands still need to be filled.// | FIXME //This page is currently a stub, most commands still need to be filled.// | ||
| ===== Display Text Settings ===== | ===== Display Text Settings ===== | ||
| + | |||
| + | FIXME | ||
| ===== Change Faceset ===== | ===== Change Faceset ===== | ||
| + | |||
| + | FIXME | ||
| ===== Control Variables ===== | ===== Control Variables ===== | ||
| + | |||
| + | FIXME | ||
| ===== Change Party Member ===== | ===== Change Party Member ===== | ||
| + | |||
| + | FIXME | ||
| ===== Change State ===== | ===== Change State ===== | ||
| + | |||
| + | FIXME | ||
| ===== Change Actor Name ===== | ===== Change Actor Name ===== | ||
| + | //Player status: Supported// ✅ | ||
| + | |||
| + | The **Change Actor Name** command allows to change the name of an actor. | ||
| + | |||
| + | The Maniac Patch supports the use of a variable or variable redirection for the ID of the actor, as well as using a string variable or string variable redirection for the name. | ||
| + | |||
| + | The common TPC syntax is < | ||
| + | |||
| + | Raw writing: < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| ===== Change Actor Nickname ===== | ===== Change Actor Nickname ===== | ||
| + | //Player status: Supported// ✅ | ||
| + | |||
| + | The **Change Actor Nickname** command allows to change the nickname of an actor. | ||
| + | |||
| + | The Maniac Patch supports the use of a variable or variable redirection for the ID of the actor, as well as using a string variable or string variable redirection for the name. | ||
| + | |||
| + | The common TPC syntax is < | ||
| + | |||
| + | Raw writing: < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| ===== Change Actor Graphic ===== | ===== Change Actor Graphic ===== | ||
| + | |||
| + | FIXME | ||
| ===== Change Actor Faceset ===== | ===== Change Actor Faceset ===== | ||
| + | |||
| + | FIXME | ||
| ===== Change System BGM ===== | ===== Change System BGM ===== | ||
| + | |||
| + | FIXME | ||
| ===== Change System SE ===== | ===== Change System SE ===== | ||
| + | |||
| + | FIXME | ||
| ===== Change System Graphic ===== | ===== Change System Graphic ===== | ||
| + | //Player status: Supported// ✅ | ||
| + | |||
| + | The **Change System Graphic** command allows to change the system graphic. | ||
| + | |||
| + | The Maniac Patch supports the use of a string variable or string variable redirection for the name of the system graphic. | ||
| + | |||
| + | Common TPC syntax: < | ||
| + | |||
| + | Where: | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | |||
| + | Raw writing: < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| ===== Battle Processing ===== | ===== Battle Processing ===== | ||
| + | |||
| + | FIXME | ||
| ===== Shop Processing ===== | ===== Shop Processing ===== | ||
| - | ⚠️// This option is not directly accessible through the Maniac editor, and requires using TPC, raw writing or another tool.// | + | ⚠️ //This option is not directly accessible through the Maniac editor, and requires using TPC, raw writing or another tool.// |
| + | |||
| + | FIXME | ||
| ===== Name Input Processing ===== | ===== Name Input Processing ===== | ||
| - | ⚠️// This option was added in development versions of the editor, and is as such not available in public versions, in addition to lacking a common TPC writing.// | + | //Player status: Unsupported// |
| + | |||
| + | The **Name Input Processing** command allows to open the name input screen to rename a hero. | ||
| + | |||
| + | The Maniac Patch adds the possibility to use a variable or variable redirection for the ID of the actor. ⚠️ //This option is not directly accessible through the Maniac editor in the public version, and requires using TPC, raw writing or another tool.// | ||
| + | |||
| + | The development version adds the following field: | ||
| + | * Character limit: How many characters can be typed for the name, with the possibility to either use a constant, variable or variable redirection. | ||
| + | |||
| + | Additionally, | ||
| + | |||
| + | Notes: | ||
| + | * The character limit is capped on the [1;30] range. | ||
| + | * Having the character limit set to 0 will use the default character limit (12 in English RPG Maker 2003). | ||
| + | |||
| + | TPC syntax: < | ||
| + | |||
| + | Where: | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | Raw writing: < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| ===== Set Vehicle Location ===== | ===== Set Vehicle Location ===== | ||
| - | ⚠️// This option is not directly accessible through the Maniac editor, and requires using TPC, raw writing or another tool.// | + | ⚠️ //This option is not directly accessible through the Maniac editor, and requires using TPC, raw writing or another tool.// |
| + | |||
| + | //Player status: Unsupported// | ||
| + | |||
| + | The **Set Vehicle Location** command allows to teleport a vehicle. | ||
| + | |||
| + | The Maniac Patch allows specifying a direction that the vehicle should face after teleportation. | ||
| + | |||
| + | Common TPC syntax: < | ||
| + | |||
| + | Where: | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | |||
| + | Notes: | ||
| + | * It is possible to teleport the player through this command: doing so will not display any transition nor clear any picture if the map changes. | ||
| + | * Specifying a negative direction or a direction higher than 4 will keep the current direction. | ||
| + | |||
| + | Raw writing: < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| ===== Set Event Location ===== | ===== Set Event Location ===== | ||
| + | |||
| + | ⚠️ //Those options are only accessible through the Maniac editor in development versions, but the displayed interface incorrectly displays that the Direction can be set as a variable or variable redirection which is false, and the parameter for the Event ID on the interface is actually the one displayed for the Direction. Those options can be used on public versions, but require using TPC, raw writing or another tool.// | ||
| + | |||
| + | //Player status: Supported// ✅ | ||
| + | |||
| + | The **Set Event Location** command allows to teleport an event. | ||
| + | |||
| + | The Maniac Patch allows to specify a variable or variable redirection for the event ID, and allows specifying a direction that the event should face after teleportation. | ||
| + | |||
| + | Common TPC syntax: < | ||
| + | |||
| + | Where: | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | |||
| + | Notes: | ||
| + | * The instance This Event can be specified by specifying the ID 10005, but the Player and the vehicles (IDs 10001~10004) cannot be targeted using the command. | ||
| + | * Specifying a negative direction or a direction higher than 4 will keep the current direction. | ||
| + | |||
| + | Raw writing: < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| ===== Swap Event Location ===== | ===== Swap Event Location ===== | ||
| + | |||
| + | //Player status: Supported// ✅ | ||
| + | |||
| + | The **Swap Event Location** command allows to swap the position of an event with another. | ||
| + | |||
| + | The Maniac Patch supports the use of a variable or variable redirection for the events in place of using constants. | ||
| + | |||
| + | Notes: | ||
| + | * This command does not allow swapping the player (ID 10001), vehicles (IDs 10002~10004) and the instance This Event (ID 10005). | ||
| + | * Attempting to swap an event that does not exist will display an error and make the program close. | ||
| + | |||
| + | The common TPC syntax is < | ||
| + | |||
| + | Raw writing: < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| ===== Hide Screen ===== | ===== Hide Screen ===== | ||
| - | ⚠️// This option is not directly accessible through the Maniac editor, and requires using TPC, raw writing or another tool.// | + | ⚠️ //This option is not directly accessible through the Maniac editor, and requires using TPC, raw writing or another tool.// |
| + | |||
| + | //Player status: Unsupported// | ||
| + | |||
| + | The **Hide Screen** command allows to hide the screen. | ||
| + | |||
| + | The Maniac Patch supports the use of a variable or variable redirection for the transition value in addition to using a constant. | ||
| + | |||
| + | The following values determine the transition to use: | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | |||
| + | Notes: | ||
| + | * For positive values, the transition values are internally processed on 8 bits, so a value above 255 will loop back to the value 0. | ||
| + | |||
| + | The common TPC syntax is < | ||
| + | |||
| + | Raw writing: < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| ===== Show Screen ===== | ===== Show Screen ===== | ||
| - | ⚠️// This option is not directly accessible through the Maniac editor, and requires using TPC, raw writing or another tool.// | + | ⚠️ //This option is not directly accessible through the Maniac editor, and requires using TPC, raw writing or another tool.// |
| + | |||
| + | //Player status: Unsupported// | ||
| + | |||
| + | The **Show Screen** command allows to show the screen. | ||
| + | |||
| + | The Maniac Patch supports the use of a variable or variable redirection for the transition value in addition to using a constant. | ||
| + | |||
| + | The following values determine the transition to use: | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | |||
| + | Notes: | ||
| + | * For positive values, the transition values are internally processed on 8 bits, so a value above 255 will loop back to the value 0. | ||
| + | |||
| + | The common TPC syntax is < | ||
| + | |||
| + | Raw writing: < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| ===== Flash Event ===== | ===== Flash Event ===== | ||
| - | ⚠️// This option is not directly accessible through the Maniac editor, and requires using TPC, raw writing or another tool.// | + | ⚠️ //This option is not directly accessible through the Maniac editor, and requires using TPC, raw writing or another tool.// |
| + | |||
| + | FIXME | ||
| ===== Scroll Map ===== | ===== Scroll Map ===== | ||
| Line 67: | Line 352: | ||
| ==== Fix ==== | ==== Fix ==== | ||
| - | //Player status: Stronger Fixing not supported //❌ | + | //Player status: Stronger Fixing not supported// ❌ |
| **Fix** allows to fix the camera position. | **Fix** allows to fix the camera position. | ||
| - | The patch adds the parameter **Stronger Fixing**: if ticked and that a player teleportation occurs on the current map, the camera will stay still instead of moving. ⚠️// This option was added in development versions of the editor, and is as such not available in public versions, in addition to lacking a common TPC writing.// | + | The patch adds the parameter **Stronger Fixing**: if ticked and that a player teleportation occurs on the current map, the camera will stay still instead of moving. ⚠️ //This option was added in development versions of the editor, and is as such not available in public versions, in addition to lacking a common TPC writing.// |
| Common TPC writing of the default fix command: < | Common TPC writing of the default fix command: < | ||
| Line 91: | Line 376: | ||
| ==== Shift Position (Tile) ==== | ==== Shift Position (Tile) ==== | ||
| - | //Player status: Instant speed not supported //❌ | + | //Player status: Instant speed not supported// ❌ |
| **Shift Position (Tile)** (known as Shift Position in the original engine) allows to move the camera by a set amount of tiles. | **Shift Position (Tile)** (known as Shift Position in the original engine) allows to move the camera by a set amount of tiles. | ||
| Line 134: | Line 419: | ||
| ==== Return to Origin ==== | ==== Return to Origin ==== | ||
| - | //Player status: Instant speed not supported //❌ | + | //Player status: Instant speed not supported// ❌ |
| **Return to Origin** makes the camera returns to its original position. | **Return to Origin** makes the camera returns to its original position. | ||
| Line 171: | Line 456: | ||
| ==== Shift Position (Pixel) ==== | ==== Shift Position (Pixel) ==== | ||
| - | //Player status: Partially supported //ℹ️//; Game can crash if a movement of less than 3 pixels on both axises is done, negative wait does not give the same result than a null wait, see EasyRPG Player issues [[https:// | + | //Player status: Partially supported// ℹ️//; Game can crash if a movement of less than 3 pixels on both axises is done, negative wait does not give the same result than a null wait, see EasyRPG Player issues [[https:// |
| **Shift Position (Pixel)** is a new function of the patch, and allows moving the camera by a set amount of pixels. | **Shift Position (Pixel)** is a new function of the patch, and allows moving the camera by a set amount of pixels. | ||
| Line 182: | Line 467: | ||
| * Amount of movement per frame: The camera movement will be done in X * 0.001 pixel per frame, where X corresponds to the Speed value. | * Amount of movement per frame: The camera movement will be done in X * 0.001 pixel per frame, where X corresponds to the Speed value. | ||
| * Movement frame: The camera movement will be done in X frames, where X corresponds to the Speed value. | * Movement frame: The camera movement will be done in X frames, where X corresponds to the Speed value. | ||
| - | * Wait for Completion: If set, the game will wait that the camera finishes moving before processing the rest of the code of the event. ⚠️// While this option is shown and can be ticked in the Maniac editor, it is incorrectly assigned and the parameter will be removed if altered through the editor. Use TPC, raw writing or another tool to assign this parameter.// | + | * Wait for Completion: If set, the game will wait that the camera finishes moving before processing the rest of the code of the event. ⚠️ //While this option is shown and can be ticked in the Maniac editor, it is incorrectly assigned and the parameter will be removed if altered through the editor. Use TPC, raw writing or another tool to assign this parameter.// |
| TPC syntax: < | TPC syntax: < | ||
| Line 196: | Line 481: | ||
| * '' | * '' | ||
| * '' | * '' | ||
| - | * '' | + | * '' |
| * '' | * '' | ||
| * '' | * '' | ||
| Line 210: | Line 495: | ||
| ==== Set Position (Pixel) ==== | ==== Set Position (Pixel) ==== | ||
| - | //Player status: Partially supported //ℹ️//; Game can crash if a movement of less than 3 pixels on both axises is done, negative wait does not give the same result than a null wait, Based on Center and overal camera position can not be accurate, see EasyRPG Player issues [[https:// | + | //Player status: Partially supported// ℹ️//; Game can crash if a movement of less than 3 pixels on both axises is done, negative wait does not give the same result than a null wait, Based on Center and overal camera position can not be accurate, see EasyRPG Player issues [[https:// |
| **Set Position (Pixel)** is a new function of the patch, and allows defining the position of the camera in pixels. | **Set Position (Pixel)** is a new function of the patch, and allows defining the position of the camera in pixels. | ||
| Line 221: | Line 506: | ||
| * Amount of movement per frame: The camera movement will be done in X * 0.001 pixel per frame, where X corresponds to the Speed value. | * Amount of movement per frame: The camera movement will be done in X * 0.001 pixel per frame, where X corresponds to the Speed value. | ||
| * Movement frame: The camera movement will be done in X frames, where X corresponds to the Speed value. | * Movement frame: The camera movement will be done in X frames, where X corresponds to the Speed value. | ||
| - | * Wait for Completion: If set, the game will wait that the camera finishes moving before processing the rest of the code of the event. ⚠️// While this option is shown and can be ticked in the Maniac editor, it is instead assigned to the Based on Center parameter. Use TPC, raw writing or another tool to assign this parameter.// | + | * Wait for Completion: If set, the game will wait that the camera finishes moving before processing the rest of the code of the event. ⚠️ //While this option is shown and can be ticked in the Maniac editor, it is instead assigned to the Based on Center parameter. Use TPC, raw writing or another tool to assign this parameter.// |
| - | * Based on Center: If set, the top-left corner of the map for the camera will no longer be considered to be 0, 0: this will instead be the case for the center of the screen (160, 120 with the default [[..: | + | * Based on Center: If set, the top-left corner of the map for the camera will no longer be considered to be 0, 0: this will instead be the case for the center of the screen (160, 120 with the default [[..: |
| - | * Relative Position: If set, the coordinates specified will be calculated depending on the current camera position. ⚠️// The option that needs to be ticked in the Maniac editor to assign this parameter is Based on Center.// | + | * Relative Position: If set, the coordinates specified will be calculated depending on the current camera position. ⚠️ //The option that needs to be ticked in the Maniac editor to assign this parameter is Based on Center.// |
| TPC syntax: < | TPC syntax: < | ||
| Line 239: | Line 524: | ||
| * '' | * '' | ||
| * '' | * '' | ||
| - | * '' | + | * '' |
| * '' | * '' | ||
| * '' | * '' | ||
| Line 255: | Line 540: | ||
| ===== Show Picture ===== | ===== Show Picture ===== | ||
| + | |||
| + | FIXME | ||
| ===== Move Picture ===== | ===== Move Picture ===== | ||
| + | |||
| + | FIXME | ||
| ===== Erase Picture ===== | ===== Erase Picture ===== | ||
| - | //Player status: Supported //✅//; Erasing pictures in batch with the first value bigger than the second value does not work, see [[https:// | + | //Player status: Supported// ✅//; Erasing pictures in batch with the first value bigger than the second value does not work, see [[https:// |
| The original Erase Picture command in RPG Maker 2000 only allowed to erase one picture at a time by specifying its ID, which was expanded in the English release of RPG Maker 2003 by adding batch erase and erase with a variable ID. | The original Erase Picture command in RPG Maker 2000 only allowed to erase one picture at a time by specifying its ID, which was expanded in the English release of RPG Maker 2003 by adding batch erase and erase with a variable ID. | ||
| Line 280: | Line 569: | ||
| ===== Show Animation ===== | ===== Show Animation ===== | ||
| + | |||
| + | FIXME | ||
| ===== Wait ===== | ===== Wait ===== | ||
| - | //Player status: Supported //✅ | + | //Player status: Supported// ✅ |
| The original Wait command in RPG Maker 2000 only allowed to erase wait by specifying a tenth of a second, and was later expanded with the possibility to wait for a key press. | The original Wait command in RPG Maker 2000 only allowed to erase wait by specifying a tenth of a second, and was later expanded with the possibility to wait for a key press. | ||
| Line 301: | Line 592: | ||
| ===== Play BGM ===== | ===== Play BGM ===== | ||
| + | //Player status: Supported// ✅ | ||
| + | |||
| + | The **Play BGM** command allows to play a music. | ||
| + | |||
| + | The Maniac Patch supports the use of variables and variable redirections for the fadein time, tempo, balance and volume, as well as using a string variable or string variable redirection for the music name. | ||
| + | |||
| + | Notes: | ||
| + | * Internally, the unit used for the Fadein Time by the command is milliseconds, | ||
| + | |||
| + | TPC syntax: < | ||
| + | |||
| + | Where: | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | |||
| + | Raw writing: < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| ===== Fadeout BGM ===== | ===== Fadeout BGM ===== | ||
| - | ⚠️// This option is not directly accessible through the Maniac editor, and requires using TPC, raw writing or another tool.// | + | ⚠️ //This option is not directly accessible through the Maniac editor, and requires using TPC, raw writing or another tool.// |
| - | //Player status: Unsupported //❌ | + | //Player status: Unsupported// |
| The **Fadeout BGM** command allows to fadeout the music. | The **Fadeout BGM** command allows to fadeout the music. | ||
| Line 322: | Line 650: | ||
| ===== Play SE ===== | ===== Play SE ===== | ||
| + | //Player status: Supported// ✅ | ||
| + | |||
| + | The **Play SE** command allows to play a sound effect. | ||
| + | |||
| + | The Maniac Patch supports the use of variables and variable redirections for the tempo, balance and volume, as well as using a string variable or string variable redirection for the sound name. | ||
| + | |||
| + | TPC syntax: < | ||
| + | |||
| + | Where: | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | |||
| + | Raw writing: < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| ===== Key Input Processing ===== | ===== Key Input Processing ===== | ||
| + | |||
| + | //Player status: Supported// ✅//; Wheel Mouse Up and Wheel Mouse Down are not properly tracked if the command is formatted like a RPG Maker 2000 command.// | ||
| + | |||
| + | The **Key Input Processing** command allows to track pressed keys. | ||
| + | |||
| + | In the Maniac Patch, the following buttons can be tracked, and will give the following values: | ||
| + | * **Mouse wheel down**: 1001 | ||
| + | * **Mouse wheel up**: 1004 | ||
| + | * **Left mouse button**: 1005 | ||
| + | * **Right mouse button**: 1006 | ||
| + | * **Middle mouse button**: 1007 | ||
| + | |||
| + | Common TPC writing: < | ||
| + | .decision | ||
| + | .cancel | ||
| + | .shift | ||
| + | .down | ||
| + | .left | ||
| + | .right | ||
| + | .up | ||
| + | .number | ||
| + | .symbol | ||
| + | .lclick | ||
| + | .rclick | ||
| + | .mclick | ||
| + | .wheelDown | ||
| + | .wheelUp | ||
| + | }</ | ||
| + | |||
| + | Where: | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | |||
| + | Raw writing (format used by RPG Maker 2000; also used by RPG Maker 2003 if the command has 10 numeric arguments or less): < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | |||
| + | Raw writing (RPG Maker 2003): < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| ===== Change Tileset ===== | ===== Change Tileset ===== | ||
| - | //Player status: Supported //✅ | + | //Player status: Supported// ✅ |
| The **Change Tileset** command allows to change the tileset used on the current map. | The **Change Tileset** command allows to change the tileset used on the current map. | ||
| Line 338: | Line 780: | ||
| * '' | * '' | ||
| * '' | * '' | ||
| + | |||
| ===== Change Parallax Background ===== | ===== Change Parallax Background ===== | ||
| + | |||
| + | FIXME | ||
| ===== Call System Functions (Open Save Menu) ===== | ===== Call System Functions (Open Save Menu) ===== | ||
| - | ⚠️// The functions of this command are not directly accessible through the Maniac editor, and require using the community plugin, TPC, raw writing or another tool.// | + | ⚠️ //The functions of this command are not directly accessible through the Maniac editor, and require using the community plugin, TPC, raw writing or another tool.// |
| - | //Player status: Partial support //ℹ️//; Window mode only does toggle and also opens the save menu, settings menu softlocks the game by infinitely opening the save menu, license menu is not supported; as the debug menu is opened on the window of the game, whether it should be paused or not does not matter// | + | //Player status: Partial support// ℹ️//; Window mode only does toggle and also opens the save menu, settings menu softlocks the game by infinitely opening the save menu, license menu is not supported; as the debug menu is opened on the window of the game, whether it should be paused or not does not matter// |
| In the Maniac patch, the Open Save Menu command was reworked to also allow opening other menus, and was renamed to Call System Functions. | In the Maniac patch, the Open Save Menu command was reworked to also allow opening other menus, and was renamed to Call System Functions. | ||
| Line 382: | Line 827: | ||
| ===== Control System Functions (Change Save Access) ===== | ===== Control System Functions (Change Save Access) ===== | ||
| - | ⚠️// The functions of this command are not directly accessible through the Maniac editor, and require using the community plugin, TPC, raw writing or another tool.// | + | ⚠️ //The functions of this command are not directly accessible through the Maniac editor, and require using the community plugin, TPC, raw writing or another tool.// |
| - | //Player status: Unsupported //❌ | + | //Player status: Unsupported// |
| In the Maniac patch, the Change Save Access command was reworked to also allow controlling other menus, and was renamed to Call System Functions. | In the Maniac patch, the Change Save Access command was reworked to also allow controlling other menus, and was renamed to Call System Functions. | ||
| Line 421: | Line 866: | ||
| ===== Conditional Branch ===== | ===== Conditional Branch ===== | ||
| + | |||
| + | FIXME //Document the other features of this command.// | ||
| + | |||
| + | ==== Right after loading state ==== | ||
| + | |||
| + | //Player status: Partial support// ℹ️// | ||
| + | |||
| + | **Right after loading state** (also known as Right after load) can be used to detect if the game just started, either as a new game or as part of a save loading. | ||
| + | |||
| + | If the conditional branch is used under one of the following conditions and that it is used during the first frame of said instance, the conditional branch will be considered as true: | ||
| + | * Start of a new game (whether the title is skipped or not) | ||
| + | * Save file loaded from the title screen menu | ||
| + | * Save file loaded from the Load command | ||
| + | |||
| + | All other instances will be considered to be false. | ||
| + | |||
| + | Notes: | ||
| + | * Loading a save file from the Open Load Menu or Call System Functions: Load Menu command will consider Right after loading state to be false on Maniac. | ||
| + | |||
| + | TPC syntax ('' | ||
| + | | ||
| + | } .else bl { | ||
| + | | ||
| + | }</ | ||
| + | |||
| + | Raw writing (only Conditional Branch header): < | ||
| + | * '' | ||
| + | * '' | ||
| + | |||
| + | ==== Joypad is enabled ==== | ||
| + | |||
| + | //Player status: No proper support, always considered to be true// ℹ️ | ||
| + | |||
| + | **Joypad is enabled** (also known as Enable Joypad) can be used to detect if a controller is connected. | ||
| + | |||
| + | If a controller is connected, it will be reported as true, otherwise it will be reported as false. | ||
| + | |||
| + | TPC syntax ('' | ||
| + | | ||
| + | } .else bl { | ||
| + | | ||
| + | }</ | ||
| + | |||
| + | Raw writing (only Conditional Branch header): < | ||
| + | * '' | ||
| + | * '' | ||
| + | |||
| + | ==== Window is active ==== | ||
| + | |||
| + | //Player status: No proper support, always considered to be true// ℹ️ | ||
| + | |||
| + | **Window is active** can be used to detect if the window of the game is currently active. | ||
| + | |||
| + | This command is expected to be combined with [[new-maniac-commands# | ||
| + | |||
| + | If the behavior of the game window when inactive is set to keep running and that the window of the game is put in the background, it will be reported as false. Otherwise, it will be reported as true. | ||
| + | |||
| + | TPC syntax ('' | ||
| + | | ||
| + | } .else bl { | ||
| + | | ||
| + | }</ | ||
| + | |||
| + | Raw writing (only Conditional Branch header): < | ||
| + | * '' | ||
| + | * '' | ||
| + | |||
| + | ==== File output is available ==== | ||
| + | |||
| + | //Player status: No proper support, always considered to be true// ℹ️ | ||
| + | |||
| + | **File output is available** (also known as Can output file) can be used to know if the Maniac Patch is currently able to write files. | ||
| + | |||
| + | When using the commands Save, Control Global Save, Control String Variables and Output Picture, the Maniac Patch is able to write files in the game directory of the game: as to avoid problems with games writing too many files at once causing issues with the user machine, there is a limit of around 3 files write per second. If more file writing are attempted to be done during the same second, they will all fail. | ||
| + | |||
| + | The conditional branch as such informs you of this state: if you have met the file writing limit, the conditional branch will be reported as false; otherwise it will be reported as true. | ||
| + | |||
| + | TPC syntax ('' | ||
| + | | ||
| + | } .else bl { | ||
| + | | ||
| + | }</ | ||
| + | |||
| + | Raw writing (only Conditional Branch header): < | ||
| + | * '' | ||
| + | * '' | ||
| ===== Loop ===== | ===== Loop ===== | ||
| + | |||
| + | FIXME | ||
| ===== Break Loop ===== | ===== Break Loop ===== | ||
| + | |||
| + | FIXME | ||
| ===== End Event Processing ===== | ===== End Event Processing ===== | ||
| - | ⚠️// The options of this command were added in development versions of the editor, and are as such not available in public versions, in addition to lacking common TPC writings.// | + | ⚠️ //The options of this command were added in development versions of the editor, and are as such not available in public versions, in addition to lacking common TPC writings.// |
| + | |||
| + | FIXME | ||
| ===== Erase Event ===== | ===== Erase Event ===== | ||
| + | |||
| + | //Player status: Partial support// ℹ️//; specifying the event ID 10005 does not work; No warning is displayed when selecting an invalid event ID.// | ||
| + | |||
| + | The **Erase Event** command allows to erase an event. | ||
| + | |||
| + | In the Maniac Patch, it is now possible to specify another event ID to erase, as well as using a variable or variable redirection for the event ID to use. Additionally, | ||
| + | |||
| + | Notes: | ||
| + | * The instance This Event can be specified either by using the value 0 or 10005. | ||
| + | * The Player and the vehicles cannot be altered by this command. | ||
| + | * Specifying an event ID that does not exist displays an error and forces the game to close. | ||
| + | * Erasing an event already erased or making an event already present return has no effect. | ||
| + | |||
| + | TPC syntax: < | ||
| + | |||
| + | Where: | ||
| + | * '' | ||
| + | * '' | ||
| + | |||
| + | Raw writing: < | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| + | * '' | ||
| ===== Call Event ===== | ===== Call Event ===== | ||
| + | |||
| + | FIXME | ||
| ===== Change Enemy HP ===== | ===== Change Enemy HP ===== | ||
| + | |||
| + | FIXME | ||
| ===== Change Enemy MP ===== | ===== Change Enemy MP ===== | ||
| + | |||
| + | FIXME | ||
| ===== Change Enemy State ===== | ===== Change Enemy State ===== | ||
| + | |||
| + | FIXME | ||
| ===== Enemy Encounter ===== | ===== Enemy Encounter ===== | ||
| + | |||
| + | FIXME | ||
| ===== Change Battleback ===== | ===== Change Battleback ===== | ||
| + | |||
| + | FIXME | ||
| ===== Show Animation (Battle) ===== | ===== Show Animation (Battle) ===== | ||
| + | |||
| + | FIXME | ||
| ===== Action Times + ===== | ===== Action Times + ===== | ||
| + | |||
| + | FIXME | ||
| ===== Force Escape ===== | ===== Force Escape ===== | ||
| + | |||
| + | FIXME | ||
| ===== Conditional Branch (Battle) ===== | ===== Conditional Branch (Battle) ===== | ||
| + | |||
| + | FIXME | ||
development/technical-details/patches/maniac/modified-maniac-commands.1790858161.txt.gz · Last modified: by carbonara