File ../../LibScriptablePlugins-1.0/LibScriptablePluginResourceTools-1.0/LibScriptablePluginResourceTools-1.0.lua
Functions
PluginResourceTools.Debug (addon) | Profile CPU and Memory and display results |
PluginResourceTools.DebugCPU (addon) | Profile CPU and display results |
PluginResourceTools.DebugMem (addon) | Profile memory and display results |
PluginResourceTools.GetCPUUsage (addon, update, usestarlibs) | Retrieve resource profile for CPU usage |
PluginResourceTools.GetFramerate () | Retrieve framerate info |
PluginResourceTools.GetLatency () | Retrieve latency info |
PluginResourceTools.GetMemUsage (addon, update, usestarlibs) | Retrieve profiling data for memory usage |
PluginResourceTools.Update () | Update profiling data |
PluginResourceTools.UpdateCPU () | Update CPU data |
PluginResourceTools.UpdateMem () | Update profile data for memory usage |
PluginResourceTools:New (environment) | Populate an environment with this plugin's fields |
Functions
- PluginResourceTools.Debug (addon)
-
Profile CPU and Memory and display results
Parameters
- addon: The addon to profile.
Usage:
Debug(addon) - PluginResourceTools.DebugCPU (addon)
-
Profile CPU and display results
Parameters
- addon: The addon to profile
Usage:
DebugCPU(addon) - PluginResourceTools.DebugMem (addon)
-
Profile memory and display results
Parameters
- addon: The addon to profile
Usage:
DebugMem(addon) - PluginResourceTools.GetCPUUsage (addon, update, usestarlibs)
-
Retrieve resource profile for CPU usage
Parameters
- addon: We'll get the cpu usage for this addon.
- update: Whether to update data or not
- usestarlibs:
Usage:
GetCPUUsage(addon, update, usestarlibs)Return value:
cpu, percent, cpudiff, totalcpu, totaldiff, cpuperc - PluginResourceTools.GetFramerate ()
-
Retrieve framerate info
Usage:
GetFramerate()Return value:
Current framerate - PluginResourceTools.GetLatency ()
-
Retrieve latency info
Usage:
GetLatency()Return value:
Current latency information - PluginResourceTools.GetMemUsage (addon, update, usestarlibs)
-
Retrieve profiling data for memory usage
Parameters
- addon: We'll get the mem usage for this addon
- update: Whether to update resource data or not
- usestarlibs:
Usage:
GetMemUsage(addon)Return value:
mem, percent, memdiff, totalmem, totaldiff, memperc - PluginResourceTools.Update ()
-
Update profiling data
Usage:
Update() - PluginResourceTools.UpdateCPU ()
-
Update CPU data
Usage:
UpdateCPU() - PluginResourceTools.UpdateMem ()
-
Update profile data for memory usage
Usage:
Update()Return value:
Nothing - PluginResourceTools:New (environment)
-
Populate an environment with this plugin's fields
Parameters
- environment: This will be the environment when setfenv is called.
Usage:
:New(environment)Return value:
A new plugin object, aka the environment