API Docs (pts)

Back to index...

Name	Type	Description
Event.Addon.Load.Begin		Signals the beginning of an addon's loading sequence.
Event.Addon.Load.End		Signals the end of an addon's loading sequence. At this point, that addon is fully loaded and ini...
Event.Addon.SavedVariables.Load.Begin		Signals the beginning of an addon's saved variable loading.
Event.Addon.SavedVariables.Load.End		Signals the end of an addon's saved variable load.
Event.Addon.SavedVariables.Save.Begin		Signals the beginning of an addon's saved variable saving.
Event.Addon.SavedVariables.Save.End		Signals the end of an addon's saved variable saving.
Event.Addon.Shutdown.Begin		Signals the beginning of the shutdown sequence.
Event.Addon.Shutdown.End		Signals the end of the shutdown sequence. This is the last event that will be sent.
Event.Addon.Startup.End		Signals the end of the startup sequence. At this point, all addons are fully loaded and initialized.
Inspect.Addon.Cpu	function	Returns recent CPU usage information. This is calculated using an exponential-falloff method.
Inspect.Addon.Current	function	Returns the current addon. This information is used internally for counting CPU usage and determi...
Inspect.Addon.Detail	function	Provides detailed information about loaded addons.
Inspect.Addon.List	function	Lists all the addons that the client has loaded.

Event.Addon.Load.Begin

Signals the beginning of an addon's loading sequence.

Usage:

Parameter	Type	Datatype	Description
Event.Addon.Load.Begin(addonidentifier)
addonidentifier	parameter	variant	The addon's identifier.

Event.Addon.Load.End

Signals the end of an addon's loading sequence. At this point, that addon is fully loaded and initialized.

Usage:

Parameter	Type	Datatype	Description
Event.Addon.Load.End(addonidentifier)
addonidentifier	parameter	variant	The addon's identifier.

Event.Addon.SavedVariables.Load.Begin

Signals the beginning of an addon's saved variable loading.

Usage:

Parameter	Type	Datatype	Description
Event.Addon.SavedVariables.Load.Begin(addonidentifier)
addonidentifier	parameter	variant	The addon's identifier.

Event.Addon.SavedVariables.Load.End

Signals the end of an addon's saved variable load.

Usage:

Parameter	Type	Datatype	Description
Event.Addon.SavedVariables.Load.End(addonidentifier)
addonidentifier	parameter	variant	The addon's identifier.

Event.Addon.SavedVariables.Save.Begin

Signals the beginning of an addon's saved variable saving.

Usage:

Parameter	Type	Datatype	Description
Event.Addon.SavedVariables.Save.Begin(addonidentifier)
addonidentifier	parameter	variant	The addon's identifier.

Event.Addon.SavedVariables.Save.End

Signals the end of an addon's saved variable saving.

Usage:

Parameter	Type	Datatype	Description
Event.Addon.SavedVariables.Save.End(addonidentifier)
addonidentifier	parameter	variant	The addon's identifier.

Event.Addon.Shutdown.Begin

Signals the beginning of the shutdown sequence.

Usage:

Event.Addon.Shutdown.Begin()

Event.Addon.Shutdown.End

Signals the end of the shutdown sequence. This is the last event that will be sent.

Usage:

Event.Addon.Shutdown.End()

Event.Addon.Startup.End

Signals the end of the startup sequence. At this point, all addons are fully loaded and initialized.

Usage:

Event.Addon.Startup.End()

Inspect.Addon.Cpu

Returns recent CPU usage information. This is calculated using an exponential-falloff method.

Usage:

Parameter	Type	Datatype	Description
data = Inspect.Addon.Cpu()
data	result	table	Recent CPU usage. This takes the format { AddonIdentifier = { SubIdentifier = cpu_used_as_a_fraction_of_one } }. SubIdentifiers are generated by Rift and the format may change without notice.

Inspect.Addon.Current

Returns the current addon. This information is used internally for counting CPU usage and determining frame ownership.

Usage:

Parameter	Type	Datatype	Description
addonIdentifier = Inspect.Addon.Current()
addonIdentifier	result	string	The addon's identifier, as written in its TOC file.

Inspect.Addon.Detail

Provides detailed information about loaded addons.

Usage:

Parameter	Type	Datatype	Description
detail = Inspect.Addon.Detail(addon)
details = Inspect.Addon.Detail(addons)
addon	parameter	string	An addon identifier.
addons	parameter	table	A table containing addon identifiers.
detail	result	table	Detail table for a single addon.
details	result	table	Detail tables for all requested addons. The key is the addon identifier, the value is the addon's detail table.

members

data	The "data" table provided to the addon at load time.
description	The chosen localization of the TOC Description field.
id	The ID of the requested element.
identifier	The addon's identifier.
name	The chosen localization of the TOC Name field.
nameShort	The chosen localization of the TOC NameShort field.
toc	The addon's RiftAddon.toc file, parsed and in table form.

Inspect.Addon.List

Lists all the addons that the client has loaded.

Usage:

Parameter	Type	Datatype	Description
addons = Inspect.Addon.List()
addons	result	table	Map of addon identifier to addon version, or "true" if no version is provided.