Back to index...

NameTypeDeprecatedSecureDescription
Command.Guild.Bank.DepositfunctionDeposits money into the guild bank.
Command.Guild.Bank.PurchasefunctionPurchases a new guild bank vault.
Command.Guild.Bank.WithdrawfunctionWithdraws money from the guild bank.
Command.Guild.Log.RequestfunctionRequests a guild log event.
Command.Guild.MotdfunctionChanges the guild's Message of the Day.
Command.Guild.Roster.DemotefunctionDemotes a guildmember by one rank.
Command.Guild.Roster.KickfunctionKicks a guildmember from the guild.
Command.Guild.Roster.NotefunctionChanges your guild note.
Command.Guild.Roster.NoteOfficerfunctionChanges a guildmember's officer note.
Command.Guild.Roster.PromotefunctionPromotes a guildmember by one rank.
Command.Guild.Wall.DeletefunctionDeletes an entry from the guild wall.
Command.Guild.Wall.PostfunctionPosts an entry to the guild wall.
Command.Guild.Wall.RequestfunctionRequests a guild wall event.
Event.Guild.Bank.ChangeSignals a change in a guild bank vault's information.
Event.Guild.Bank.CoinSignals a change in the guild bank's money.
Event.Guild.LogSignals incoming guild log data. Can be triggered manually with Command.Guild.Log.Request().
Event.Guild.MotdSignals a change in the guild Message of the Day.
Event.Guild.RankSignals a change in one of your guild's ranks.
Event.Guild.Roster.AddSignals a new player added to the guild roster.
Event.Guild.Roster.Detail.LevelSignals a change in a guildmember's level.
Event.Guild.Roster.Detail.NoteSignals a change in a guildmember's note.
Event.Guild.Roster.Detail.NoteOfficerSignals a change in a guildmember's officer note.
Event.Guild.Roster.Detail.RankSignals a change in a guildmember's rank.
Event.Guild.Roster.Detail.StatusSignals a change in a guildmember's status.
Event.Guild.Roster.Detail.ZoneSignals a change in a guildmember's zone.
Event.Guild.Roster.RemoveSignals a player removed from the guild roster.
Event.Guild.WallSignals incoming guild wall data. Can be triggered manually with Command.Guild.Wall.Request().
Inspect.Guild.Bank.CoinfunctionReturns the amount of money contained within the guild bank.
Inspect.Guild.Bank.DetailfunctionProvides detailed information about guild bank vaults.
Inspect.Guild.Bank.ListfunctionReturns a table of all available guild bank vaults.
Inspect.Guild.MotdfunctionReturns the current guild Message of the Day.
Inspect.Guild.Rank.DetailfunctionProvides detailed information about guild ranks.
Inspect.Guild.Rank.ListfunctionLists available guild ranks.
Inspect.Guild.Roster.DetailfunctionProvides detailed information about guildmembers.
Inspect.Guild.Roster.ListfunctionLists guildmembers.

Command.Guild.Bank.Deposit

Deposits money into the guild bank.

Usage:

Interaction category: guildbank

Throttled.

