MooUnit-1.0

Overview

MooUnit-1.0 is a library that provides mappings between GUIDs, unit IDs, and names.

The unit IDs tracked by the library are:

• "player"
• "vehicle"
• "pet", "pettarget"
• "target", "targettarget"
• "focus", "focustarget"
• "arena1", ..., "arena5"
• "arena1target", ..., "arena5target"
• "arenapet1", ..., "arenapet5"
• "arenapet1target", ... "arenapet5target"
• "boss1", ..., "boss5"
• "boss1target", ..., "boss5target"
• "party1", ..., "party4"
• "party1target", ..., "party4target"
• "partypet1", ..., "partypet4"
• "partypet1target", ..., "partypet4target"
• "raid1", ..., "raid40"
• "raid1target", ..., "raid40target"
• "raidpet1", ..., "raidpet40"
• "raidpet1target", ..., "raidpet40target"
• "nameplate1", ...
• "nameplate1target", ...

boolean = lib:HasUnitEvents(unit)

• unit - string: unit ID, e.g., "player", "party1", "raid15", etc.

• boolean - boolean: true if the unit receives unit events, or false otherwise

guid = lib:GetGUIDByUnit(unit)

• unit - string: unit ID, e.g., "player", "party1", "raid15", etc.

• guid - string: GUID of the unit

unit1, unit2, ..., unitN = lib:GetUnitByGUID(guid)

• guid - string: GUID

• unit1, unit2, ..., unitN - list of strings: variable-length list of unit ID strings

name = lib:GetNameByUnit(unit)

• unit - string: unit ID, e.g., "player", "party1", "raid15", etc.

• name - string: the name of the unit, name or name-realm

unit1, unit2, ..., unitN = lib:GetUnitByName(name)

• name - string: name or name-realm

• unit1, unit2, ..., unitN - list of strings: variable-length list of unit ID strings

name = lib:GetNameByGUID(guid)

• guid - string: GUID

• name - string: the name associated with the GUID, name or name-realm

guid1, guid2, ..., guidN = lib:GetGUIDByName(name)

• name - string: name or name-realm

• guid1, guid2, ..., guidN - list of strings: variable-length list of GUID strings

petUnit = lib:GetPetUnitByUnit(unit)

• unit - string: unit ID, e.g., "player", "party1", "raid15", etc.

• petUnit - string: unit ID, e.g., "pet", "partypet1", "raidpet15", etc.

ownerGUID = lib:GetOwnerGUIDByGUID(guid)

• guid - string: GUID of the pet or vehicle

• ownerGUID - string: GUID of the owner

targetUnit = lib:GetTargetUnitByUnit(unit)

• unit - string: unit ID, e.g., "player", "party1", "raid15", etc.

• targetUnit - string: unit ID, e.g., "target", "party1target", "raid15target", etc.

boolean = lib:IsGUIDInGroup(guid)

• guid - string: GUID to test group membership

• boolean - boolean: true if the unit is on the group roster, or false otherwise

boolean = IsGroupUnit(unit)

• unit - string: unit ID, e.g., "player", "party1", "raid15", etc.

• boolean - boolean: true if the unit exists and is a group unit ID, or false otherwise

for guid, unit in lib:IteratorRoster() do
    ...
end

lib.RegisterCallback(handler, callback, method, arg)

• handler - table/string: your addon object or another table containing a function at handler[method], or a string identifying your addon
• callback - string: the name of the callback to be registered
• method - string/function/nil: a key into the handler table, or a function to be called, or nil if handler is a table and a function exists at handler[callback]
• arg - a value to be passed as the first argument to the callback function specified by method

• If handler is a table, method is a string, and handler[method] is a function, then that function will be called with handler as its first argument, followed by the callback name and the callback-specific arguments.
• If handler is a table, method is nil, and handler[callback] is a function, then that function will be called with handler as its first argument, followed by the callback name and the callback-specific arguments.
• If handler is a string and method is a function, then that function will be called with the callback name as its first argument, followed by the callback-specific arguments.
• If arg is non-nil, then it will be passed to the specified function. If handler is a table, then arg will be passed as the second argument, pushing the callback name to the third position. Otherwise, arg will be passed as the first argument.

lib.UnregisterCallback(handler, callback)

• handler - table/string: your addon object or a string identifying your addon
• callback - string: the name of the callback to be unregistered

• ownerGUID - string: GUID of the pet owner
• ownerUnit - string: unit ID of the pet owner
• petGUID - string: GUID of the pet
• petUnit - string: unit ID of the pet

• guid - string: GUID associated with the unit ID
• unit - string: unit ID of the unit that has changed
• name - string: the current name associated with the unit ID.

• guid - string: GUID of the member that joined the group
• unit - string: unit ID of the member that joined the group

• guid - string: GUID of the member that left the group

• Report a bug or suggest a feature.