Documentation

#GAUGE

GAUGE

Syntax: #GAUGE id caption value maxvalue lowvalue class normcolor lowcolor backcolor

Creates a graphical gauge that you can use to visually track the value of an expression. For example, you can track your hit points, mana, etc using a gauge. Gauges are special versions of Buttons. To modify some of the special properties of a gauge, you will need to use the Settings Editor. The Gauge command can be used to quickly set or modify the main properties of a gauge.

The id is the short name given to the gauge so that you can refer to it using script commands. The id is not displayed anywhere on the gauge.

The caption is the text to display in the middle of the gauge. It can be blank if you don't want any text displayed.

The value is the expression that the button tracks. For example, to track the value of the @hp variable, you would use @hp as the value. This can be a full expression, not just a variable reference

Class is the name of the class to put the gauge in.

The maxvalue is the expression used to determine the maximum value of the gauge

The lowvalue is an expression used to determine what color to make the gauge. If the current value of the gauge is lower than lowvalue, then the lowcolor is used, otherwise the normcolor is used. The color values are the same color names used in the %color function.

The backcolor is an expression used to determine what color to make the background of the gauge. The default is silver.

GAUGE examples

#GAUGE hp "hp" @hp @maxhp (@maxhp/10) "" "blue" "red"
creates a nice hitpoint gauge. The value of the @hp variable is tracked. If @hp is less than @maxhp/10 then the gauge will be red, otherwise it will be blue.
#GAUGE hp ""
modifies the gauge already created by the previous example and removes the caption text from the gauge.

Add comment

Login or register to post comments