mumble-link#

local ml = require 'mumble-link'

The mumble-link module allows access to the MumbleLink shared memory data from Guild Wars 2. The shared memory is read on each attribute access.

Attributes#

mumble-link.tick#

Type:: integer

The current game tick. This is incremented roughly every frame and can be used to determine if the MumbleLink information is being actively updated by the game.

Version History

Version	Notes
0.0.1	Added

mumble-link.version#

Type:: integer

Version History

Version	Notes
0.0.1	Added

mumble-link.charactername#

Type:: string

The name of the currently logged in character.

Version History

Version	Notes
0.0.1	Added
0.1.0	Renamed from character_name to charactername

mumble-link.characterprofession#

Type:: string

The profession of the currently logged in character. One of:

Elementalist
Engineer
Guardian
Mesmer
Necromancer
Ranger
Thief
Warrior

Version History

Version	Notes
0.0.1	Added
0.1.0	Renamed from character_profession to characterprofession

mumble-link.characterspecialization#

Type:: integer

The specialization ID of the currently logged in character. See the GW2 API.

Note

Module authors can use the gw2.static module instead of querying the GW2 API.

See gw2static.specializations and gw2.static.specialization().

Warning

Retrieving this value requires parsing the JSON text of the identity value from MumbleLink. This is a potentially resource intensive opperation. EG-Overlay will cache this parsed JSON and only reparse when mumble-link.tick has changed.

Version History

Version	Notes
0.0.1	Added
0.1.0	Renamed from character_specialization to characterspecialization

mumble-link.characterrace#

Type:: string

The race of the currently logged in character. One of:

Asura
Charr
Human
Norn
Sylvari

Warning

Version History

Version	Notes
0.0.1	Added
0.1.0	Renamed from character_race to characterrace

mumble-link.avatarposition#

Type:: position

The player’s current position in map coordinates.

Note

Position coordinates returned by MumbleLink are in meters but Guild Wars 2 uses inches internally. You may need to convert these values to use them, although some other applications, like marker packs, use meters as well.

Position coordinates are presented from a rendering perspective, which means the x coordinate is from left to right (east/west), the y is up and down (altitude) and z is depth (north/south).

Version History

Version	Notes
0.0.1	Added
0.1.0	Renamed from avatar_position to avatarposition

mumble-link.avatarfront#

Type:: position

The direction the player’s character is facing, as a vector.

Note

Position coordinates are presented from a rendering perspective, which means the x coordinate is from left to right (east/west), the y is up and down (altitude) and z is depth (north/south).

Version History

Version	Notes
0.0.1	Added
0.1.0	Renamed from avatar_front to avatarfront

mumble-link.avatartop#

Type:: position

Warning

This is not populated by GW2 and will always return zeros.

Version History

Version	Notes
0.0.1	Added
0.1.0	Renamed from avatar_top to avatartop

mumble-link.cameraposition#

Type:: position

The current camera position in map coordinates.

Note

Position coordinates are presented from a rendering perspective, which means the x coordinate is from left to right (east/west), the y is up and down (altitude) and z is depth (north/south).

Version History

Version	Notes
0.0.1	Added
0.1.0	Renamed from camera_position to cameraposition

mumble-link.camerafront#

Type:: position

The direction the camera is facing, as a vector.

Note

Position coordinates are presented from a rendering perspective, which means the x coordinate is from left to right (east/west), the y is up and down (altitude) and z is depth (north/south).

Version History

Version	Notes
0.0.1	Added
0.1.0	Renamed from camera_front to camerafront

mumble-link.cameratop#

Type:: position

Warning

This is not populated by GW2 and will always return zeros.

Version History

Version	Notes
0.0.1	Added
0.1.0	Renamed from camera_top to cameratop

mumble-link.maptype#

Type:: string

The current map type. One of:

redirect
character-creation
competitive-pvp
gvg
instance
public
tournament
tutorial
user-tournament
eternal-battlegrounds
blue-borderlands
green-borderlands
red-borderlands
wvw-reward
obsidian-sanctum
edge-of-the-mists
public-mini
big-battle
armistice-bastion

Note

Even though some of the options above are documented in the GW2 MumbleLink API they will never be returned because the are now invalid.

Version History

Version	Notes
0.0.1	Added
0.1.0	Renamed from map_type to maptype

mumble-link.mapid#

Type:: integer

The current MapID.

Version History

Version	Notes
0.0.1	Added
0.1.0	Renamed from map_id to mapid

mumble-link.shardid#

Type:: integer

The current map shard id. This value and the mapid can be used to determine a unique map instance.

Version History

Version	Notes
0.1.0	Added

mumble-link.uistate#

Type:: integer

This is a bit mask indicating various states of the game UI:

Bit	Description
1	The map is open/fullscreen
2	The minimap is located at the top right of the screen
3	The minimap has rotation enabled
4	The game window has focus
5	The game is currently in a competitive game mode? (PvP, WvW)
6	A textbox has focus
7	In combat

For example, with default settings and out of combat, when the game has focus this value will be 8 (bit 4). When the map is opened it will be 9 (bits 1 and 4).

Version History

Version	Notes
0.0.1	Added
0.1.0	Renamed from ui_state to uistate

mumble-link.mapopen#

Type:: boolean

A boolean indicating if the first bit of uistate is set, which indicates if the map is open fullscreen.

Version History

Version	Notes
0.1.0	Added

mumble-link.incombat#

Type:: boolean

A boolean indicating if the seventh bit of uistate is set, which indicates if the player is currently in combat.

Version History

Version	Notes
0.1.0	Added

Data#

alias position: table#

A table holding x, y, and z coordinates.

Field	Description
x	number
y	number
z	number

Version History

Version	Notes
0.0.1	Added

mumble-link

Contents

mumble-link#

Attributes#

Data#