Event Reference

Event Reference (MZ → React)

This page lists real events emitted by the stock overrides under js/plugins/rpgreact/ so your custom overrides can follow the same patterns. The event(eventType, eventSpecifier, data?, trace?) helper available inside overrides automatically decorates data with the current platform/app context.

Conventions

• eventType comes from RPGEventType (in menus/shared/types.js); compare against enum values (not strings).

• eventSpecifier is usually an enum value from one of: RPGScreen, RPGMessageType, RPGBattleEvent, RPGWindowEvent, but some flows use custom strings (example: "Formation").

• data is a plain object; the bridge will merge platform context into it before React receives it.

• trace is an optional string to help debug where the event came from.

• InputType is exposed alongside the other enums for input-change payloads.

Screen events

• Open screen

  event(RPGEventType.SCREEN_OPEN, RPGScreen[RPGScreen.Splash], null, "PluginSceneSplash");
  event(RPGEventType.SCREEN_OPEN, RPGScreen[RPGScreen.Title], { actions }, "PluginSceneTitle");
  event(RPGEventType.SCREEN_OPEN, RPGScreen[RPGScreen.Map], {}, "PluginSceneMap");
  event(RPGEventType.SCREEN_OPEN, RPGScreen[RPGScreen.MainMenu], menuData, "PluginSceneMenu");
  event(RPGEventType.SCREEN_OPEN, RPGScreen[RPGScreen.Shop], menuData, "PluginSceneShop");
  event(RPGEventType.SCREEN_OPEN, RPGScreen[RPGScreen.Battle], BattleData, "PluginSceneBattle");
  event(RPGEventType.SCREEN_OPEN, RPGScreen[RPGScreen.GameOver], actions, "PluginSceneGameOver");
  event(RPGEventType.SCREEN_OPEN, RPGScreen[RPGScreen.GameEnd], actions, "PluginSceneGameOver");

• Close screen

  event(RPGEventType.SCREEN_CLOSE, null, null, "PluginSceneTitle");

Scene lifecycle events

// Scene init (sent from Scene_Base.start)
event(RPGEventType.SCENE_INIT, null, null, "PluginSceneBase");

// Fades
event(RPGEventType.FADE_OUT, {}, {}, "PluginCommon");
event(RPGEventType.FADE_IN, {}, {}, "PluginCommon");

Overlay window events

event(RPGEventType.OVERLAY_WINDOW, RPGScreen[RPGScreen.Message], { gameMessage: $gameMessage }, "PluginInterpreter");
event(RPGEventType.OVERLAY_WINDOW, RPGScreen[RPGScreen.Items],   menuData, "PluginSceneItem");
event(RPGEventType.OVERLAY_WINDOW, RPGScreen[RPGScreen.Save],    saveData, "PluginSceneSave");
event(RPGEventType.OVERLAY_WINDOW, RPGScreen[RPGScreen.Load],    saveData, "PluginSceneSave");
event(RPGEventType.OVERLAY_WINDOW, RPGScreen[RPGScreen.Options], optionsData, "PluginSceneOptions");
event(RPGEventType.OVERLAY_WINDOW, RPGScreen[RPGScreen.Equip],   equipData, "PluginSceneEquip");
event(RPGEventType.OVERLAY_WINDOW, RPGScreen[RPGScreen.Status],  statusData, "PluginSceneStatus");
event(RPGEventType.OVERLAY_WINDOW, RPGScreen[RPGScreen.Skills],  skillsData, "PluginSceneSkill");
event(RPGEventType.OVERLAY_WINDOW, RPGScreen[RPGScreen.InputNumber], eventData, "PluginInterpreter");
event(RPGEventType.OVERLAY_WINDOW, RPGScreen[RPGScreen.InputText],   eventData, "PluginSceneNameInput");
event(RPGEventType.OVERLAY_WINDOW, RPGScreen[RPGScreen.SelectItem],  eventData, "PluginInterpreter");
event(RPGEventType.OVERLAY_WINDOW, RPGScreen[RPGScreen.ScrollingText], eventData, "PluginInterpreter");

