mumble-link-events

require 'mumble-link-events'

The mumble-link-events module does not have any public functions or attributes, however once it is loaded from another module using require, it will send events based on the data accessible from the mumble-link module.

Note

This module checks particular values in mumble-link on every update event. Any events that it queues are dispatched on the next update.

Events

mumble-link-available

Sent once mumble-link.tick() has changed after a mumble-link-unavailable event.

Version History

Version	Notes
0.3.0	Added

mumble-link-unavailable

Sent anytime mumble-link.tick() is not updated for at least 400 milliseconds, indicating that the game is no longer updating the MumbleLink data.

Once this event has been sent additional MumbleLink related events will not be sent until mumble-link-available is sent again.

Version History

Version	Notes
0.3.0	Added

mumble-link-map-changed

Sent anytime mumble-link.context.mapid() changes between update events.

Event handlers will be sent a Lua table containing two fields:

Field	Description
from	The map ID of the prior map.
to	The map ID of the new map.

Warning

from may be 0 if there was not a valid map previously.

Version History

Version	Notes
0.3.0	Added

mumble-link-character-changed

Sent anytime mumble-link.identity.name() changes between update events.

Event handlers will be sent a Lua table containing two fields:

Field	Description
from	The previous character name.
to	The new character name.

Warning

from may be nil if there was no previous character name.

Version History

Version	Notes
0.3.0	Added