RDX/VFL API

From The OpenRDX Project Wiki

Jump to: navigation, search

Contents

RDX & VFL API Index

This List is fairly complete but I'm sure I've missed a few. You can use any command NOT preceded by local, simply by typing /script before them. This page houses a little over 1250 API commands and can take a while to load sometimes. Please add any commands you find missing.

-fridg

[edit] RDX

General uncategorized RDX API.

RDX.AddToolbarButton (button, width) Add a button to the RDX Encounter Pane Toolbar. If the width argument is true , autosets the width of the button.
RDX.AnnounceOff () Turns raid announce off.
RDX.AnnounceOn () Turns raid announce on.
RDX.AnnounceToggle () Toggles raid announce on and off.
RDX.ApplyBossmods () Register the encounters from bossmod objects inside the RDX filesystem.
RDX.BossmodEditor (state, callback, augText) Creates an instance of the Bossmod Editor.
RDX.BossmodState:new () The universal bossmod state.
RDX.CreateLogisticsWindow (id, title, repaint, width, t1width) Create a new logistics window with the given ID and title.
RDX.CloseRosterWindow () Closes the RDX raid roster window.
RDX.ForeachInObject (path, function) Executes the given Lua function on each unit from the given set. If the function returns nil at any time, the loop is aborted. Returns the unit for which func returned nil, if any.
RDX.GetEncounterPane () Returns the encounter pane.
RDX.GenerateUniqueID () Returns a random number between 1 and 10 million.
RDX.GetFirstUnitInObject (path) Return the RDX Unit object of the first member of the sort at the given path. Will also accept sets, but if a set is provided, ordering is obviously not guaranteed.
RDX.GetObjectIterator (path) Gets an iterator over the iterable object (Set or Sort) at the given path.
RDX.GetSort (path) Get an up-to-date Sort from the given path.
RDX.IsBossmodEditorOpen () Return the handle of the bossmod editor (really the feature editor) frame if its open, nil if otherwise. Same command as RDX.IsFeatureEditorOpen.
RDX.IsInitialized () Return TRUE if all RDX initialization procedures are complete.
RDX.Maximize () Maximizes the Encounter Pane to its normal state.
RDX.Minimize () Minimizes the Encounter Pane into a minimap button.
RDX.NthInSort (path, n, constrain) Gets the n'th member of the given sort.
RDX.OpenRosterWindow () Opens the RDX raid roster window.
RDX.RegisterSlashCommand (name, function) Registers the given name as a RDX slash command to call the given function.
RDX.RunScript (path) Executes the script object at the given path.
RDX.SelectDesktop (path) Make the desktop at the given path the current desktop.
RDX.print (test) Print selected text into the default chat frame. Same as VFL.print except it adds a color coded RDX: prefix.

[edit] Alerts

Functions for dealing with the RDX alert system.

RDX.Alert:new () Create a new alert.
RDX.Alert.CenterPopup (id, text, time, sound, flashTime, color1, color2, suppressSpam) Center popup countdown alert. This alert plays a sound right away, then displays a cooldown midscreen.
RDX.Alert.Countdown (alert, dt, fdt, color1, color2) Start a countdown timer on this alert. It will countdown from dt seconds, beginning to flash at fdt seconds, and flashing between color1 and color2.
RDX.Alert.DefaultStyle (alert, w, h, noTimer) The default alert style (RDX5-ish).
RDX.Alert.Dropdown (id, text, totalTime, leadTime, sound, c1, c2, suppressSpam) Dropdown alert. Starts at the top of the screen, moves to the middle when time grows short.
RDX.Alert.Fade (alert, dt, a1) Fade the alert over dt seconds from its current alpha level to alpha level a1.
RDX.Alert.Move (alert, point, dt, x, y, a, s) Move the alert linearly through (x, y, alpha, scale) space from its current point to the given destination point over dt seconds.
RDX.Alert.QuashAlertsByPattern (pattern) Quash all alerts matching the given pattern.
RDX.Alert.RaidChat (text) Sends the message over RAID or PARTY is applicable.
RDX.Alert.RemoveFromStacks (alert)
RDX.Alert.Simple (text, sound, persist, supressSpam)
RDX.Alert.Sound (sound) Plays a sound.
RDX.Alert.Spam (text) Sends alert messages over RAID_WARNING if leader, RAID if not, or PARTY depending on which kind of group you are in.
RDX.Alert.ToTop (alert, animTime)
RDX.Alert.ToBottom (alert, animTime)

[edit] Bossmods

Various API's and trackers for the RDX bossmods system.

RDXBM._GetEventCache (encounterID, BossmodEvents)
RDXBM.BindAbilityEvents (encounterID, BossmodEvents)
RDXBM.BindMsgEvents (encounterID, BossmodEvents)
RDXBM.CloseTrackerWindow ()
RDXBM.CreateEventEdit (parent, text)
RDXBM.EventCachePopup (db, callback, frame, point, dx, dy)
RDXBM.EventIsLocal (event, state)
RDXBM.GetAbilityInfo (ability)
RDXBM.GetAbilityList (mobname)
RDXBM.GetAbilityTable (mobname, ability)
RDXBM.GetBossmodDT (encounterid)
RDXBM.GetbmState ()
RDXBM.GetMobList ()
RDXBM.GetMobTable (mobname)
RDXBM.GetUniqueAlertID () Simple incrementor to allow for unique alert tracking.
RDXBM.SetTrackerWindow ()
RDXBM.ToggleTrackerWindow ()

[edit] Debug

Debugging functionality for RDX6.

RDXM_Debug.SetDebugger () Show the set debugger.
RDXM_Debug.StoreCompiledObject (key, value)


[edit] Encounters

Encounter API for bossmods.

