Other players

Chat, party and squad

Chat, your party and squad, contacts, mail, votes and PvP.

Party and squad members and contacts are found by account name (Name.1234), display name or uuid. Functions that act on one return false when nobody matches.

A user is {uuid, account_name, display_name, achievement_points, level, profession, mastery_level, map_id, server_id, online_status, invite_status, sharing_participation}.

chat

chat.send(channel, text)
Sends a message to a channel, such as chat.SQUAD.
chat.whisper(name, text)
Whispers to a player.
chat.channels()integer[]?
The channels you're in.

Messages arrive in the on_message callback.

Channels, as chat.LOCAL and so on
LOCALMAPPARTYSQUADTEAMGUILDGUILD1GUILD2GUILD3GUILD4GUILD5GUILD6GUILD_UNKNOWNWHISPEREMOTELFGCUSTOMCHATTERDEVFEEDBACKDEPRECATED_SUBGROUPINFOINFO_BUCKETINFO_CHARACTERINFO_CONTACTSINFO_GUILDINFO_INVENTORYINFO_PVEINFO_PVPINFO_SQUADINFO_WVWCOMBATCOMBAT_IN_BUFFCOMBAT_IN_HEALCOMBAT_IN_INTERRUPTCOMBAT_IN_MITIGATIONCOMBAT_IN_STRIKECOMBAT_OUT_BUFFCOMBAT_OUT_HEALCOMBAT_OUT_INTERRUPTCOMBAT_OUT_MITIGATIONCOMBAT_OUT_STRIKE

party

party.in_party()boolean
Whether you're in a party.
party.members()table[]
The party's members, as users.
party.invite(name)
Invites a player.
party.join(name)
Joins a player's party.
party.accept(name)boolean
Accepts a member's request or invite.
party.decline(name)boolean
Declines it.
party.kick(name)boolean
Kicks a member.
party.join_instance(name)boolean
Joins a member's instance.
party.leave()
Leaves the party.

squad

squad.in_squad()boolean
Whether you're in a squad.
squad.members()table[]
The squad's members: {user, account_name, pending, ready_state, subgroup}.
squad.create()
Starts a squad.
squad.join(name)
Joins a player's squad.
squad.invite(name)
Invites a player.
squad.kick(name)boolean
Kicks a member.
squad.leave()
Leaves the squad.
squad.ready_check()
Starts a ready check.
squad.set_message(text)
Sets the squad message.
squad.set_subgroup(name, group)boolean
Moves a member to a subgroup.
squad.set_participation_sharing(name, on)boolean
Turns participation sharing on or off for a member.
squad.has_commander_tag()boolean
Whether the squad has a commander tag.
squad.in_raid_mode()boolean
Whether it's in raid mode.
squad.set_raid_mode(on)
Turns raid mode on or off.
squad.is_private()boolean
Whether the squad is private.
squad.set_private(on)
Makes it private or public.
squad.join_mode()integer?
Who can join.
squad.set_join_mode(mode)
Sets who can join.
squad.allow_members_to_send_invites()boolean
Whether members can invite.
squad.lock_all_subgroups(on)
Locks or unlocks every subgroup.

contacts

contacts.current_user()table?
You, as a user.
contacts.friends()table[]?
Your friends.
contacts.blocked()table[]?
Players you blocked.
contacts.remove_friend(name)boolean
Removes a friend.
contacts.block(name)
Blocks a player.
contacts.unblock(name)boolean
Unblocks a player.

mail

mail.list()table[]
Your mail: {parcel_id, sender, title, body, is_from_player, coins, items}, each item {slot, id, item_type, rarity, name, quantity, def}.
mail.send(to, title, body [, coins [, items]])
Sends mail, with coins (in copper) and a list of Items.
mail.take_coins(parcel_id)boolean
Takes a mail's coins.
mail.take_item(parcel_id, slot)boolean
Takes one of its items.
mail.delete(parcel_id)boolean
Deletes it.

vote

vote.active()table[]
Votes in progress (such as kick votes), each a list of {player_id, value}.
vote.cast(value [, index])boolean
Votes vote.ACCEPT or vote.DECLINE on the first vote, or the index-th.
Vote values
ACCEPTDECLINEACCEPTED

pvp

pvp.game_state()integer?
The match state: one of the constants below.
pvp.players()table[]?
Players in the match: {flags, ready, uuid, agent}.
pvp.set_ready(on)
Marks you ready, or not.
pvp.leave()
Leaves the match.
pvp.modes()integer[]?
The lobby's game modes.
pvp.play_mode(mode)boolean
Queues for a mode.
pvp.match()table?
The match found: {players, map_guids, selected_map_guid}, each player {accepted, user}.
pvp.accept_match()
Accepts the match.
pvp.select_map(guid)
Votes for a map.
pvp.leave_roster()
Leaves the roster.
Match states
WAITING_FOR_PLAYERSABOUT_TO_BEGINCOUNTDOWNONGOINGFINISHED
PreviousActivities