API Docs (pts)

Back to index...

Name	Type	Description
Command.Guild.Bank.Deposit	function	Deposits money into the guild bank.
Command.Guild.Bank.Purchase	function	Purchases a new guild bank vault.
Command.Guild.Bank.Withdraw	function	Withdraws money from the guild bank.
Command.Guild.Log.Request	function	Requests a guild log event.
Command.Guild.Motd	function	Changes the guild's Message of the Day.
Command.Guild.Roster.Demote	function	Demotes a guildmember by one rank.
Command.Guild.Roster.Kick	function	Kicks a guildmember from the guild.
Command.Guild.Roster.Note	function	Changes your guild note.
Command.Guild.Roster.NoteOfficer	function	Changes a guildmember's officer note.
Command.Guild.Roster.Promote	function	Promotes a guildmember by one rank.
Command.Guild.Wall.Delete	function	Deletes an entry from the guild wall.
Command.Guild.Wall.Post	function	Posts an entry to the guild wall.
Command.Guild.Wall.Request	function	Requests a guild wall event.
Event.Guild.Bank.Change		Signals a change in a guild bank vault's information.
Event.Guild.Bank.Coin		Signals a change in the guild bank's money.
Event.Guild.Log		Signals incoming guild log data. Can be triggered manually with Command.Guild.Log.Request().
Event.Guild.Motd		Signals a change in the guild Message of the Day.
Event.Guild.Rank		Signals a change in one of your guild's ranks.
Event.Guild.Roster.Add		Signals a new player added to the guild roster.
Event.Guild.Roster.Detail.Level		Signals a change in a guildmember's level.
Event.Guild.Roster.Detail.Note		Signals a change in a guildmember's note.
Event.Guild.Roster.Detail.NoteOfficer		Signals a change in a guildmember's officer note.
Event.Guild.Roster.Detail.Rank		Signals a change in a guildmember's rank.
Event.Guild.Roster.Detail.Status		Signals a change in a guildmember's status.
Event.Guild.Roster.Detail.Zone		Signals a change in a guildmember's zone.
Event.Guild.Roster.Remove		Signals a player removed from the guild roster.
Event.Guild.Wall		Signals incoming guild wall data. Can be triggered manually with Command.Guild.Wall.Request().
Inspect.Guild.Bank.Coin	function	Returns the amount of money contained within the guild bank.
Inspect.Guild.Bank.Detail	function	Provides detailed information about guild bank vaults.
Inspect.Guild.Bank.List	function	Returns a table of all available guild bank vaults.
Inspect.Guild.Motd	function	Returns the current guild Message of the Day.
Inspect.Guild.Rank.Detail	function	Provides detailed information about guild ranks.
Inspect.Guild.Rank.List	function	Lists available guild ranks.
Inspect.Guild.Roster.Detail	function	Provides detailed information about guildmembers.
Inspect.Guild.Roster.List	function	Lists guildmembers.

Command.Guild.Bank.Deposit

Deposits money into the guild bank.

Usage:

Interaction category: guildbank

Throttled.