RDX.ActivateEncounter (encounter)
RDX.DeactivateEncounter (encounter)
RDX.GetActiveEncounter (encounter) Gets the name of the currently active encounter.
RDX.IsRunning () Return TRUE iff the current encounter is running, nil outherwise.
RDX.RegisterEncounter ({name; title}) Registers an encounter in the RDX encounter database.
RDX.RegisterMouseoverEncounterTrigger (target, encounterid)
RDX.SetActiveEncounter (encounter, nosync) Change the currently-active encounter.
RDX.StartEncounter (nosync) Start the current encounter.
RDX.StartOrStopEncounter () Stop the encounter if it's running, or start it if it isn't.
RDX.StopEncounter (nosync) Stop the current encounter.
RDX.SyncEncounter (encounter) Synchronize the current encounter.
RDX.UnregisterEncounter (encounter) Remove an encounter previously added with RegisterEncounter.

[edit] Events

These are really VFL functions that output into the RDXEvents dispatch table. See RDX/VFL_API

RDXEvents:Bind (key, object, method, id) Shortcut to DispatchPrototype:Bind.
RDXEvents:Dispatch (key, ...) Shortcut to DispatchPrototype:Dispatch.
RDXEvents:DeleteKey (key) Shortcut to DispatchPrototype:DeleteKey.
RDXEvents:LockSignal (key) Shortcut to DispatchPrototype:LockSignal.
RDXEvents:Unbind (id, event) Shortcut to DispatchPrototype:Unbind.

[edit] HealSync

HealSync._GetDirectHeals ()
HealSync.AddHealValueDataPoint (spell, rank, value) Adds a data point to the heal values database.
HealSync.AddHot (id, spell, timer)
HealSync.GetHealCastTime (spell) Get the casting time for a heal.
HealSync.GetHealValue (spell, rank) Get the expected average value of the given heal.
HealSync.IsDirectHeal (spell) Healing metadata.
HealSync.RegisterDirectHealSpell (spell) Healing metadata.
HealSync.SetHealCasttime (spell, time)
HealSync.SetHealingWindowTarget (unit)
IncHealGrid_AcqCell (grid, dx, dy) Acquire a cell for the inc. heal grid.
RDX.GetIncHealSet (name) Get a set of the healers healing the given target.
RDX.Unit._AddIncHeal ()
RDX.Unit._AdjustIncHeals ()
RDX.Unit._CountIncHeals ()
RDX.Unit._Healers ()
RDX.Unit._HealersNIDHash ()
RDX.Unit._IterateIncHeals ()
RDX.Unit._StopIncHeal ()
RDX.Unit.IncomingHealth ()
RDX.Unit:AllSmartHealth ()
RDX.Unit:FracSmartHealth () Returns unit fractional health plus predicted fractional incoming health.
RDX.Unit:SmartHealth () Returns unit health plus predicted incoming health.

[edit] HOT

Higher-Order Targeting, commands used to track units via their 'target' unit tags.

RDX.AutoStartEncounter (tracer) Automatically start the encounter based on the results of the given tracer.
RDX.AutoStartStopEncounter (tracer) Automatically start/stop the encounter based on the results of the given tracer.
RDX.AutoUpdateEncounterPane (tracer, lockedName) Automatically start the encounter based on the results of the given tracer.
HOT.BuildTraceFunction (condition)
HOT.NewTraceCondition ()
HOT.TraceLevel (condition, level)
HOT.TraceName (condition, name)
HOT.Tracer:new (tracefunction) Create a new tracer for the given dataset.
HOT.Tracer:Close () Close a tracer previously Opened.
HOT.Tracer:Execute () Execute this tracer.
HOT.Tracer:First ()
HOT.Tracer:FirstProto ()
HOT.Tracer:NumMatches ()
HOT.Tracer:OnAcquire (function)
HOT.Tracer:OnTrace (function)
HOT.Tracer:OnLost (function)
HOT.Tracer:Open () Register this tracer to be continually monitored by the system.
HOT.Tracer:ProtoUIDs ()
HOT.Tracer:UIDs ()
HOT.TraceRaidTargetIcon (condition, icon)
HOT.TraceSex (condition, sex)
HOT.TraceUnitSuffix (condition, suffix)
HOT.TrackTarget (name) Returns a Tracer object tracking the given NPC by name.
HOT.TrackRaidIcon (number) Returns a Tracer object tracking the given NPC by raid icon number.

[edit] Logistics

Logistics tools for RDX6.

Logistics._RegisterForUSS (cdef, spell) Externally register a spell for spellcast_succeeded notification.
Logistics.BroadcastCooldown (name, rem, dur) Broadcast the value for a cooldown directly.
Logistics.GetCooldownInfo (name)
Logistics.GetDurability () Durability checking.
Logistics.GetResists () Resist checking.
Logistics.ItemsMatching (regex, tbl) Count items in inventory matching the given regex. Individual matches are stored in the passed table and the total matches found is returned.
Logistics.MakeDetailWindow (fnAD)
Logistics.NewWindow (id, title, repaint, width, t1width) Creates a new logistics window. Shortcut for RDX.CreateLogisticsWindow.
Logistics.PlayerCanRez () Determine if the current player can rez.
Logistics.RegisterCooldown (tbl) Cooldown registration.
Logistics.RegisterQuasiSpellCooldown (name, cdTitle, spell, maxv, icon) QUASISPELL COOLDOWNS; Can be used for items that trigger SPELLCAST_SUCCEEDED.
Logistics.RegisterSpellBasedCooldown (name, spell, maxv, icon) Standard spell-driven cooldowns can use this boilerplate code, which will automatically drive them.
Logistics.UnknownCooldown () Generic unknown value function.

[edit] Menus

Functions for manipulating, displaying, and accessing RDX6 menus and the main menu.

