Defines a Gauge Compound.
Gauge | Defines a Gauge Compound. |
Variables | |
master_list | A list of Gauges, used to update all Gauges. |
Functions | |
VyzorGaugeUpdate | A dirty global function to update all Vyzor Gauges. |
new | |
New Gauge | A lightweight container for Frames that will function as a dynamically resized bar. |
Variables | |
current_address | Index of current variable. |
maximum_address | Index of maximum variable. |
background_frame | Frame serving as Gauge’s background. |
foreground_frame | Frame serving as Gauge’s foreground. |
overflow_frames | Contains the Gauge’s overflow frames. |
caption_frame | Generated frame that can be echoed to. |
auto_echo | Should this Gauge echo every update? |
text_format | Format used when auto_echo is true. |
fill_mode | Determines direction Gauge fills. |
Properties | |
Gauge Properties | |
Functions | |
getField | Retrieves the value of the given index. |
Update | Updates the Gauge. |
Echo | Displays text on the auto-generated caption Frame. |
VyzorInitializeGauges | Calls update on each Gauge after Vyzor has been drawn. |
local function new ( _, name, current, maximum, init_back, init_fore, fill_enum, init_over )
name | The name of the Gauge. |
current | The string address of the current stat to track. |
maximum | The string address of the current stat to track. |
init_back | The Background Frame. |
init_fore | The Foreground Frame. Size and Position values will be overwritten. |
fill_enum | GaugeFill Enum. Determines direction Gauge fills. Defaults to LeftRight. |
init_over | Numerically indexed table of Frames to be used for overflow. |
A lightweight container for Frames that will function as a dynamically resized bar.
Variables | |
current_address | Index of current variable. |
maximum_address | Index of maximum variable. |
background_frame | Frame serving as Gauge’s background. |
foreground_frame | Frame serving as Gauge’s foreground. |
overflow_frames | Contains the Gauge’s overflow frames. |
caption_frame | Generated frame that can be echoed to. |
auto_echo | Should this Gauge echo every update? |
text_format | Format used when auto_echo is true. |
fill_mode | Determines direction Gauge fills. |
Properties | |
Gauge Properties | |
Functions | |
getField | Retrieves the value of the given index. |
Update | Updates the Gauge. |
Echo | Displays text on the auto-generated caption Frame. |
VyzorInitializeGauges | Calls update on each Gauge after Vyzor has been drawn. |
Name | Returns the Gauge’s name. |
Container | Gets and sets the Gauge’s container. |
CurrentAddress | Gets and sets the Gauge’s current variable index. |
Current | Returns the numeric value of the current variable. |
MaximumAddress | Gets and sets the Gauge’s maximum variable index. |
Maximum | Returns the numeric value of the maximum variable. |
Background | Returns the Gauge’s Background Frame. |
Foreground | Returns the Gauge’s Foreground Frame. |
FillMode | Gets and sets the Gauge’s fill direction. |
AutoEcho | Gets and sets the Gauge’s auto_echo property. |
TextFormat | Gets and sets the format used by auto_echo. Must be compatible with string.format. |
Overflow | Returns a copy of the Gauge’s overflow Frames. |
A list of Gauges, used to update all Gauges.
local master_list
A dirty global function to update all Vyzor Gauges.
function VyzorGaugeUpdate ()
local function new ( _, name, current, maximum, init_back, init_fore, fill_enum, init_over )
Index of current variable.
local current_address
Index of maximum variable.
local maximum_address
Frame serving as Gauge’s background.
local background_frame
Frame serving as Gauge’s foreground.
local foreground_frame
Contains the Gauge’s overflow frames.
local overflow_frames
Generated frame that can be echoed to.
local caption_frame
Should this Gauge echo every update?
local auto_echo
Format used when auto_echo is true.
local text_format
Determines direction Gauge fills.
local fill_mode
Retrieves the value of the given index.
local function getField ( field )
Updates the Gauge.
function new_gauge:Update ()
Displays text on the auto-generated caption Frame.
function new_gauge:Echo ( text )
Calls update on each Gauge after Vyzor has been drawn.
function VyzorInitializeGauges ()