Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin

Terms of Use
Become a Patron
Discuss / Support
Quick InfoVersion: Alpha R5
Made for RPG Maker MZ 1.9.0
Event SetupYou can add an event name by adding a comment to your event page such as:
CGMZ EVENTNAME label
The label will be what appears above the event. It supports text codes. An example might be something like:
CGMZ EVENTNAME \c[1]Town Greeter\c[0]

You can also add a float to the event name. You do this by adding an additional line to your comment, such as this:
Float: 5 60
The first number will be the float amount, and the second number will be the time taken to complete one cycle (up/down) of the float.

You can also add a local offset to the event name. You do this by adding an additional line to your comment, such as this:
Offset: 5 10
The first number will be the x offset, the second the y offset. These can be negative if you want negative offsets. A positive X will move it right, and a positive y will move the name down.

You can also add a blink effect. You do this by adding an additional line to your comment, such as this:
Blink: 60 15
The first number will be how long the event name spends visible, and the second number will be how long the event name spends invisible. The times are in frames (60f = 1sec).

Together, your event comment may look something like this:

CGMZ EVENTNAME \c[1]Town Greeter\c[0]
Float: 5 60
Offset: 5 10
Blink: 60 15

You can also add the word "horizontal" on the end of your float command, this will make it float horizontally instead of vertically. Example:
Float: 5 60 horizontal

Text Codes: You can also add the special text code <CGMZFULLWINDOW> to your event name. If this text code is added, the name will have a full window background. It must be in all caps.
Custom OptionIf you are using a plugin that can add custom options such as [CGMZ] Options, you can create a boolean option with the symbol cgmz_eventnames which will allow your player to turn event names on/off. This can be a helpful feature, but some players may want this to be OFF to help with immersion or for some other reason.
Plugin CommandsThis plugin does not have any plugin commands.
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_EventNames.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 option to show window background behind event name
  • Compatibility with third party text codes in event names
Version AlphaR3
  • Added horizontal float option
  • Added options to control opacity distances
  • Added opacity change effect to smooth opacity changes
Version AlphaR4
  • Added switch control over visibility of event names
  • Added local x/y offset via event name comment
Version AlphaR5
  • Added blink effect to event names
  • Added Option for controlling event name visibility globally

Back to Plugin