PyG2O/docs/comparing.md

• addEventHandler replaced with decorator event

@g2o.event('onInit')
def evtInitFirst(**kwargs):
    print('Hello')
    
@g2o.event('onInit', 100)       # '100' is priority
def evtInitSecond(**kwargs):
    print('World')

---

• Positional arguments inside event handles replaced with keyword arguments (see names of all keywords on the each event page)

@g2o.event('onPlayerChangeColor')
def evtColor(**kwargs):
    playerid = kwargs['playerid']
    r = kwargs['r']
    b = kwargs['b']

---

• callEvent now also requires to pass keyword arguments instead of positional arguments

@g2o.event('MyTestEvent')
def testEvt(**kwargs):
    print(kwargs)
    
g2o.callEvent('MyTestEvent', name = 'aurumvorax', id = 15)
# OR
g2o.callEvent('MyTestEvent', {'name': 'aurumvorax', 'id': 15})
# OR
args = {'name': 'aurumvorax', 'id': 15}
g2o.callEvent('MyTestEvent', args)

---

• cancelEvent replaced with returning False inside the handler ^{(you don't need to explicitly return True if you don't want to cancel the event)}

@g2o.event('onPlayerTakeItem')
def evtTake(**kwargs):
    return False

---

• isEventCancelled replaced with built-in function property cancelled, alongside with the eventName

@g2o.event('onPlayerDropItem')
def evtDrop(**kwargs):
    print(evtDrop.cancelled)
    print(evtDrop.eventName)

---

• Following functions have been removed _{^{RIP :(}}

  • md5
  • sha1
  • sha256
  • sha384
  • sha512
  • setReloadCallback
  • setUnloadCallback
  • getTimerExecuteTimes
  • getTimerInterval
  • killTimer
  • setTimer
  • setTimerExecuteTimes
  • setTimerInterval
  • sscanf
  • hexToRgb
  • rgbToHex
  • getTickCount
  • eventValue
  • getPlayerMagicLevel
  • setPlayerMagicLevel

---

• All functions and events that returned/passed a null in the Squirrel, now passes an empty string. Most notable in this list are all equipment related functions and events
  • onPlayerEquipAmulet
  • onPlayerEquipArmor
  • onPlayerEquipBelt
  • onPlayerEquipHandItem
  • onPlayerEquipHelmet
  • onPlayerEquipMeleeWeapon
  • onPlayerEquipRangedWeapon
  • onPlayerEquipRing
  • onPlayerEquipShield
  • onPlayerEquipSpell
  • getPlayerAmulet
  • getPlayerArmor
  • getPlayerBelt
  • getPlayerHelmet
  • getPlayerMeleeWeapon
  • getPlayerRangedWeapon
  • getPlayerRing
  • getPlayerShield
  • getPlayerSpell

---

• ItemsGround.getById throws an exception instead of returning null if there's no item with given ID