Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin


Quick InfoVersion: Alpha
Made for RPG Maker MZ 1.10.0
REQUIRED: All [CGMZ] Plugins require [CGMZ] Core placed above them in the Plugin Manager.

Quick Start GuideTo get started using this plugin, follow the below steps:

1) Set up your objectives in the Objective Setup parameters

2) Set up the Result Switch to know if the player met the battle objective

3) Use Plugin Commands to set the battle objective as needed

4) The plugin handles the rest

Random BattlesIf you would like to have objectives appear during random battles to give the player something else to strive for besides just winning the battle, you can set up the Random Battle Mechanics section of the parameters.

First, you need to set the Randomly Select Objective Switch. This controls if objectives are selected for battles if not set up via the plugin command. If this switch is not set or OFF, battles will not randomly choose an objective. If this switch is set and ON, battles will choose a battle objective at random.

To refine which objectives are possible, you can set a Difficulty Rating for your objectives. Then, set the Min and Max variables for random objectives, and assign those variables to the min and max difficulty rating you want to be included as possible objectives.

Through these parameters, you can easily make separate objectives for random battles while keeping some for hard-coded events in your game. You can also slowly ramp up the difficulty of battle objectives over time.

Text CodesIn your objective description, you can use %current to show the current value the plugin is tracking for that objective type, and %max to show the maximum value the plugin is tracking.

IntegrationsThis plugin includes additional functionality when used alongside the following plugins:

[CGMZ] Window Backgrounds
Add a background image as your objective window background. Supports animated scrolling parallax images.

[CGMZ] Window Settings
Control the objective window settings including windowskin image, tone, padding, opacity, and more.

Plugin CommandsThis plugin supports the following plugin commands:

Clear Objective
Clears any active objective.

Set Objective
Set an objective for the next battle. Will override any random objectives that may be selected.


Saved GamesThis plugin is fully compatible with saved games. This means you can:

✓ Add this plugin to a saved game and it will work as expected.
✓ Change any plugin params and changes will be reflected in saved games.
✓ Remove the plugin with no issue to save data.

Filename

The filename for this plugin MUST remain CGMZ_BattleObjectives.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.

Back to Plugin