Documentation
Quick InfoVersion: Alpha R10
Made for RPG Maker MZ 1.9.0
The BasicsYou can have multiple different tools of the same type if desired. This might make it so you can have fire arrows which interact with ice events but not fire events, and ice arrows that interact with fire events but not ice events.
ToolsReset tool: This tool will "reset" the current map the player is in. It accomplishes this by 1) saving the coordinates the player entered the map and teleporting them to those coordinates when the tool is used, and 2) manipulating the self-switches of events set up to interact with the tool.
Arrow tool: This tool will shoot an arrow in the direction the player is currently facing which will travel for the configurable range number of tiles, or until it collides with either an impassable part of the map or an event. If it collides with an event, it will check and see if that event is interactable with the arrow, and if so, it will manipulate the self-switches of that event. It can move through otherwise impassable map tiles if they are painted with the passable region ID.
Bomb tool: This tool will set a bomb down at the player's current location which will explode after a certain amount of steps taken by the player. Events nearby that are hit by the explosion will be checked to determine if any of their self-switches should be manipulated.
Boomerang tool: This tool will shoot a boomerang in the direction the player is currently facing which will travel for the configurable range number of tiles, or until it collides with either an impassable part of the map or an event where it will then return to the player. It can move through otherwise impassable map tiles if they are painted with the passable region ID. When passing over an event, it will check if the event can be "picked up" by the boomerang as well as if the event should have its self-switches manipulated by the boomerang. The boomerang can pick up an unlimited number of events. Since the boomerang returns to the player, the player cannot move while this tool is active.
Hookshot tool: This tool will shoot a hookshot in the direction the player is currently facing, which will travel for the configurable range number of tiles, or until it collides with an impassable part of the map or an event. If the event it collides with is tagged as interactable with the hookshot tag, it will pull the player to the event rather than returning to the player. Since the hookshot returns to the player (or pulls the player to the hookshot), the player cannot move while this tool is active.
Interact tool: This tool will simply interact with the event(s) in front of the player. Something like a pickaxe or axe to cut through a stone or tree that might be blocking the player's path.
Lantern tool: This tool will show a [CGMZ] Light Effect around the player. When the player moves near an event that interacts with this tool, it will have its self switches turned ON. When the player moves away, the self switches will turn back off. You can use this to create hidden events, hidden floors over pits, and many other uses.
Tagging EventsEvents are tagged with a comment event command somewhere on the event page. Only the active event page will be considered.
To tag an event for self-switch manipulation by a tool or as interactable with the hookshot, use the following: CGMZDT [symbol]
For example, if you wanted something to interact with your bomb tool, and you set the bomb tool to have the symbol "mybomb", you would comment: CGMZDT mybomb
The boomerang tool has a special comment for "pickup" in the format of: CGMZDT PICKUP [item|weapon|armor|gold] [amount] [id]
For example, if you wanted the pickup to be a 2x weapons of ID 5, you'd do: CGMZDT PICKUP weapon 2 5
Gold pickups can omit the id, so if you wanted the pickup to be 500G, do: CGMZDT PICKUP gold 500
You can also change the post-pickup text in the boomerang pickup comment You do this by typing your custom message after the id of a pickup. Please note that even though gold pickups do not need to have an id, you must type an id that will not be used if you wish to use a custom message.
For example, a gold pickup with a custom message would be: CGMZDT PICKUP gold 500 x You received 500 gold!
The weapon example from before with a custom message would be: CGMZDT PICKUP weapon 2 5 You received 2 of the weapon with id 5!
Text codes will work in custom boomerang messages.
Comments are CASE-SENSITIVE. Example of incorrect comment: CGMZdt pickup GOLD 500
Resource SpecificationsThe images used for the tool sprites will be 4x pixels high (if using tools which are 48 pixels tall, make the height 48x4 = 192px). Each row will be one direction, which follows the same pattern as normal character sprites.
You can specify the frame-width of each column. If you want 10 frames of animation at 48px wide each, you would make 48x10 = 480px wide. Tools can use an unlimited* amount of frames. The frame width can be unique per tool.
* unlimited in this case means the plugin does not add any limit. There are WebGL limitations to how large a single PIXI Sprite can be, which is usually 16384px on computer but could be as small as 4096px on some mobile devices.
The bomb tool uses 1 row of graphics since the bomb tool does not have a direction, so if you wanted your bomb tool to be 48px tall, you'd make the sprite sheet height 48px.
Integrations[CGMZ] Light Effects
When using a Lantern Tool, you can optionally provide a CGMZ Light Effect ID to show around the player.
[CGMZ] Event Movement
If you have events that move using [CGMZ] Event Movement, for example on map enemies, you can set up certain tools to stun these events when a tool makes contact with them. Tools that have this feature are the arrow, boomerang, and hookshot.
[CGMZ] Scene Backgrounds
Customize the scene background for the tool select scene via this plugin. You will set up your scene background options in Scene Backgrounds, and then type the background id in to Dungeon Tools to use this integration.
[CGMZ] Window Backgrounds
Use this plugin to show a custom background image in the tool select scene windows. You can optionally make this image a parallax that scrolls.
[CGMZ] Window Settings
Allows you to change windowskin, window tone, style, and more for every window in your game including the tool select scene windows.
[CGMZ] Controls Window
Show a window that tells the player the controls in the tool select scene, either keyboard or gamepad depending on their last input. Set up the window in Controls Window, and then type the id into the integration parameter in Dungeon Tools.
Plugin CommandsThis plugin supports the following plugin commands:
Call Scene - Forcibly calls the select tool scene
Discover Tool - Discovers the tool for use on the select tool scene
Remove Tool - Removes/undiscovers the tool from the select tool scene
Equip Tool - Forces a tool to be equipped
Use Tool - Tries to use the currently equipped tool
Change Tool Enable - Enable/Disable a specific tool from being used
Modify Reset - Allows you to change a reset tool's properties
Modify Arrow - Allows you to change an arrow tool's properties
Modify Bomb - Allows you to change a bomb tool's properties
Modify Boomerang - Allows you to change a boomerang tool's properties
Modify Hookshot - Allows you to change a hookshot tool's properties
Modify Interact - Allows you to change an interact tool's properties
Modify Lantern - Allows you to change a lantern tool's properties
Saved GamesThis plugin is partially compatible with saved games. This means you can:
✓ Add this plugin to a saved game and it will work as expected.
✘ Modifying plugin parameters is not fully supported. The following will not work correctly in previously saved games: You can only modify existing tools using plugin commands in saved games.
✓ Remove the plugin with no issue to save data.
Filename
The filename for this plugin MUST remain CGMZ_DungeonTools.js. This is what it comes as when downloaded. The filename is used to load parameters and execute plugin commands. If you change it, things will begin behaving incorrectly and your game will probably crash. Please do not rename the js file.
Known Issues
This plugin currently has no known issues that need to be fixed. If you believe you have encountered a bug, please report it to Casper Gaming.
Compatibility
This plugin currently has no known compatibility issues with other RMMZ plugins. If you believe you have encountered a conflict, please report it to Casper Gaming.
Version HistoryVersion AlphaR3
- Gamepad parameters now select the button instead of number entry
- Fixed bug that could cause the player to appear above trees
- Added options to customize tool window padding, windowskin, opacity, tone
- Fixed bug with hookshot connection failing due to 4dir passage settings
- Standardized SE parameters
- Added new Lantern Tool
- Added option to require an item in inventory to use a tool
- Added option to consume an item when a tool is used
- Added plugin command to use the current equipped tool
- Added option to stun events with arrow, hookshot, boomerang tools
- Added parameter to change max visible tool select window line count
- Tool icon parameter now uses plugin icon select UI
- Added [CGMZ] Controls Window integration for the tool select scene
- Scene Background now uses [CGMZ] Scene Backgrounds preset
- Fixed bug that could cause a crash when using a tool next to a wall
- Added rope sprite for hookshot
- Added [CGMZ] Rumble integration
- Added [CGMZ] Window Backgrounds integration
- Converted Transparent Windows param to selectable for each type
- Convert deprecated CGMZ Temp calls to CGMZ Utils calls
- Added jump to hookshot option
- Hookshot now goes slightly further when connecting to something
- Added option to set gamepad buttons to -1 to not use
- Fix boomerang not being through on way back
- Change Tool Access plugin command converted to game switch
- Added [CGMZ] Window Settings integration
- Hookshot follower gather now gather at the player's hookshot speed
- Hookshot now drawn behind player when not facing down
- Hookshot no longer goes past connection point if speed is set really high
- Added Collide Sound Effect for arrow, boomerang, hookshot
- Fix bug with lantern tool not properly unequipping