RDX.Menu:New ()
RDX.Menu:Open (tree, frame)
RDX.Menu:RegisterMenuFunction (function)
RDX.Menu:RegisterMenuEntry (title, isSubmenu, function)
RDX.ShowMainMenu () Show the RDx main menu at the current mouse position.

[edit] MultiTrack

Implements a multiple tracker window to show the health bars of a number of tracers. Specifically allows for multiple targets found from one trace (eg, "Flamewalker Elite")

MultiTrack._Disable () Disabled multitrack windows from being showing/used/updated. Note there is not enable function, the main menu simply reveres the variables set by the disabled function. (It stops preventing MultiTrack from opening.)
MultiTrack.Add (tracer) Adds a tracer to the MultiTrack window.
MultiTrack.Close () Closes the MultiTrack window.
MultiTrack.Hide () Hides the MultiTrack window.
MultiTrack.Remove (tracer) Removes a tracer to the MultiTrack window.
MultiTrack.Show () Shows (if hidden) and repaints the MultiTrack window.
MultiTrack.Open () Opens the MultiTrack window if trackers are enabled.

[edit] ObjectManager

Functions and various API for dealing with RDX objects and their features.

RebuildFeatureList () Rebuilds the feature list.
SetActiveType (at)
UpdateTypeList ()
RDX._GetFeatureArray ()
RDX._GetAllFeatures ()
RDX.FeatureEditor (state, callback, augText)
RDX.GetFeatureByDescriptor (descriptor) Get a feature by its feature descriptor.
RDX.GetFeatureByName (name) Get a feature by its name.
RDX.GetObjectData (path) Get the object metadata at the given path, or NIL if it doesn't exist.
RDX.HasFeature (features, feature) Pick a given feature from a list of features.
RDX.IsFeatureEditorOpen () Return the handle of the feature editor frame if its open, nil if otherwise.
RDX.MiniFeatureEditor (parent, featureData, callback, extraInfo) A 'mini feature editor' for editing a saved feature object.
RDX.ObjectState:new (table) An object state is a set of functions and metadata that dictate how and object should be built and updated.
RDX.ObjectState._Attach (slot, hookable, function) See RDX.ObjectState:Attach.
RDX.ObjectState.ClearFeatureList ()
RDX.ObjectState:_GetFeatureByIndex (index) Get a feature by index.
RDX.ObjectState:_ExposeFeatureInSitu (featDesc, feature, errs) Expose a feature in situ.
RDX.ObjectState:_SaveFeatureByIndex (index, featuredata) Save a feature into the given index.
RDX.ObjectState:_SetSlotFunction (name, function) Directly overwrite a slot's function.
RDX.ObjectState:AddFeature (featDesc) Directly add a feature, end-to-end, railroading past all error checking. Call this only if you know what you're doing.
RDX.ObjectState:AddFeatureInSitu (featDesc) Add a feature to the end of this object's feature list.
RDX.ObjectState:AddSlot (name, hookable) Add a slot to this window state. Does nothing if the slot already exists.
RDX.ObjectState:Attach (slot, hookable, function) Directly attach a function to a slot.
RDX.ObjectState:AppendSlotValue (name, x) Append a value to the slots current value.
RDX.ObjectState:ApplySlot (name, hookable) Add a slot to this window state. Does nothing if the slot already exists.
RDX.ObjectState:ApplyAll (errObj) Apply this object's feature list to itself. Must verify first, un-verified features will be auto rejected.
RDX.ObjectState:Assemble (window) Assemble this window state onto a window.
RDX.ObjectState:CheckSlot (name, hookable) Determine if a slot is able to be bound to something, and if its hookable or not.
RDX.ObjectState:Clear () Reset the feature list.
RDX.ObjectState:GetDescriptor () Load a descriptor.
RDX.ObjectState:GetSlotFunction (name) Get a function for the given slot.
RDX.ObjectState:GetSlotValue (name) Get the value of the slot.
RDX.ObjectState:Features () Return the array of features of this state.
RDX.ObjectState:HasFeatureNamed (name) Determine if this ObjectState has a feature, by name.
RDX.ObjectState:HasSlotLike (pattern) Determine if the object has any slot at all matching the given pattern.
RDX.ObjectState:HasSlots (...)
RDX.ObjectState:InSituState (index) Set internal state to the in-situ state of the given index. This basiclly means that all features above the given index will be Exposed, and all features below will be ignored.
RDX.ObjectState:IsFeaturePossible (feature) Determine if a feature is possible on this ObjectState.
RDX.ObjectState:PrependSlotValue (name, x) Prepend a value to the slots current value.
RDX.ObjectState:Rebuild (desc) Completely reload a descriptor, applying all features as well.
RDX.ObjectState:ResetSlots () Reset all the slots of an ObjectState, keeping the features.
RDX.ObjectState:RunSlot (name, ...) Execute the given slot with the given parameters.
RDX.ObjectState:SetSlotValue (name, value) Set a slots value by name.
RDX.ObjectState:Slot (name) Determine if a slot exists on this state.
RDX.ObjectState:SlotsMatching (pattern) Iterate over the slots of an object matching a given pattern.
RDX.ObjectState:Verify (errObj) Verify this object's features by exposing them.
RDX.ObjectState:VerifyAt (index, errs) Verify the feature at the given index.
RDX.RegisterFeature (table) Register a new feature.
RDX.SetFeaturefields (path, feature, ...) Update the fields of a particular feature on a particular file system object.
RDXDB._AccessPathRaw (package, file)
RDXDB._CreateInstance (opath, object) Create an instance, given predefined path and type info. This should only be called after it has been confirmed that an instance doesn't already exist.
RDXDB._DirectCreateObject (package, file) Create an object, overriding most restrictions and bypassing initialization schemes.
RDXDB._EmptyPackage (package) Empty a package.
RDXDB._GetObjectTypes ()
RDXDB._RemoveInstance (path, qq) Removes all traces of the given path from the instance db, forward and reverse.
RDXDB.AccessPath (package, file)
RDXDB.ClearRDXDatabase () Completely clear the RDX database and restart RDX. WARNING: data loss.
RDXDB.CloseExplorerPopup ()
RDXDB.CheckObject (path, type) Check the object at the given path; verify that it exists and matches the given type.
RDXDB.Copy (path, path) Copies a preexisting object.
RDXDB.CopyObject (path, package) Copy an object.
RDXDB.CreateObject (package, name, type) Create a new object at a node where no object is.
RDXDB.CreatePackage (package) Create a package. Returns (nil, error code) on failure.
RDXDB.DeleteObject (path) Delete the object.
RDXDB.DeletePackage (package, force) Delete a package. Fails, returning NIL, if the package is not empty.
RDXDB.EditSymlink (parent, path, md) The 'symlink' object type.
RDXDB.ExplorerInstance:new (parent) An 'instance' of the Explorer that can be specialized for multiple purposes.
dialog:_GetSelection ()
dialog:EnableFeedback (okFunc, cancelFunc)
dialog:GetPath ()
dialog:GetPathRaw ()
dialog:Rebuild ()
dialog:SetFileFilter (function)
dialog:SetPath (initpath)
dialog:SetRightClickFunctions (packageclick, fileclick)
RDXDB.ExplorerPopup (parent)
RDXDB.Foreach (f, ...) Iterate a function over all files.
RDXDB.GetObjectData (path)
RDXDB.GetObjectInstance (path, nocreate) Get an instance of the object at the given path. If the second argument is non-nil, the object will NOT be created if it doesn't already exist.
RDXDB.GetObjectType (ty) Return an object type previously registerd by RegisterObjectType.
RDXDB.GetOrCreatePackage (package) Gets a package's contents, creating it if it doesn't exist.
RDXDB.GetPackage (package) Get a package's contents if it exists; return NIL if it doesn't.
RDXDB.GetPackages () Get the root directory.
RDXDB.GetPackageMetadata (package, field) Get a piece of metadata about a package.
RDXDB.InstanceReverseLookup (instance) "Reverse-lookup" and instance of an object, returning the path it was instantiated from, if possible.
RDXDB.IsExplorerPopupOpen ()
RDXDB.IsObjectBrowserOpen ()
RDXDB.IsValidFileName (name) Notify downstream processes that a file has been updated.
RDXDB.NewObjectDialog (parent, packagename) The new object dialog.
RDXDB.MakePath (package, object)
RDXDB.MoveObject (path, package) Moves and object.
RDXDB.ObjectBrowser (parent, initPath, fileFilter)
RDXDB.ObjectFinder:new() An edit control with file finding capabilities. Supports the DialogOnLayout() hierarchical layout system, and text added to the textbox is utilized as a filter against the filename.
RDXDB.OpenObject (path,op,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) Run and object's Open method if possible. If 'op' is specified, runs that operation instead of the open method, with given args.
RDXDB.PathHasInstance (path) Determine if the given path has an instance.
RDXDB.ParsePath (path)
RDXDB.PackageSelector:new () Single Package selector.
RDXDB.PackageListWindow (parent, title, text, filter, callback) Mass package selector.
RDXDB.RegisterObjectMenuHandler (function) Extend the menu that appears when you right click on an object.
RDXDB.RegisterObjectType {} Register a persistant object type that can be stored in the ObjectDB.
RDXDB.RegisterPackageMenuHandler (function) Extend the menu that appears when you right click on a package.
RDXDB.RenameObject (path, newname) Rename an object.
RDXDB.ResolvePath (path) Resolve a path. If the path points to a symlink, returns the symlink destination, otherwise returns the original path.
RDXDB.SetPackageMetadata (package, field, value) Set a piece of metadata on a package.
RDXDB.SetSymLinkTarget (path, path) Sets arg2 as a symbolic link to arg1.
RDXDB.tmpnam (package)
RDXDB.TouchObject (path) "Touch" an object, returning a direct reference to its contents if we have the ability to update it. Automatically creates it as a typeless object if it doesn't exist. Veni is clearly a unix fan.