Parameter	Type	Datatype	Description
Command.Guild.Bank.Deposit(coin)
Command.Guild.Bank.Deposit(coin, callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
coin	parameter	number	The string "coin", used as a value to request the player's money.

Command.Guild.Bank.Purchase

Purchases a new guild bank vault.

Usage:

Interaction category: guildbank

Throttled.

Parameter	Type	Datatype	Description
Command.Guild.Bank.Purchase()
Command.Guild.Bank.Purchase(callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.

Command.Guild.Bank.Withdraw

Withdraws money from the guild bank.

Usage:

Interaction category: guildbank

Throttled.

Parameter	Type	Datatype	Description
Command.Guild.Bank.Withdraw(coin)
Command.Guild.Bank.Withdraw(coin, callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
coin	parameter	number	The string "coin", used as a value to request the player's money.

Command.Guild.Log.Request

Requests a guild log event.

Usage:

Parameter	Type	Datatype	Description
Command.Guild.Log.Request()
Command.Guild.Log.Request(callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.

throttleBulk: true

Command.Guild.Motd

Changes the guild's Message of the Day.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Guild.Motd(motd)
Command.Guild.Motd(motd, callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
motd	parameter	string	The new Message of the Day.

Command.Guild.Roster.Demote

Demotes a guildmember by one rank.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Guild.Roster.Demote(member)
Command.Guild.Roster.Demote(member, callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
member	parameter	string	The guildmember to target.

Command.Guild.Roster.Kick

Kicks a guildmember from the guild.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Guild.Roster.Kick(member)
Command.Guild.Roster.Kick(member, callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
member	parameter	string	The guildmember to target.

Command.Guild.Roster.Note

Changes your guild note.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Guild.Roster.Note(note)
Command.Guild.Roster.Note(note, callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
note	parameter	string	The new note.

Command.Guild.Roster.NoteOfficer

Changes a guildmember's officer note.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Guild.Roster.NoteOfficer(member, note)
Command.Guild.Roster.NoteOfficer(member, note, callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
member	parameter	string	The guildmember to target.
note	parameter	string	The new note.

Command.Guild.Roster.Promote

Promotes a guildmember by one rank.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Guild.Roster.Promote(member)
Command.Guild.Roster.Promote(member, callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
member	parameter	string	The guildmember to target.

Command.Guild.Wall.Delete

Deletes an entry from the guild wall.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Guild.Wall.Delete(wall)
Command.Guild.Wall.Delete(wall, callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
wall	parameter	guildwall	The ID of the target wall post.

Command.Guild.Wall.Post

Posts an entry to the guild wall.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Guild.Wall.Post(post)
Command.Guild.Wall.Post(post, callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
post	parameter	string	The item to post.

Command.Guild.Wall.Request

Requests a guild wall event.

Usage:

Parameter	Type	Datatype	Description
Command.Guild.Wall.Request()
Command.Guild.Wall.Request(callback)
callback	parameter	callbackfunction	A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.

throttleBulk: true

Event.Guild.Bank.Change

Signals a change in a guild bank vault's information.

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Bank.Change(vaults)
vaults	parameter	variant	A lookup table of vaults that have changed.

Event.Guild.Bank.Coin

Signals a change in the guild bank's money.

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Bank.Coin(coin)
coin	parameter	variant	The new amount of money in the guild bank.

Event.Guild.Log

Signals incoming guild log data. Can be triggered manually with Command.Guild.Log.Request().

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Log(log)
log	parameter	variant	An array containing the refreshed guild log items, in order.

members

achievement	The achievement involved.
coin	The amount of silver involved.
count	The number of items involved.
item	The item type involved.
level	The level involved.
rank	The rank involved.
source	The source of the log event.
target	The target of the log event.
type	The type of the log message. May be any of achievement, bankCoinDeposit, bankCoinHeal, bankCoinTithe, bankCoinWithdraw, bankItemDeposit, bankItemWithdraw, bankVault, charterSign, charterUnsign, demote, demoteTrial, dimensionBuy, finder, firstAchievement, firstCollection, firstItem, firstKill, firstQuest, form, found, invite, kick, leave, level, motd, promote, rankEdit, rename, transferred, unlearnActive, unlearnPassive, wallDelete, wallModify, xp, or xpQuest.
xp	The amount of XP involved.

Event.Guild.Motd

Signals a change in the guild Message of the Day.

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Motd(motd)
motd	parameter	variant	The new Message of the Day.

Event.Guild.Rank

Signals a change in one of your guild's ranks.

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Rank(ranks)
ranks	parameter	variant	A lookup table of ranks that have changed.

Event.Guild.Roster.Add

Signals a new player added to the guild roster.

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Roster.Add(add)
add	parameter	variant	The name of the added guildmember.

Event.Guild.Roster.Detail.Level

Signals a change in a guildmember's level.

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Roster.Detail.Level(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Guild.Roster.Detail.Note

Signals a change in a guildmember's note.

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Roster.Detail.Note(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Guild.Roster.Detail.NoteOfficer

Signals a change in a guildmember's officer note.

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Roster.Detail.NoteOfficer(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Guild.Roster.Detail.Rank

Signals a change in a guildmember's rank.

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Roster.Detail.Rank(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Guild.Roster.Detail.Status

Signals a change in a guildmember's status.

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Roster.Detail.Status(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value, or "false" in place of nil.

Event.Guild.Roster.Detail.Zone

Signals a change in a guildmember's zone.

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Roster.Detail.Zone(units)
units	parameter	variant	Table of the units changed. Key is the unit ID, value is the new value.

Event.Guild.Roster.Remove

Signals a player removed from the guild roster.

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Roster.Remove(remove)
remove	parameter	variant	The name of the removed guildmember.

Event.Guild.Wall

Signals incoming guild wall data. Can be triggered manually with Command.Guild.Wall.Request().

Usage:

Parameter	Type	Datatype	Description
Event.Guild.Wall(wall)
wall	parameter	variant	An array containing the refreshed guild wall items, in order.

members

id	The ID of the guild wall entry.
poster	The poster of the guild wall entry.
text	The text of the guild wall entry.
time	The time the wall entry was posted, in UNIX time.

Inspect.Guild.Bank.Coin

Returns the amount of money contained within the guild bank.

Usage:

Interaction category: guildbank

Parameter	Type	Datatype	Description
coin = Inspect.Guild.Bank.Coin()
coin	result	number	The current money in the guild bank, in silver.

Inspect.Guild.Bank.Detail

Provides detailed information about guild bank vaults.

Usage:

Parameter	Type	Datatype	Description
detail = Inspect.Guild.Bank.Detail(guildvault)
details = Inspect.Guild.Bank.Detail(guildvaults)
guildvault	parameter	slot	A slot specifier representing the entire guild bank vault to retrieve information for.
guildvaults	parameter	table	A table of slot specifiers, each representing an entire guild bank vault, to retrieve information for.
detail	result	table	Detail table for a guild bank vault.
details	result	table	Detail tables for all requested guild bank vault. The key is the vault specifier, the value is the vault's detail table.

members

id	The ID of the requested element.
name	The name of the vault.

Inspect.Guild.Bank.List

Returns a table of all available guild bank vaults.

Usage:

Parameter	Type	Datatype	Description
list = Inspect.Guild.Bank.List()
list	result	table	All available guild vaults, in {id = name} format.

Inspect.Guild.Motd

Returns the current guild Message of the Day.

Usage:

Parameter	Type	Datatype	Description
motd = Inspect.Guild.Motd()
motd	result	string	The current Message of the Day.

Inspect.Guild.Rank.Detail

Provides detailed information about guild ranks.

Usage:

Parameter	Type	Datatype	Description
detail = Inspect.Guild.Rank.Detail(guildrank)
details = Inspect.Guild.Rank.Detail(guildranks)
guildrank	parameter	guildrank	The identifier of the rank to retrieve detail for.
guildranks	parameter	table	A table of identifiers of ranks to retrieve detail for.
detail	result	table	Detail table for a single rank.
details	result	table	Detail table for all requested ranks. The key is the rank ID, the value is the rank's detail table.

members

addonStorageDelete	Signals that this rank has permission to modify or delete addon storage elements.
addonStorageWrite	Signals that this rank has permission to non-destructively write addon storage elements.
demote	Signals that this rank has permission to demote guildmembers.
finderEdit	Signals that this rank has permission to edit the Guild Finder settings.
finderReceive	Signals that this rank has permission to receive Guild Finder messages.
id	The ID of the requested element.
invite	Signals that this rank has permission to invite new guildmembers.
kick	Signals that this rank has permission to kick guildmembers.
listen	Signals that this rank has permission to listen to guild chat.
motd	Signals that this rank has permission to change the guild Message of the Day.
name	The name of this rank.
noteOfficer	Signals that this rank has permission to view and edit Officer Notes.
officer	Signals that this rank has permission to listen to and speak in officer chat.
perk	Signals that this rank has permission to choose guild perks.
promote	Signals that this rank has permission to promote guildmembers.
questAbandon	Signals that this rank has permission to abandon guild quests.
questAccept	Signals that this rank has permission to accept guild quests.
questComplete	Signals that this rank has permission to complete guild quests.
rally	Signals that this rank has permission to set the guild rally point.
rankEdit	Signals that this rank has permission to edit rank permissions.
rename	Signals that this rank has permission to rename the guild.
speak	Signals that this rank has permission to speak in guild chat.
vaultAccess	A table containing information on vault access permissions. The key is the vault ID in slot format. The value is a table containing two members, "access" which may be nil, "deposit", or "full", and "withdrawLimit" which gives the number of stacks that may be withdrawn daily.
vaultBuy	Signals that this rank has permission to buy guild vaults.
vaultRename	Signals that this rank has permission to rename guild vaults.
wallDelete	Signals that this rank has permission to delete entries off the Guild Wall.
wallPost	Signals that this rank has permission to post to the Guild Wall.

Inspect.Guild.Rank.List

Lists available guild ranks.

Usage:

Parameter	Type	Datatype	Description
list = Inspect.Guild.Rank.List()
list	result	table	A table of the IDs of the available ranks. The value is the rank's name.

Inspect.Guild.Roster.Detail

Provides detailed information about guildmembers.

Usage:

Parameter	Type	Datatype	Description
detail = Inspect.Guild.Roster.Detail(guildmember)
details = Inspect.Guild.Roster.Detail(guildmembers)
guildmember	parameter	string	The name of the guildmember to retrieve data for.
guildmembers	parameter	table	A table of names of guildmembers to retrieve data for.
detail	result	table	Detail table for a single guildmember.
details	result	table	Detail tables for all requested guildmembers. The key is the guildmember's name, the value is the guildmember's detail table.

members

id	The ID of the requested element.
level	The guildmember's level.
logout	The guildmember's last logout time, in UNIX time.
name	The guildmember's name.
note	The guildmember's public note.
noteOfficer	The guildmember's officer note.
rank	The guildmember's rank.
score	The guildmember's achievement score.
status	The guildmember's current status. May include "online" or "mobile". nil if the guildmember is offline.
zone	The guildmember's current zone, if online.

Inspect.Guild.Roster.List

Lists guildmembers.

Usage:

Parameter	Type	Datatype	Description
list = Inspect.Guild.Roster.List()
list	result	table	A table listing all your guildmembers. The key is the guildmember's name, the value is the guildmember's status.