Back to index...

NameTypeDeprecatedSecureDescription
Command.Social.Friend.AddfunctionAdds a player to your friend list.
Command.Social.Friend.NotefunctionChanges a friend's personal note.
Command.Social.Friend.RemovefunctionRemoves a player from your friend list.
Command.Social.Ignore.AddfunctionAdds an player to your ignore list.
Command.Social.Ignore.NotefunctionChanges an ignored player's personal note.
Command.Social.Ignore.RemovefunctionRemoves a player from your ignore list.
Event.Social.FriendSignals a change in your friend list.
Event.Social.IgnoreSignals a change in your ignore list.
Inspect.Social.Friend.DetailfunctionProvides detailed information about a friend.
Inspect.Social.Friend.ListfunctionLists the player's current friends.
Inspect.Social.Ignore.DetailfunctionProvides detailed information about an ignored player.
Inspect.Social.Ignore.ListfunctionLists the player's current ignored players.

Command.Social.Friend.Add

Adds a player to your friend list.

Usage:

Throttled.

Command.Social.Friend.Add(name)
ParameterTypeDatatypeDescription
nameparameterstringThe name of the friend.

Command.Social.Friend.Note

Changes a friend's personal note.

Usage:

Throttled.

Command.Social.Friend.Note(name, note)
ParameterTypeDatatypeDescription
nameparameterstringThe name of the friend.
noteparameterstringThe new personal note.

Command.Social.Friend.Remove

Removes a player from your friend list.

Usage:

Throttled.

Command.Social.Friend.Remove(name)
ParameterTypeDatatypeDescription
nameparameterstringThe name of the friend.

Command.Social.Ignore.Add

Adds an player to your ignore list.

Usage:

Throttled.

Command.Social.Ignore.Add(name)
ParameterTypeDatatypeDescription
nameparameterstringThe name of the ignored player.

Command.Social.Ignore.Note

Changes an ignored player's personal note.

Usage:

Throttled.

Command.Social.Ignore.Note(name, note)
ParameterTypeDatatypeDescription
nameparameterstringThe name of the ignored player.
noteparameterstringThe new personal note.

Command.Social.Ignore.Remove

Removes a player from your ignore list.

Usage:

Throttled.

Command.Social.Ignore.Remove(name)
ParameterTypeDatatypeDescription
nameparameterstringThe name of the ignored player.

Event.Social.Friend

Signals a change in your friend list.

Usage:

Event.Social.Friend(friends)
ParameterTypeDatatypeDescription
friendsparametervariantA lookup table containing the changed friends.

Event.Social.Ignore

Signals a change in your ignore list.

Usage:

Event.Social.Ignore(ignores)
ParameterTypeDatatypeDescription
ignoresparametervariantA lookup table containing the changed ignored players.

Inspect.Social.Friend.Detail

Provides detailed information about a friend.

Usage:

detail = Inspect.Social.Friend.Detail(friend)
details = Inspect.Social.Friend.Detail(friends)
ParameterTypeDatatypeDescription
friendparameterstringThe name of a friend to retrieve detail for.
friendsparametertableA table of names of friends to retrieve detail for.
detailresulttableDetail table for a single friend.
detailsresulttableDetail tables for all requested friends.
members
calling The friend's calling, if known.
guild The friend's current guild.
id The ID of the requested element.
level The friend's current level, if known.
name The friend's name.
note The friend's personal note.
race The friend's race, if known.
status The friend's status. Either "online", "afk", or nil.
zone The friend's current zone, if known.

Inspect.Social.Friend.List

Lists the player's current friends.

Usage:

friends = Inspect.Social.Friend.List()
ParameterTypeDatatypeDescription
friendsresulttableA table containing the player's current friends.

Inspect.Social.Ignore.Detail

Provides detailed information about an ignored player.

Usage:

detail = Inspect.Social.Ignore.Detail(ignore)
details = Inspect.Social.Ignore.Detail(ignores)
ParameterTypeDatatypeDescription
ignoreparameterstringThe name of an ignored player to retrieve detail for.
ignoresparametertableA table of names of ignored players to retrieve detail for.
detailresulttableDetail table for a single ignored player.
detailsresulttableDetail tables for all requested ignored players.
members
id The ID of the requested element.
name The ignored player's name.
note The ignored player's personal note.

Inspect.Social.Ignore.List

Lists the player's current ignored players.

Usage:

ignores = Inspect.Social.Ignore.List()
ParameterTypeDatatypeDescription
ignoresresulttableA table containing the player's current ignored players.

Back to index...