[edit] Omniscience

Combat logging and data collection facilities for Project Omniscience.

Omni._Afflicted (abil, stacks) Affliction table for debuff counting.
Omni._ApplyColSpec (cs, row) Apply a column spec to a row.
Omni._ApplyColSpecToList (l, cs) Apply a column spec to a table control.
Omni._ApplyData (tbl, cell, data, pos) Data application function; map a table row onto the display.
Omni._Buffed (abil, stacks)
Omni._CreateCell (ctr, ty) Create a cell.
Omni._TitleRow (c)
Omni._Unafflicted (abil)
Omni.GetAbilityString (data, rowType) Get the ability string from a table row.
Omni.AddLogRow (y, c, a, x, d, e, eo, mt1, mn1, mt2, mn2, mt3, mn3) Adds a row to the Omniscience combat log.
Omni.CloseLiveWindow ()
Omni.CompressData (tbl) Compress a table's data, returning a symbol lookup table and a new compressed data table. @return symtab, cdata where symtab is the symbol table used for decompression and cdata is the compressed data. NIL on failure.
Omni.DecompressData (symtab, cdata) Given a symtab and cdata as returned by Omni.CompressData, decompress a table IN PLACE. @return data The decompressed table data.
Omni.ExtractTemporalMatches (tbl, n, startPoint, filterFun) Starting from the given row ("FIRST" or "LAST"), find up to n rows that match the given filter and return the timestamps, in seconds.
Omni.ExtractWindow (t, w) Starting from the given server time, extract a window of +/- w seconds.
Omni.FilterEditor:new () The filter editor dialog.
Omni.FilterFunctor (desc) Given a descriptor, return a function that accepts a (table, row) pair and returns TRUE iff the row matches the filter.
Omni.GetDamageTypeColor (index)
Omni.GetDamageTypeName (index)
Omni.GetFailType (index)
Omni.GetImpulseType (index) An "impulse" is an event that actually does damage or healing...
Omni.GetLog () Get the Omniscience local log table.
Omni.GetMap_IndexToRowType ()
Omni.GetMap_RowTypeToIndex ()
Omni.GetMiscString (row) Get the miscellaneous string from a log row.
Omni.GetRowType (index)
Omni.GetRowTypeColor (index)
Omni.GetSessionByName (name) Find the Omniscience session with the given name.
Omni.GetTableFormat (fn)
Omni.GetXiType (index)
Omni.History (t) Starting from now, extract the past T seconds from the local combat log.
Omni.IsCritRow (row) Determine if a row is a crit.
Omni.IsLogging ()
Omni.Open () Open the Omniscience interface.
Omni.OpenLiveWindow ()
Omni.PredefinedQuery (who) QUERY DIALOG.
Omni.RegisterTableFormat (fmt) Table format registration.
Omni.RegisterTableMenuHandler (func) The table right click menu.
Omni.RemoveSessionByName (name) Remove an Omniscience session by name.
Omni.RenameTable (tbl, newName) Rename a table.
Omni.RowActorIsSource (index) If the actor is the SOURCE for this row type, return true.
Omni.RowActorIsTarget (index) If the actor is the TARGET for this row type, return true.
Omni.RowHasActors (index) Determine if a row has a source/target.
Omni.SendWholeTable (tbl, prefix, overrideName)
Omni.Session:new (name) Create a new Omniscience session.
Omni.Session:AddTable (tbl, number) Adds a table to this session's tablespace. Adds a table to this session's tablespace.
Omni.Session:Cleanse () "Cleanse" a session. This operation makes sure everything that should be a number is tonumber()'d.
Omni.Session:Clear () Clear a session.
Omni.Session:Close () Close down a session.
Omni.Session:FindTable (name) Get a table from this session by name. @return table,index where table is the desired table and index is its numerical index. NIL if not found.
Omni.Session:IsLocal () Determine if the session is a local session (no unsynchronized tables).
Omni.Session:RemoveTable (table) Remove a table from this session's tablespace by pointer.
Omni.Session:RemoveTableByIndex (index) Remove a table from this session's tablespace by index.
Omni.Session:RenameTable (tbl, newName) Rename a table on this session.
Omni.Session:Tablespace () Get this session's tablespace.
Omni.Sessions () Return a list of all sessions.
Omni.SetActiveTable (table) Activate a table in the Omniscience viewer.
Omni.SetLogging (x) Enable or disable Omniscience combat logging. @param x If TRUE, logging is enabled; if FALSE, disabled.
Omni.SetupTable (list, tbl, xad) Overall function to apply appropriate settings for an Omni table.
Omni.Table:new ()
Omni.Table:Cleanse () "Cleanse" the data of a table, making sure everything that should be a number is.
Omni.Table:Crop (r1, r2, name) Crop a range of rows from this table.
Omni.Table:Filter (func) Filter this table through a filter function.
Omni.Table:GetData () Get the data from this table.
Omni.Table:GetRow (n)
Omni.Table:GetRowTime (row) Get the true time from a row of this table.
Omni.Table:IsImmutable () Check immutability for this table. @return TRUE iff this table is immutable.
Omni.Table:IsLocal () Check if this table is in local format. @return TRUE iff this table is in local format.
Omni.Table:IsLogTable ()
Omni.Table:IsReadable ()
Omni.Table:MakeCopy () Make a table that's a copy of this table.
Omni.Table:SetFormat (fmt) Set the format for this table.
Omni.Table:SetMetadataFrom (t) Sets this table's metadata equal to the metadata of the other table.
Omni.Table:SetOpen (flag) Set the "open status" for this table.
Omni.Table:Size () Get the size of this table.
Omni.Table:Timeshift (dt) Timeshift this table.
Omni.TemporalExtractionTransform (tbl, startPoint, startFunc, dxn, filterFunc, filterFunctor) Temporal extraction transform.
Omni.TimeQueryDialog (who, when, window)
Omni.TotalsTransform (tbl, cfg)

