Documentation
Quick InfoVersion: Alpha R3
Made for RPG Maker MZ 1.9.0
NotetagsThis plugin supports automatic application of tints to the game screen based on the time of day. This only works on maps that have the following meta tag somewhere in the map properties notebox:
<cgmzDNStintable>
Time TrackingThis plugin tracks time in frames automatically when the player is on the map scene. This plugin separately tracks "added" time which is time you add or set via plugin commands.
The plugin only stores frames. Time units are calculated when necessary based off number of frames elapsed. For this reason, time units are not saved so you can change the time unit parameters and have them work in saved games.
Time UnitsThe time unit parameter is used to create completely fictional units of time, or to recreate the seconds/minutes/hours/days that the real world uses.
The order you create units of time is important! The first will be the most basic unit of time (e.g. second), the next will be the second most basic unit of time (e.g. minute), and so on. The last unit of time will count up infinitely.
The most basic unit of time uses frames as a measurement for the parameter "Num Previous Units". For example, if you want to make seconds, you would make it first in the list and then set Num Previous Units to 60 (60f = 1s).
Plugin CommandsThis plugin supports the following plugin commands:
Add Time - Can add (or subtract if param is negative) time in frames from the current time.
Set Time - Will set the time to a specific frame within a "day" (maximum time unit)
Get Time - Will set a variable to be equal to the current frame of the "day" (maximum time unit)
Stop Time - Will enable/disable time tracking. Tints will still apply even if time is frozen. This just enables/disables the progression of the time.
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_DayNightSystem.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 AlphaR2
- Added a way to track the total amount of in game days
- Added option to run a common event when the day counter increases
- This plugin now warns instead of crashes when JSON params are invalid
- Added option to track time on the map screen
- Added option to track time while in battle
- Added option to track time while in menus
- Fix crash when trying to do an event test