Module GeyserGauge
--
The Geyser Layout Manager by guy --
--
| Geyser.Gauge |
Represents a gauge that can be either vertical or horizontal. |
-
Geyser.Gauge:setValue (currentValue, maxValue, text)
-
Sets the gauge amount.
Parameters:
- currentValue
Current numeric value, or if maxValue is ommitted, then
it is assumed that currentValue is a value between 0 and 100 and is
used to set the gauge.
- maxValue
Maximum numeric value. Optionally nil, see above.
- text
The text to display on the gauge, it is optional.
-
Geyser.Gauge:setColor (r, g, b, text)
-
Sets the gauge color.
Parameters:
- r
The red component, or a named color like "green".
- g
the green component, or nil if using a named color.
- b
the blue component, or nil if using a named color.
- text
The text to display on the gauge, it is optional.
-
Geyser.Gauge:setText (text)
-
Sets the text on the gauge.
Parameters:
-
Geyser.Gauge:setFormat (format)
-
Set the format for text on the gauge
Parameters:
- format
the format to set. Same as Geyser.Label:setFormat
-
Geyser.Gauge:setBold (bool)
-
Set whether or not the text in the gauge should be bold
Parameters:
-
Geyser.Gauge:setItalics (bool)
-
Set whether or not the text in the gauge should be italic
Parameters:
-
Geyser.Gauge:setUnderline (bool)
-
Set whether or not the text in the gauge should be underlined
Parameters:
-
Geyser.Gauge:setStrikethrough (bool)
-
Set whether or not the text in the gauge should be strikethrough
Parameters:
- bool
True for strikethrough
-
Geyser.Gauge:setFontSize (fontSize)
-
Set the font size for the gauge to use
Parameters:
- fontSize
the font size to use for the gauge. Should be a number
-
Geyser.Gauge:setAlignment (alignment)
-
Set the alignment of the text on the gauge
Parameters:
- alignment
Valid alignments are 'c', 'center', 'l', 'left', 'r', 'right', or '' to not include the alignment as part of the echo
-
Geyser.Gauge:setFgColor (color)
-
Sets the color of the text on the gauge
Parameters:
- color
the color you want the text to be
-
Geyser.Gauge:echo (text)
-
Sets the text on the gauge, overwrites inherited echo function.
Parameters:
-
Geyser.Gauge:enableClickthrough ()
-
Sets the gauge to no longer intercept mouse events
-
Geyser.Gauge:disableClickthrough ()
-
Sets the gauge to once again intercept mouse events
-
Geyser.Gauge:setToolTip (txt, duration)
-
Sets the tooltip of the gauge
Parameters:
- txt
the tooltip txt
- duration
the duration of the tooltip
-
Geyser.Gauge:resetToolTip ()
-
Resets the tooltip of the gauge
-
Geyser.Gauge
-
Represents a gauge that can be either vertical or horizontal.
Fields:
- value
Percentage value of how "full" the gauge is.
- strict
If true, will cap the value of the gauge at 100, preventing
it from overflowing the edge. Defaults to false to maintain
old behaviours from before this was added.
- orientation
"horizontal" is the default and creates a horizontal
gauge that fills from left to right. "vertical" creates
a gauge that fills from bottom to top. "goofy" is
horizontal but fills right to left. "batty" is
vertical but fills from top to bottom.
- color
Color base for this gauge. Default is #808080