Toast/message events

// Show
event(RPGEventType.SHOW_TOAST, RPGMessageType.NORMAL,     { message: "Test" }, "PluginSceneTitle");
event(RPGEventType.SHOW_TOAST, RPGMessageType.MAP_NAME,   { message: $gameMap.displayName() });
event(RPGEventType.SHOW_TOAST, RPGMessageType.GOLD_DISPLAY, {}, "PluginOverrideWindowMessage");
event(RPGEventType.SHOW_TOAST, RPGMessageType.BATTLE_MESSAGE, { message: TextManager.victory.format($gameParty.name()) });

// Hide
event(RPGEventType.HIDE_TOAST, RPGMessageType.MAP_NAME);

Window/UI events

event(RPGEventType.WINDOW_EVENT, RPGWindowEvent[RPGWindowEvent.MENU_BUTTON_SHOW], {}, "PluginSceneMap");
event(RPGEventType.WINDOW_EVENT, RPGWindowEvent[RPGWindowEvent.MENU_BUTTON_HIDE], {}, "PluginSceneMap");
event(
  RPGEventType.WINDOW_EVENT,
  RPGWindowEvent[RPGWindowEvent.INPUT_TYPE_CHANGED],
  { inputType: InputType.KEYBOARD }
);

Actor selection and cancel events

// Item use needs a target
event(RPGEventType.ACTOR_SELECT, RPGScreen[RPGScreen.Items], { itemSelected: this.item() }, "PluginSceneItemBase");

// Cancel out of item flow
event(RPGEventType.CANCEL_EVENT, RPGScreen[RPGScreen.Items], null, "PluginSceneItem");

Battle events (partial list)

// Enter battle screen
event(RPGEventType.SCREEN_OPEN, RPGScreen[RPGScreen.Battle], BattleData, "PluginSceneBattle");

// Selections and flow
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.PARTY_START_INPUT], {}, "PluginSceneBattle");
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.ACTOR_START_INPUT], { actor: this._currentActor }, "PluginSceneBattle");
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.ACTOR_SELECT_START], {}, "PluginSceneBattle");
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.ENEMY_SELECT_START], {}, "PluginSceneBattle");
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.ACTOR_SKILLSELECT_START], { selectedSTypeId: selectedSTypeId }, "PluginSceneBattle");
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.ACTOR_ITEMSELECT_START], {}, "PluginSceneBattle");
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.PARTY_END_INPUT], {}, "PluginSceneBattle");
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.ACTOR_END_INPUT], {}, "PluginSceneBattle");
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.ACTOR_SELECT_END], {}, "PluginSceneBattle");
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.ENEMY_SELECT_END], {}, "PluginSceneBattle");

// Targets (hover/click)
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.ACTOR_TARGET_HOVER], { targetIndex: target.index() }, "PluginSceneBattle");
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.ACTOR_TARGET_CLICK], { targetIndex: target.index() }, "PluginSceneBattle");
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.ENEMY_TARGET_HOVER], { targetIndex: target.index() }, "PluginSceneBattle");
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.ENEMY_TARGET_CLICK], { targetIndex: target.index() }, "PluginSceneBattle");

// Battle log
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.BATTLE_LOG_APPEND], { message: this._lines[this._lines.length - 1] });

// Results
event(RPGEventType.BATTLE_EVENT, RPGBattleEvent[RPGBattleEvent.SHOW_BATTLE_RESULTS], eventData, "BattleManager");

Notes

• The enums used above are emitted by your build to menus/shared/types.js. Ensure you rebuild menus/ so the plugin loads these types at boot.

• This is a representative list based on the stock overrides present in the plugin. If you add your own events, prefer namespacing under existing types or document them for your React team.