API Docs (pts)

Back to index...

Name	Type	Description
Command.Console.Display	function	Prints a line of text in a console window of your choice. Note that the line length is limited, i...
Inspect.Console.Detail	function	Provides detailed information about consoles.
Inspect.Console.List	function	Returns a table of the current open text consoles.

Command.Console.Display

Prints a line of text in a console window of your choice. Note that the line length is limited, including HTML tags.

Usage:

Parameter	Type	Datatype	Description
Command.Console.Display(console, suppressPrefix, text, html)
console	parameter	console	The console to display text into. May be "general", "combat", or a console ID.
html	parameter	boolean	Enables HTML mode. In HTML mode, a limited number of formatting tags are available: <u>, <font color="#rrggbb">, and <a lua="print('This is a lua script.')">.
suppressPrefix	parameter	boolean	Suppress the automatic addon shortname prefix.
text	parameter	string	The text to be printed.

Inspect.Console.Detail

Provides detailed information about consoles.

Usage:

Parameter	Type	Datatype	Description
detail = Inspect.Console.Detail(console)
details = Inspect.Console.Detail(consoles)
console	parameter	console	The identifier of the console to retrieve information for. May also be "general" or "combat".
consoles	parameter	table	A table of consoles to retrieve detail for.
detail	result	table	Detail table for a single console.
details	result	table	Detail tables for all requested consoles.

members

accolade	Indicates that this console displays Accolade messages.
achievement	Indicates that this console displays Achievement messages.
channel	May contain a table of public channels that this console will display. nil if the console does not display any public channels.
combatBad	Indicates that this console displays Combat Bad messages.
combatGood	Indicates that this console displays Combat Good messages.
combatNeutral	Indicates that this console displays Combat Neutral messages.
combatOther	Indicates that this console displays Combat Other messages.
combatSpecial	Indicates that this console displays Combat Special messages.
craftingOther	Indicates that this console displays Crafting Others messages.
craftingSelf	Indicates that this console displays Crafting Self messages.
emote	Indicates that this console displays Emote messages.
experience	Indicates that this console displays Experience messages.
guild	Indicates that this console displays Guild messages.
id	The ID of the requested element.
lootGroup	Indicates that this console displays Group Loot messages.
lootItem	Indicates that this console displays Item Loot messages.
lootMoney	Indicates that this console displays Money Loot messages.
name	The player-chosen name of the console.
notoriety	Indicates that this console displays Notoriety messages.
npc	Indicates that this console displays NPC messages.
officer	Indicates that this console displays Officer messages.
party	Indicates that this console displays Party messages.
purchase	Indicates that this console displays Purchase messages.
raid	Indicates that this console displays Raid messages.
raidWarning	Indicates that this console displays Raid Warning messages.
say	Indicates that this console displays Say messages.
skill	Indicates that this console displays Skill messages.
system	Indicates that this console displays System messages.
tell	Indicates that this console displays Tell messages.
twitter	Indicates that this console displays Twitter messages.
yell	Indicates that this console displays Yell messages.

Inspect.Console.List

Returns a table of the current open text consoles.

Usage:

Parameter	Type	Datatype	Description
consoles = Inspect.Console.List()
consoles	result	table	A table containing the IDs of the available consoles.