[edit] OOBE

Implementation functions for the OOBE (out-of-box experience) package and desktop auto-installer.

RDX.CheckOOBEObjectVersion (x, vt, strict) Get the version of an OOBE object.
RDX.ClearInstallerData () Clear all installer data.
RDX.GetOOBEObjectVersion (x) Get the version of an OOBE object.
RDX.OOBESetReloadUI (x) Set the OOBE reloadui flag to true.

[edit] RaidStatus

Raid status readouts for RDX6.

RDXRS.GetStatisticalQuantity (n)
RDXRS.RegisterStatisticalQuantity (table) Register a new statistical quantity.
RDXRS.Statistic:new (n) The Statistic object.
RDXRS.Statistic:Compute () Update the statistic.
RDXRS.Statistic:LoadDescriptor (desc) Functor - from a statistic's descriptor, make the statistic.
RDXRS.Statistic:GetMaxValue ()
RDXRS.Statistic:GetRatio ()
RDXRS.Statistic:GetValue ()
RDXRS.StatisticEditor (parent, path, md)

[edit] RangeFinding

Rangefinding tools for RDX.

RDXRF.GetItemRangeSet (item) Get an exact range set for the given item.
RDXRF.GetSpellRangeSet (spell) Get an exact range set for the given spell.

[edit] RDAL

Various Raid-Data-Abstraction-Layer components. These functions build the RDX unit, filter, and sort engines. Given the overall size of this section, I will prob break it into a few subsections based on units, filters, and sorts once I'm finished indexing.

