[Script System][Suggestions] New Callbacks

OnHeroLevelUp(hero) +

It is called when a hero level up.

OnHeroHire(hero) +

It is called when the player clicks on the "OKAY" button in the Recruit Hero window.

OnHeroDismiss(hero) +

It is called when the player clicks on the "DISMISS" button in the Hero Screen.

OnHeroLosing(hero) +

It is called when the player loses a hero in combat.

OnHeroMeetingScreenOpen(h1, h2) +

It is called after the Meeting screen is opened.

OnHeroRetreat(hero) +

It is called when the player clicks on the "Retreat" button in the Hero's Options window during combat.

OnHeroSurrender(hero) +

It is called when the player clicks on the "Surrender" button in the Hero's Options window during combat.

*

OnCreatureInfoOpen(creature) +

It is called after the Creature Info window is opened.

OnCreatureUpgrade(creature) +

It is called when the player clicks on the "UPGRADE" button in the Creature Info window.

OnCreatureDismiss(creature) +

It is called when the player clicks on the "DISMISS" button in the Creature Info window.

OnCreatureJoin(creature) +

It is called when an army of neutral creatures want to join the hero on the adventure map.

*

OnTownCastleScreenOpen(name) +

It is called after the Castle Options screen is opened.

OnTownBuildingOpen(name, building) +

It is called when the player clicks on a building sprite to "enter" the building.

OnTownBuildingScreenOpen(name, building) +

It is called after the building screen is opened.

OnTownBuildingSlot(name, building) +

It is called when the player clicks on a building slot in the Castle Options screen.

OnTownLosing(name) +

It is called when the player loses a town.

OnTownCapture(name) +

It is called when the player captures a town.

*

OnBattleNewTurn(side) +
side: the side which will control the hero.

It is called at the start of a new turn during combat.

OnBattleSpellCasting(hero, spell, cost) +
hero: the hero who casts the spell.
spell: the id of the spell.
cost: the number of spell points used to cast the spell.

It is called when a hero casts a spell during combat.

OnMapSpellCasting(hero, spell, cost) +
hero: the hero who casts the spell.
spell: the id of the spell.
cost: the number of spell points used to cast the spell.

It is called when a hero casts a spell on the adventure map.

*

+: "WaitEndOfEvent" can be used with all these callbacks.

Reminder: "WaitEndOfEvent" waits for the end of an event (after the last message box of the event is closed) to continue the instructions.

***** Updated on March 25, 2017 *****

OnMouseRightClick(type, x, y)
type: the ID of the location (see section "Locations"). Can also be used on an empty square.
x: X coordinate on the world map.
y: Y coordinate on the world map.

It is called when a user right-clicks on any square on the adventure map.
For example, can be used in coordination with Get/SetLocationText(type, x, y), Get/SetCoordinateText(x, y), GetNearestPlayerTown(x, y, player), GetNearestPlayerFreeTown(x, y, player) (see here), etc.

***** Updated on March 29, 2017 *****

OnHeroDigging(hero, x, y) +

It is called when a hero digs on the adventure map.