Built-in variables

The plugin is able to read the Mumble Link API that Guild Wars 2 officially supports. This allows you to read live data from the stuff you are currently doing. Without this ability, this plugin would not have existed. You can access these variables in both variable and formatter scripts by calling getvar(id).

Note
When the Mumble Link is not available, some variables can be nil or arbitrary.

Character info

CharacterName string The name of the character that is currently active in Guild Wars 2.

ProfessionId number The profession id of the character.

MapId number The id of the map where the character is currently in.

WorldId number The shard id of the map (note that, since the introduction of the Megaservers, this does not equal the world id anymore (sadly)).

TeamColorId number The team color id when playing PvP or WvW.

IsCommander boolean True when the character is currently a commander; false otherwise.

ServerAddress 1-indexed table with 4 elements (numbers) The IP address of the current server.

MapType number The type of the map.

ShardId number The shard id of the map.

BuildId number The current build id of the client.

Positioning

AvatarPosition table with elements x, y, z (numbers) Represents the current position of the character. This is measured in meters and left-handed coordinates.

AvatarFront table with elements x, y, z (numbers) Represents the current orientation of the character’s eyes. This is measured in meters and left-handed coordinates.

CameraPosition table with elements x, y, z (numbers) Same as AvatarPosition, but for the camera.

CameraFront table with elements x, y, z (numbers) Same as AvatarFront, but for the camera.

Miscellaneous

UITick number Represents the tick of the Mumble Link. Every time the game renders a frame and updates the Mumble Link, this value is increased with 1.

UIVersion number Represents the version of the Mumble Link struct that has been used. Currently, Guild Wars 2 should always set this to 2.

Name string Represents the name of the game that is currently writing to the Mumble Link. When Guild Wars 2 is running, this is always Guild Wars 2.

Not used or reserved for future use

AvatarTop table with elements x, y, z (numbers) Represents the current orientation if the character were to look straight up. This is measured in meters and left-handed coordinates. Currently not used by Guild Wars 2.

CameraTop table with elements x, y, z (numbers) Same as AvatarTop, but for the camera. Currently not used by Guild Wars 2.

Description string Reserved. Currently not used by Guild Wars 2.

Instance number Reserved. Currently not used by Guild Wars 2.