Controls the flashing of the Rift taskbar icon.
Usage:
Command.System.Flash(flash) |
Parameter | Type | Datatype | Description |
flash | parameter | boolean | Whether the taskbar icon should flash or not. |
Puts the environment into Strict mode. In Strict mode, deprecated functions and events will throw errors instead of functioning normally.
Usage:
Begin recording Rift UI textures. The texture list will be transmitted via Event.System.Texture during the logout sequence. Note that this flag persists through character selection and cannot be disabled without restarting the client.
Usage:
Command.System.Texture.Record() |
Significantly increases the time required for the watchdog to generate warnings. Intended for bootup processes or similar long startup sequences that will not adversely affect the player experience. This function may not be called in combat.
Usage:
Command.System.Watchdog.Quiet() |
Signals that an addon error has occurred. To prevent infinite loops, errors in handlers for this event may not result in further events being triggered.
Usage:
Event.System.Error(error) |
Parameter | Type | Datatype | Description |
error | parameter | variant | Table containing error data. |
- members
-
addon |
The identifier of the responsible addon. Used in error types event, frameEvent, dispatch, fileNotFound, fileLoad, fileRun, perfWarning, perfError, text, and requirement.
|
axis |
The axis influenced by the error. Used in error types layoutLoop and layoutError.
|
deprecation |
Indicates that the error was caused by attempted use of deprecated functionality. May appear in error types event, frameEvent, script, dispatch, queue, callback, or fileRun.
|
error |
The actual error message generated. Used in error types event, frameEvent, script, dispatch, fileLoad, fileRun, and text.
|
event |
The name of the event responsible. Used in error types event, frameEvent, and internal.
|
file |
The name of the file responsible. Used in error types fileNotFound, fileLoad, and fileRun.
|
frame |
The name of the frame that the event was generated on. Used in error type frameEvent.
|
id |
The internal ID of this error.
|
info |
The info string provided as part of the event handler. Used in error types event, dispatch, perfWarning, perfError, and requirement.
|
script |
The exact script entered by the user. Used in error type script.
|
stacktrace |
The stacktrace at the point of the error. Used in error types event, frameEvent, script, dispatch, fileRun, layoutLoop, layoutError, perfWarning, perfError, text, and requirement.
|
type |
Error type. "event" indicates an error within a global event handler. "frameEvent" indicates an error within a frame event handler. "script" indicates an error within a user-entered /script. "dispatch" indicates an error within a Utility.Dispatch handler. "internal" indicates an error within Rift's code (hopefully you'll never see this). "fileNotFound" indicates a missing file when attempting to load an addon. "fileLoad" indicates a parse failure when attempting to load an addon. "fileRun" indicates an execution error when attempting to load an addon. "layoutLoop" indicates a dependency loop found when evaluating the layout. "layoutError" indicates an invalid position found when evaluating the layout. "perfWarning" indicates a watchdog performance warning. "perfError" indicates a watchdog performance error, and that the Lua thread may have been interrupted. "text" indicates an error in Lua code embedded in HTML text. "requirement" indicates an error caused by not fulfilling function requirements.
|
Signals that the system is entering Secure mode. Usually this is equivalent to entering combat. Functions that may not be called in Secure mode will be locked after this event is complete.
Usage:
Event.System.Secure.Enter() |
Signals that the system is leaving Secure mode. Usually this is equivalent to leaving combat. Functions that may not be called in Secure mode are unlocked just before this event fires.
Usage:
Event.System.Secure.Leave() |
Signals information on Rift UI textures that have been seen.
Usage:
Event.System.Texture(textures) |
Parameter | Type | Datatype | Description |
textures | parameter | variant | A lookup table of all textures that has been seen since the last event. |
Signals the beginning of a frame render. This is your last chance to make UI changes for this frame.
Usage:
Event.System.Update.Begin() |
Signals the end of a frame render.
Usage:
Event.System.Update.End() |
Provides detailed information about an addon error.
Usage:
detail = Inspect.System.Error.Detail(error) |
details = Inspect.System.Error.Detail(errors) |
Parameter | Type | Datatype | Description |
error | parameter | error | The error to be inspected. |
errors | parameter | table | A table of errors to retrieve detail for. |
detail | result | table | Detail table for a single error. Member documentation can be found in Event.System.Error. |
details | result | table | Detail tables for all requested errors. |
Returns the client's current language.
Usage:
language = Inspect.System.Language() |
Parameter | Type | Datatype | Description |
language | result | string | Current language. Valid values include "English", "French", "German", "Korean", "Russian", "Chinese", and "Taiwanese". |
Returns the client's current secure mode.
Usage:
secure = Inspect.System.Secure() |
Parameter | Type | Datatype | Description |
secure | result | boolean | The current secure mode. |
Returns information on the client version.
Usage:
version = Inspect.System.Version() |
Parameter | Type | Datatype | Description |
version | result | table | A table containing detailed version information. |
- members
-
build |
Client build information.
|
external |
Client external version.
|
internal |
Client internal version.
|
Returns the number of seconds until the system watchdog may begin generating warnings.
Usage:
time = Inspect.System.Watchdog() |
Parameter | Type | Datatype | Description |
time | result | number | Time left in seconds. |