Vyzor

• Index

Contents

• Functions
• Methods
• Properties

Classes

• Frame
• Base
• Background
• Border
• BorderSide
• Brush
• Color
• Font
• Gradient
• Hover
• Image
• Map
• Margin
• MiniConsole
• Padding
• Position
• Size
• Box
• Chat
• Gauge
• Alignment
• BorderStyle
• BoundingMode
• BoxMode
• ColorMode
• FontDecoration
• FontStyle
• FontWeight
• GaugeFill
• GradientMode
• Enum
• Repeat
• TabLocation
• VyzorBorder

Modules

• Options
• Vyzor
• Lib

Scripts

• HUD

Class Gauge

A lightweight container for Frames that will function as a dynamically resized bar.

Functions

self:Update ()	Updates the Gauge.
self:Echo (text)	Displays text on the auto-generated caption Frame.

Methods

Gauge:VyzorGaugeUpdate ()	A dirty global function to update all Vyzor Gauges.
Gauge:VyzorInitializeGauges ()	Calls update on each Gauge after Vyzor has been drawn.
Gauge:Gauge (name, initialCurrentValueAddress, initialMaximumValueAddress, initialBackground, initialForeground[, initialFillMode=GaugeFill.LeftRight[, initialOverflowFrames]])	Gauge constructor.

Properties

self.Name.get ()	Returns the name of the Gauge.
self.Container.get ()	Returns the Gauge's parent Frame.
self.Container.set (value)	Sets the Gauge's parent Frame.
self.CurrentAddress.get ()	Returns the address of the Gauge's current value variable.
self.CurrentAddress.set (value)	Sets the address of the Gauge's current value variable.
self.Current.get ()	Returns the Gauge's current value.
self.MaximumAddress.get ()	Returns the address of the Gauge's maximum value variable.
self.MaximumAddress.set (value)	Sets the address of the Gauge's maximum value variable.
self.Maximum.get ()	Returns the Gauge's maximum value.
self.Background.get ()	Returns the background Frame of the Gauge.
self.Foreground.get ()	Returns the foreground Frame of the Gauge.
self.AutoEcho.get ()	Returns a flag determining whether or not the Gauge automatically echoes text on every update.
self.AutoEcho.set (value)	Sets a flag determining whether or not the Gauge automatically echoes text on every update.
self.TextFormat.get ()	Returns the text passed to string.format if AutoEcho is true.
self.TextFormat.set (value)	Sets the text passed to string.format if AutoEcho is true.
self.Overflow.get ()	Returns the overflow Frames of the Gauge.

Functions

self:Update ()

Updates the Gauge.

self:Echo (text)

Displays text on the auto-generated caption Frame.

Parameters:

• text

Methods

Gauge:VyzorGaugeUpdate ()

A dirty global function to update all Vyzor Gauges.

Gauge:VyzorInitializeGauges ()

Calls update on each Gauge after Vyzor has been drawn.

Gauge:Gauge (name, initialCurrentValueAddress, initialMaximumValueAddress, initialBackground, initialForeground[, initialFillMode=GaugeFill.LeftRight[, initialOverflowFrames]])

Gauge constructor.

Parameters:

• name string The name of the Gauge.
• initialCurrentValueAddress string The string address of the current stat to track.
• initialMaximumValueAddress string The string address of the current stat to track.
• initialBackground Frame The Background Frame.
• initialForeground Frame The Foreground Frame. Size and Position values will be overwritten.
• initialFillMode GaugeFill Determines direction Gauge fills. (default GaugeFill.LeftRight)
• initialOverflowFrames table Numerically indexed table of Frames to be used for overflow. (optional)

Returns:

Gauge

Properties

self.Name.get ()

Returns the name of the Gauge.

Returns:

string

self.Container.get ()

Returns the Gauge's parent Frame.

Returns:

Frame

self.Container.set (value)

Sets the Gauge's parent Frame.

Parameters:

• value Frame

self.CurrentAddress.get ()

Returns the address of the Gauge's current value variable.

Returns:

string

self.CurrentAddress.set (value)

Sets the address of the Gauge's current value variable.

Parameters:

• value string

self.Current.get ()

Returns the Gauge's current value.

Returns:

number

self.MaximumAddress.get ()

Returns the address of the Gauge's maximum value variable.

Returns:

string

self.MaximumAddress.set (value)

Sets the address of the Gauge's maximum value variable.

Parameters:

• value string

self.Maximum.get ()

Returns the Gauge's maximum value.

Returns:

number

self.Background.get ()

Returns the background Frame of the Gauge.

Returns:

Frame

self.Foreground.get ()

Returns the foreground Frame of the Gauge.

Returns:

Frame

self.AutoEcho.get ()

Returns a flag determining whether or not the Gauge automatically echoes text on every update.

Returns:

bool

self.AutoEcho.set (value)

Sets a flag determining whether or not the Gauge automatically echoes text on every update.

Parameters:

• value bool

self.TextFormat.get ()

Returns the text passed to string.format if AutoEcho is true.

Returns:

string

self.TextFormat.set (value)

Sets the text passed to string.format if AutoEcho is true.

Parameters:

• value string

self.Overflow.get ()

Returns the overflow Frames of the Gauge.

Returns:

table