RDXPlayer () The player unit. Refers to the player's RDX unit always.
RDX._Disrupt ()
RDX._FastProject (uid)
RDX._GetBuffCache ()
RDX._GetDebuffCache ()
RDX._GetSetDatabase ()
RDX._ReallyFastProject (uid)
RDX._SortContinuation (context) Recursively generate continuation-passing code for the give sort descriptor.
RDX.BeginEventBatch () Informs the RDX data processing engine that a batch of events is about to occur. Use this as a 'performance hint' to allow sets to process entire batches at a time before fully rebuilding themselves.
RDX.EndEventBatch () Informs the RDX data processing engine that the stream of events caused by the last call to RDX.BeginEventBatch() is over. this will cause the batch to be processed by the underlying sets.
RDX.FilterBuildClosureStringFromMetadata (md) Build a closure string from metadata.
RDX.FilterBuildLocalStringFromMetadata (md) Build a locals string from metadata
RDX.FilterFunctor (fd) Generate a filter function from a descriptor.
RDX.FilterEvents_FullUpdate (md, ev, adapter)
RDX.FilterEvents_UnitUpdate (md, ev, adapter)
RDX.FilterSet {} Set based on a filter, and whose contents change whenever the filter would so indicate.
RDX.FilterSet:_Clean (x)
RDX.FilterSet:_OnActivate (x) Activator.
RDX.FilterSet:_OnDeactivate (x)
RDX.FilterSet:new () Given a filter descriptor, create a filter set based upon it.
RDX.FilterSet:SetFilter (x, desc) Set the filter descriptor for this set.
RDX.FindSet (descriptor) Find a set given the descriptor returned by the set finder.
RDX.FlushAuras () Force a reprocessing of auras for all valid units.
RDX.GetBuffInfoByName () Return a table containing information on the buff with the given texture, if seen this session.
RDX.GetBuffSet (name) Get the buff set for the given debuff.
RDX.GetDebuffInfoByName () Return a table containing information on the debuff with the given texture, if seen this session.
RDX.GetDebuffSet (name) Get the debuff set for the given debuff.
RDX.GetFilterComponent (desc) Gets the filter component for the given descriptor.
RDX.GetFilterComponentByName (name) Gets the filter component by name.
RDX.GetNumberToUIDMap ()
RDX.GetNumUnits () Returns the total number of units in the RDX unit database.
RDX.GetSetByID (sid) Get a set by its numerical ID.
RDX.GetSortOperatorByName (name) &nbs
RDX.GetUIDToNumberMap ()
RDX.GetUnitByName (n) Get a reference to a unit by its name.
RDX.GetUnitByNameIfInGroup (name) Get the RDX Unit for this raider if in the raid; otherwise return nil.
RDX.GetUnitByNumber (i) Get a reference to a unit by its unit number.
RDX.Group (gn)
RDX.IsBatchMode () Returns TRUE iff the RDX data processing engine is currently in batch mode.
RDX.IsSolo () Return TRUE iff we are solo, nil otherwise.
RDX.InRaid () Return TRUE iff we are currently in a raid group, nil otherwise.
RDX.LoadBuffFromUnit ()
RDX.LoadDebuffFromUnit ()
RDX.NominativeSet:new () Creates a new nominative set.
RDX.NominativeSet:_OnActivate () On activate bind us to DISRUPT_SETS.
RDX.NominativeSet:_OnDeactivate () On deactivate unbind us to DISRUPT_SETS.
RDX.NominativeSet:_Sweep () Update the underlying NID set.
RDX.NominativeSet:AddName (n) Add a name from this set.
RDX.NominativeSet:CheckName (n) Check if a name is in this set.
RDX.NominativeSet:ClearNames () Clear this set.
RDX.NominativeSet:GetHeaderList () Get the names as a comma seperated list suitable for use with raid state headers.
RDX.NominativeSet:GetNameArray () Get the names from this set as an array.
RDX.NominativeSet:GetNames () Get the list of names from this set.
RDX.NominativeSet:RemoveName (n) Remove a name from this set.
RDX.NominativeSet:SetNameList (list) Bootstrap a NominativeSet from a list of names.
RDX.NumberToUID (unum)
RDX.ProjectUnitID (uid)
RDX.ProjectiveUnit:new (uid)
RDX.ProcessRoster () Main roster processing.
RDX.ProtoSet {} A ProtoSet is the 'bare minimum' necessary to achieve sethood. Other types of sets can derive from ProtoSet to inherit needed code.
RDX._AddToLaundry () Add this set to the 'dirty sets' list, causing it to receive an update signal on the next update sweep.
RDX._GetRefCount () Get the current reference count for this set.
RDX.Close () Decreases the reference count of this set by 1, deactivating it if the refcount reaches 0.
RDX.init ()
RDX.IsOpen () Is this set open?
RDX.new ()
RDX.Open () Increases the reference count of this set by 1, activating it if it was not already active.
RDX.Raid ()
RDX.RegisterFilterComponent (data) Register a filter component.
RDX.RegisterFilterComponentCategory (cat) Register a filter category.
RDX.RegisterSet (set) Add a set to the set database.
RDX.Set {} A Set is a map between a unit numerical ID and an arbitrary non-nil piece of data. A unit is a 'member' of the set if the data associated with that unit is not false. Sets inherit from RDX.ProtoSet.
DEPRECATED RDX.Set:_IsMemberByNid () Determine if the RDX unit with the given NID is a member of this set.
RDX.Set:_Clean () Propagate delta subsignals for this set.
RDX.Set:_Clear () Clear this set completely.
RDX.Set:_Set (un, val) Modify the state of a member fo this set, propogating all appropiate events.
RDX.Set:_Poke (un, val) Poke directly into set internal data. Don't use this unless you know what you're doing.
RDX.Set:ConnectDelta () Connect a handler to this set's delta signal.
RDX.Set:GetSize () Get the size of this set.
RDX.Set:init ()
RDX.Set:IsEmpty () Determine if this set is empty.
RDX.Set:IsMember (rdxunit) Determine if the given RDX unit is a member of this set.
RDX.SetIterator () Return a stateless iterator over this set.
RDX.Set:new () Remove a handler to this set's delta signal.
RDX.Set:RemoveDelta () Remove a handler to this set's delta signal.
RDX.SetFinder:new (parent) Create a new set finder.
RDX.SetNonRaid (noReprocess)
RDX.SetRaid () Flip between raid and nonraid status.
RDX.ShowAuraTooltip (meta, frame, anchor) Reproduce an aura tooltip from an entry in an aura cache.
RDX.Sort:new () Creates a new sort.
RDX.Sort:_GetRefCount ()
RDX.Sort:_OnActivate () Activate this sort from a cold state.
RDX.Sort:_OnDeactivate () Reset the internal state of this sort.
RDX.Sort:Close ()
RDX.Sort:GetByIndex (index)
RDX.Sort:GetSize ()
RDX.Sort:GetUnderlyingSet ()
RDX.Sort:IndexOfUID (uid) Look in this sort and find uid.
RDX.Sort:IndexOfUnit (unit) Look in this sort and find unit.
RDX.Sort:IsOpen ()
RDX.Sort:IsSecure () Set the combat-lock flag on this sort.
RDX.Sort:Iterator ()
RDX.Sort:Open ()
RDX.Sort:Rebuild () Rebuild the sortation from the underlying set, then :Sort()
RDX.Sort:Setup (sort_desc, set, secureFlag) Setup this sort by loading the given descriptor.
RDX.SortEditor:new () Creates a new sort editor window.
RDX.SortEditor:GetDescriptors ()
RDX.SortEditor:SetDescriptors (sdesc, desc)
RDX.SortFunctor (desc, set, events) From a sort descriptor, generate the sort function F(u1,u2).
RDX.RegisterSetClass (table) Registers a set class.
RDX.RegisterSortOperator (category) Register a new sort function.
RDX.RegisterSortOperatorCategory (category) Register a category of sort functions. Can later be passed as category = to RDX.RegisterSortOperator.
RDX.TrivialFilterUI (filtName, filtText) Generic empty filter UI generating function.
RDX.TrivialSetFinderUI (class) Create a trivial GetUI() function for the set finder.
RDX.TrivialSortUI (name, text) Generic empty sort UI generating function.
RDX.UIDToNumber (uid)
RDX.Unit ({}) Core metatable, whenever a method is added to RDX.Unit, add it to the other metatables as well.
RDX.Unit._ValidMetaTable () Determine if this unit is using the 'valid unit' metatable.
RDX.Unit:GetClass ()
RDX.Unit:GetClassColor ()
RDX.Unit:GetClassID ()
RDX.Unit:GetClassMnemonic ()
RDX.Unit:GetEField (field) Return The engine field structore of the unit or NIL if none.
RDX.Unit:GetGroup () Get the group number of this unit, as returned by GetRaidRosterInfo.
RDX.Unit:GetIndexedUnit () Return A unit reference equivalent to this unit, but indexical in scope.
RDX.Unit:GetLeaderLeve () Get the leader level of the unit, as per the convention of GetRaidRosterInfo.
RDX.Unit:GetName () Return the name of this unit, in internal (lowercased) form.
RDX.Unit:GetNField (field) Return The nominative field structure of the unit or NIL if none.
RDX.Unit:GetNominativeUnit () Return a unit reference equivalent to this unit, but nominative in scope.
RDX.Unit:GetNumber () Return the fundamental numeric ID of the unit.
RDX.Unit:GetOwnerUnit () Return the owner unit of this unit, if it is a pet. NIL if cannot be resolved.
RDX.Unit:GetProperName () Return the proper in-game name of this unit.
RDX.Unit:GetUnitID () Return the WoW unit ID of this unit.
RDX.Unit:FracHealth () Return The fractional HP of the unit as reported by the WoW engine.
RDX.Unit:FracMana () Return the fractional Mana of the unit.
RDX.Unit:FracMissingHealth () Return The fraction of the unit's missing HP as reported by the WoW engine.
RDX.Unit:FracMissingMana () Return the fraction of missing Mana of the unit.
RDX.Unit:Health () Return The current HP of the unit as reported by the WoW engine.
RDX.Unit:Invalidate () Invalidates the underlying unit. Subsequent calls to :IsValid will return false.
RDX.Unit:IsDead () Return TRUE iff the unit is dead.
RDX.Unit:IsFeigned () Return TRUE iff the unit is feigning death.
RDX.Unit:IsIncapacitated () Return TRUE iff the unit is incapacitated (offline, dead, feigned)
RDX.Unit:IsInDataRange () Return TRUE iff this unit is in the data range of the WoW engine.
RDX.Unit:IsLeader () Return TRUE iff this unit is an assistant leader or leader of the raid group/party.
RDX.Unit:IsNominativeUnit ()
RDX.Unit:IsOnline () Return TRUE iff the unit is online
RDX.Unit:IsPet () Return TRUE iff this unit is a pet.
RDX.Unit:IsSameUnit () Return TRUE iff this unit is the same unit as the given RDX unit.
RDX.Unit:IsValid () Return TRUE iff this unit is valid. A valid unit is one that's in the raid group and whose vital statistics are accessible to the engine.
RDX.Unit:Mana () Return the current Mana of the unit.
RDX.Unit:MaxHealth () Return The max HP of the unit as reported by the WoW engine.
RDX.Unit:MaxMana () Return the max Mana of the unit.
RDX.Unit:MissingMana () Return the missing Mana of the unit.
RDX.Unit:MissingHealth () Return The number of missing HP of the unit as reported by the WoW engine.
RDX.Unit:PowerType () Return the WoW Powertype of the unit ("MANA", "RAGE", "ENERGY", "FOCUS").
RDX.Unit:RawFracHealth (uid)
RDX.Unit:RawFracMana (uid)
RDX.UnitHasBuffByName (uid, buff) Determine if a unit has the given debuff.
RDX.UnitHasDebuffByName (uid, buff) Determine if a unit has the given buff.
RDX.UnitInGroup (uid)
RDX.ValidateFilter (fd) Validate a filter descriptor.
RDXUI._CreateCategoryEntry (cat)
RDXUI.AuraCachePopup (db, callback, frame, point, dx, dy) Aura metasets filters.
RDXUI.GenerateFilterDropTarget (parent) Generate a frame onto a filter can dropped.
RDXUI.EditSortDialog (parent, path, md) The dialog for editing the contents of a sort.
RDXUI.dcSorts () Shortlink to VFLUI.DragContext:new().
RDXUI.FilterEditor:new (parent) Filter editor UI.
RDXUI.FilterEditor:ResetFilterUI ()
RDXUI.FilterEditor:SetFilterUI (x)
RDXUI.FilterDialogFrame:new (parent) A dialog control for filter entries.
RDXUI.SortDialogFrame:new (parent) A dialog control for sort components.
RDXUI.SortDialogFrame:Destroy ()
RDXUI.SortDialogFrame:DisableButtons (s, dUp, dDn, dClose, dReverse)
RDXUI.SortDialogFrame:IsReversed (s)
RDXUI.SortDialogFrame:SetChild (s, child)
RDXUI.SortDialogFrame:SetChecked (arg)
RDXUI.SortDialogFrame:SetReversed (s, arg)
RDXUI.SortDialogFrame:SetupButtons (s, onClose, onUp, onDn)
RDXUI.SortDialogFrame:SetText (s, t)

