Documentation
Quick InfoVersion: Beta R7
Made for RPG Maker MZ 1.9.0
The BasicsTo make a light effect appear on an event, use a comment somewhere in the event page that says:
CGMZ LE id
For example, if your light effect had an id of "fire" you would do: CGMZ LE fire
To turn off a light, you can turn off all lights globally or all lights of a specific id with plugin commands. To turn off a light individually, you can change event pages to one without the comment.
Plugin CommandsThis plugin supports the following plugin commands:
Disable Light - Disables/enables light effects by id
Set Player Light - Sets a light effect on the player by id
Clear Player Light - Clears the light effect from the player
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_LightEffects.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 BetaR2
- Added lights that can target the player
- Added breathe effect options for lights
- This plugin now warns instead of crashes upon detecting invalid JSON
- Added Z offset to lights
- Fixed an issue preventing negative light x/y offsets
- Added blend mode option to lights
- Fixed a bug that could cause the player to appear above trees
- Added proximity-based lights
- Added directional lights
- Added rotating lights
- Added switch to control global light visibility
- Removed Change Visibility Plugin Command