Documentation for m25event.py

Warning: This documentation was generated from the comments in the source code (using progrutils.documentPyFile()), with a few tweaks, under the principle that poor documentation is better than no documentation. In case of ambiguity, please refer to the code itself.

 

Module: m25event

By M25

Description: set up events within the ff system

class UserEvent

adapted from stumpy's code in mlogreader

Event_RegisterEvent(eventType, function, persistent=0)

Event_TriggerEvent(eventType, event=None)

event should be of the UserEvent type

Event_TriggerFirst(eventType, event=None)

Event_UnRegisterEvent(eventType, function)

SetTimer(time, function, string1='', string2='', user=0)

SetProximity(function, char, object='GAME_OBJ_HERO', distance=30, user=0)