[edit] RPC

RPC is Remote Procedure Call, a mechanism for transferring code and data between clients over a common substrate.

bigcomptest ()
comp_test (x)
lzw_compress (input) Implementation of a 12-bit LZW compressor in Lua.
lzw_decompress (input) Implementation of a 12-bit LZW decompressor in Lua.
DISABLED rettest (n, tcsz)
DISABLED tesc ()
wow_sanitize (s) Sanitizes WoW strings prior to compression to remove any characters that would cause a disconnect (such as newline (/n)).
wow_desanitize (s) Desanitizes WoW strings after decompression to reverse the sanitize process.
DISABLED ChatFrame_OnEvent (event) Antispam
RDX.ContainsDangerousFeature (featList) Determine whether any feature on the given feature list is dangerous.
RDX.ImbueAddonChannel (preChannel, prefix, chType) Addon messaging.
RDX.ImbueAddonChannel:Check () Check to make sure we're properly on this channel. Join if not. (No sense for an addon channel.)
RDX.ImbueAddonChannel:Cleanup () Leave this channel, if we were in it, clearing out all queues, etc. (Makes no sense for an addon channel.)
RDX.ImbueAddonChannel:Close () Decrement the reference count for this channel, removing if empty.
RDX.ImbueAddonChannel:IsOpen () Check the reference count for this channel.
RDX.ImbueAddonChannel:Open () Increment the reference count for this channel.
RDX.ImbueAddonChannel:Send (msg) Send a message on this channel.
RDX.ImbueLoopbackChannel (preChannel, prefix) Loopback channel for solo play.
RDX.ImbueLoopbackChannel:Check () Check to make sure we're properly on this channel. Join if not. (No sense for an addon channel.)
RDX.ImbueLoopbackChannel:Cleanup () Leave this channel, if we were in it, clearing out all queues, etc. (Makes no sense for an addon channel.)
RDX.ImbueLoopbackChannel:Close () Decrement the reference count for this channel, removing if empty.
RDX.ImbueLoopbackChannel:IsOpen () Check the reference count for this channel.
RDX.ImbueLoopbackChannel:Open () Increment the reference count for this channel.
RDX.ImbueLoopbackChannel:Send (msg) Send a message on this channel.
RDX.Integrate (parent, data, author, callback)
RDX.Integrate:SelectFile (path)
RDX.IsDangerousFeature (feat) Determine whether the given feature is dangerous.
RDX.IsDangerousObject (md) Using dangerous object filters, determine whether the given object is dangerous.
RDX.MassIntegrate (parent)
RDX.RegisterDangerousObjectFilter (tbl) Register a dangerous object filter. Should return TRUE iff the object is dangerous.
RDX.SanitizeCodeString (str) "Sanitize" a string, removing all quotations and anything else that could be used to inject Lua code into a string.
RDX.TryIntegrate (parent, data, author, callback) Try to integrate a data set. Tries for 1 minute until the dialog is successfully displayed. This can be used to defer a later integration while an earlier one is still in progress.
RPC.CleanupChannels () Leave all inactive channels.
RPC.Conferences ()
RPC.ConfFinder:new (parent) Leave all inactive channels.
RPC.ConfFinder:GetConference ()
RPC.ConfFinder:SetConferenceID (id)
RPC.EscapeString (s) Escape the passed string for transport over a stream.
RPC.GenerateCleanBytes (n)
RPC.GetChatChannel (name) Create a chat channel.
RPC.GetChatChannel:Check () Check to make sure we're properly on this channel. Join if not.
RPC.GetChatChannel:Cleanup (name) Leave this channel, if we were in it, clearing out all queues, etc.
RPC.GetChatChannel:Close () Decrement the reference count for this channel, removing if empty.
RPC.GetChatChannel:IsOpen () Check the reference count for this channel.
RPC.GetChatChannel:OnReceive (obj, fn) Bind to the OnReceive signal for this channel.