Command.Guild.Bank.Deposit(coin)
Command.Guild.Bank.Deposit(coin, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
coinparameternumberThe 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.

Command.Guild.Bank.Purchase()
Command.Guild.Bank.Purchase(callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA 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.

Command.Guild.Bank.Withdraw(coin)
Command.Guild.Bank.Withdraw(coin, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
coinparameternumberThe string "coin", used as a value to request the player's money.

Command.Guild.Log.Request

Requests a guild log event.

Usage:

Command.Guild.Log.Request()
Command.Guild.Log.Request(callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA 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.

Command.Guild.Motd(motd)
Command.Guild.Motd(motd, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
motdparameterstringThe new Message of the Day.

Command.Guild.Roster.Demote

Demotes a guildmember by one rank.

Usage:

Throttled.

Command.Guild.Roster.Demote(member)
Command.Guild.Roster.Demote(member, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
memberparameterstringThe guildmember to target.

Command.Guild.Roster.Kick

Kicks a guildmember from the guild.

Usage:

Throttled.

Command.Guild.Roster.Kick(member)
Command.Guild.Roster.Kick(member, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
memberparameterstringThe guildmember to target.

Command.Guild.Roster.Note

Changes your guild note.

Usage:

Throttled.

Command.Guild.Roster.Note(note)
Command.Guild.Roster.Note(note, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
noteparameterstringThe new note.

Command.Guild.Roster.NoteOfficer

Changes a guildmember's officer note.

Usage:

Throttled.

Command.Guild.Roster.NoteOfficer(member, note)
Command.Guild.Roster.NoteOfficer(member, note, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
memberparameterstringThe guildmember to target.
noteparameterstringThe new note.

Command.Guild.Roster.Promote

Promotes a guildmember by one rank.

Usage:

Throttled.

Command.Guild.Roster.Promote(member)
Command.Guild.Roster.Promote(member, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
memberparameterstringThe guildmember to target.

Command.Guild.Wall.Delete

Deletes an entry from the guild wall.

Usage:

Throttled.

Command.Guild.Wall.Delete(wall)
Command.Guild.Wall.Delete(wall, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
wallparameterguildwallThe ID of the target wall post.

Command.Guild.Wall.Post

Posts an entry to the guild wall.

Usage:

Throttled.

Command.Guild.Wall.Post(post)
Command.Guild.Wall.Post(post, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
postparameterstringThe item to post.

Command.Guild.Wall.Request

Requests a guild wall event.

Usage:

Command.Guild.Wall.Request()
Command.Guild.Wall.Request(callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA 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:

Event.Guild.Bank.Change(vaults)
ParameterTypeDatatypeDescription
vaultsparametervariantA lookup table of vaults that have changed.

Event.Guild.Bank.Coin

Signals a change in the guild bank's money.

Usage:

Event.Guild.Bank.Coin(coin)
ParameterTypeDatatypeDescription
coinparametervariantThe 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:

Event.Guild.Log(log)
ParameterTypeDatatypeDescription
logparametervariantAn 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:

Event.Guild.Motd(motd)
ParameterTypeDatatypeDescription
motdparametervariantThe new Message of the Day.

Event.Guild.Rank

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

Usage:

Event.Guild.Rank(ranks)
ParameterTypeDatatypeDescription
ranksparametervariantA lookup table of ranks that have changed.

Event.Guild.Roster.Add

Signals a new player added to the guild roster.

Usage:

Event.Guild.Roster.Add(add)
ParameterTypeDatatypeDescription
addparametervariantThe name of the added guildmember.

Event.Guild.Roster.Detail.Level

Signals a change in a guildmember's level.

Usage:

Event.Guild.Roster.Detail.Level(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable 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:

Event.Guild.Roster.Detail.Note(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable 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:

Event.Guild.Roster.Detail.NoteOfficer(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable 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:

Event.Guild.Roster.Detail.Rank(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable 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:

Event.Guild.Roster.Detail.Status(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable 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:

Event.Guild.Roster.Detail.Zone(units)
ParameterTypeDatatypeDescription
unitsparametervariantTable 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:

Event.Guild.Roster.Remove(remove)
ParameterTypeDatatypeDescription
removeparametervariantThe name of the removed guildmember.

Event.Guild.Wall

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

Usage:

Event.Guild.Wall(wall)
ParameterTypeDatatypeDescription
wallparametervariantAn 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

coin = Inspect.Guild.Bank.Coin()
ParameterTypeDatatypeDescription
coinresultnumberThe current money in the guild bank, in silver.

Inspect.Guild.Bank.Detail

Provides detailed information about guild bank vaults.

Usage:

detail = Inspect.Guild.Bank.Detail(guildvault)
details = Inspect.Guild.Bank.Detail(guildvaults)
ParameterTypeDatatypeDescription
guildvaultparameterslotA slot specifier representing the entire guild bank vault to retrieve information for.
guildvaultsparametertableA table of slot specifiers, each representing an entire guild bank vault, to retrieve information for.
detailresulttableDetail table for a guild bank vault.
detailsresulttableDetail 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:

list = Inspect.Guild.Bank.List()
ParameterTypeDatatypeDescription
listresulttableAll available guild vaults, in {id = name} format.

Inspect.Guild.Motd

Returns the current guild Message of the Day.

Usage:

motd = Inspect.Guild.Motd()
ParameterTypeDatatypeDescription
motdresultstringThe current Message of the Day.

Inspect.Guild.Rank.Detail

Provides detailed information about guild ranks.

Usage:

detail = Inspect.Guild.Rank.Detail(guildrank)
details = Inspect.Guild.Rank.Detail(guildranks)
ParameterTypeDatatypeDescription
guildrankparameterguildrankThe identifier of the rank to retrieve detail for.
guildranksparametertableA table of identifiers of ranks to retrieve detail for.
detailresulttableDetail table for a single rank.
detailsresulttableDetail 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:

list = Inspect.Guild.Rank.List()
ParameterTypeDatatypeDescription
listresulttableA 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:

detail = Inspect.Guild.Roster.Detail(guildmember)
details = Inspect.Guild.Roster.Detail(guildmembers)
ParameterTypeDatatypeDescription
guildmemberparameterstringThe name of the guildmember to retrieve data for.
guildmembersparametertableA table of names of guildmembers to retrieve data for.
detailresulttableDetail table for a single guildmember.
detailsresulttableDetail 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:

list = Inspect.Guild.Roster.List()
ParameterTypeDatatypeDescription
listresulttableA table listing all your guildmembers. The key is the guildmember's name, the value is the guildmember's status.

Back to index...