API Docs (pts)

Back to index...

Name	Type	Description
Command.Social.Friend.Add	function	Adds a player to your friend list.
Command.Social.Friend.Note	function	Changes a friend's personal note.
Command.Social.Friend.Remove	function	Removes a player from your friend list.
Command.Social.Ignore.Add	function	Adds an player to your ignore list.
Command.Social.Ignore.Note	function	Changes an ignored player's personal note.
Command.Social.Ignore.Remove	function	Removes a player from your ignore list.
Event.Social.Friend		Signals a change in your friend list.
Event.Social.Ignore		Signals a change in your ignore list.
Inspect.Social.Friend.Detail	function	Provides detailed information about a friend.
Inspect.Social.Friend.List	function	Lists the player's current friends.
Inspect.Social.Ignore.Detail	function	Provides detailed information about an ignored player.
Inspect.Social.Ignore.List	function	Lists the player's current ignored players.

Command.Social.Friend.Add

Adds a player to your friend list.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Social.Friend.Add(name)
name	parameter	string	The name of the friend.

Command.Social.Friend.Note

Changes a friend's personal note.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Social.Friend.Note(name, note)
name	parameter	string	The name of the friend.
note	parameter	string	The new personal note.

Command.Social.Friend.Remove

Removes a player from your friend list.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Social.Friend.Remove(name)
name	parameter	string	The name of the friend.

Command.Social.Ignore.Add

Adds an player to your ignore list.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Social.Ignore.Add(name)
name	parameter	string	The name of the ignored player.

Command.Social.Ignore.Note

Changes an ignored player's personal note.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Social.Ignore.Note(name, note)
name	parameter	string	The name of the ignored player.
note	parameter	string	The new personal note.

Command.Social.Ignore.Remove

Removes a player from your ignore list.

Usage:

Throttled.

Parameter	Type	Datatype	Description
Command.Social.Ignore.Remove(name)
name	parameter	string	The name of the ignored player.

Event.Social.Friend

Signals a change in your friend list.

Usage:

Parameter	Type	Datatype	Description
Event.Social.Friend(friends)
friends	parameter	variant	A lookup table containing the changed friends.

Event.Social.Ignore

Signals a change in your ignore list.

Usage:

Parameter	Type	Datatype	Description
Event.Social.Ignore(ignores)
ignores	parameter	variant	A lookup table containing the changed ignored players.

Inspect.Social.Friend.Detail

Provides detailed information about a friend.

Usage:

Parameter	Type	Datatype	Description
detail = Inspect.Social.Friend.Detail(friend)
details = Inspect.Social.Friend.Detail(friends)
friend	parameter	string	The name of a friend to retrieve detail for.
friends	parameter	table	A table of names of friends to retrieve detail for.
detail	result	table	Detail table for a single friend.
details	result	table	Detail 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:

Parameter	Type	Datatype	Description
friends = Inspect.Social.Friend.List()
friends	result	table	A table containing the player's current friends.

Inspect.Social.Ignore.Detail

Provides detailed information about an ignored player.

Usage:

Parameter	Type	Datatype	Description
detail = Inspect.Social.Ignore.Detail(ignore)
details = Inspect.Social.Ignore.Detail(ignores)
ignore	parameter	string	The name of an ignored player to retrieve detail for.
ignores	parameter	table	A table of names of ignored players to retrieve detail for.
detail	result	table	Detail table for a single ignored player.
details	result	table	Detail 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:

Parameter	Type	Datatype	Description
ignores = Inspect.Social.Ignore.List()
ignores	result	table	A table containing the player's current ignored players.