Module Geyser.Window
Represents an abstract window class designed to be subclassed for windows
that are built on Mudlet primitives, like labels.
Info:
| Geyser.Window:cecho (message) |
Prints a message to the window. |
| Geyser.Window:decho (message) |
Prints a message to the window. |
| Geyser.Window:echo (message) |
Prints a message to the window |
| Geyser.Window:getBgColor () |
Get the window's background color |
| Geyser.Window:getFgColor () |
Get the window's foreground color. |
| Geyser.Window:hecho (message) |
Prints a message to the window. |
| Geyser.Window:paste () |
Pastes text from the clipboard into this window primitive. |
| Geyser.Window:setBgColor (r, g, b) |
Sets the background color of this window primitive. |
| Geyser.Window:setBold (bool) |
Sets bolded text. |
| Geyser.Window:setColor (r, g, b, a) |
Sets the background color and alpha. |
| Geyser.Window:setFgColor (r, g, b) |
Sets the foreground color of this window primitive. |
| Geyser.Window:setItalics (bool) |
Sets italicized text. |
| Geyser.Window:setTextFormat (r1, g1, b1, r2, g2, b2, bold, underline, italics) |
Sets the text format for this window. |
| Geyser.Window:setUnderline (bool) |
Sets underlined text. |
| Geyser.Window |
Represents an abstract window class designed to be subclassed for windows
that are built on Mudlet primitives, like labels. |
-
Geyser.Window:cecho (message)
-
Prints a message to the window.
Parameters:
- message
The message to print. Uses color formatting information -
a message of "Hi" would make 'Hi' red.
-
Geyser.Window:decho (message)
-
Prints a message to the window.
Parameters:
- message
The message to print. Uses color formatting information -
a message of "<255,0,0>Hi" would make 'Hi' red.
-
Geyser.Window:echo (message)
-
Prints a message to the window
Parameters:
- message
The message to print. Can contain html formatting.
-
Geyser.Window:getBgColor ()
-
Get the window's background color
Returns:
The background color of this window primitive as a Geyser.Color object.
-
Geyser.Window:getFgColor ()
-
Get the window's foreground color.
Returns:
The foreground color of this window primitive as a Geyser.Color object.
-
Geyser.Window:hecho (message)
-
Prints a message to the window.
Parameters:
- message
The message to print. Uses color formatting information -
a message of "|cff0000Hi" would make 'Hi' red.
-
Geyser.Window:paste ()
-
Pastes text from the clipboard into this window primitive.
-
Geyser.Window:setBgColor (r, g, b)
-
Sets the background color of this window primitive. If this primitive
was using a shared color, then it creates a new, personal color.
Parameters:
- r
The red value, or a quoted color name, like "green", or a decho color like "<0,255,0>", or hex color like "#00ff00"
- g
The green value, or nil if using a name.
- b
The blue value, or nil if using a name.
-
Geyser.Window:setBold (bool)
-
Sets bolded text.
Parameters:
-
Geyser.Window:setColor (r, g, b, a)
-
Sets the background color and alpha. If this primitive
was using a shared color, then it creates a new, personal color.
Parameters:
- r
The red component of the color, or a named color like "green", or a decho color like "<0,255,0>", or hex color like "#00ff00"
- g
The green component, or nil if using named colors.
- b
The blue component, or nil if using named colors.
- a
The alpha component. If nil, uses current alpha value.
-
Geyser.Window:setFgColor (r, g, b)
-
Sets the foreground color of this window primitive. If this primitive
was using a shared color, then it creates a new, personal color.
Parameters:
- r
The red value, or a quoted color name, like "green", or a decho color like "<0,255,0>", or hex color like "#00ff00"
- g
The green value, or nil if using a name.
- b
The blue value, or nil if using a name.
-
Geyser.Window:setItalics (bool)
-
Sets italicized text.
Parameters:
- bool
True for italicized.
-
Geyser.Window:setTextFormat (r1, g1, b1, r2, g2, b2, bold, underline, italics)
-
Sets the text format for this window. Note that the *echo()
functions will override these settings.
Parameters:
- r1
The red foreground component.
- g1
The green foreground component.
- b1
The blue foreground component.
- r2
The red background component.
- g2
The green background component.
- b2
The blue background component.
- bold
The bolded status. 1 is bold, 0 is normal.
- underline
The underlined status. 1 is underlined, 0 is normal.
- italics
The italicized status. 1 is italicized, 0 is normal.
-
Geyser.Window:setUnderline (bool)
-
Sets underlined text.
Parameters:
- bool
True for underlined.
-
Geyser.Window
-
Represents an abstract window class designed to be subclassed for windows
that are built on Mudlet primitives, like labels.
- message
The message last *echo()'d to this window. Default is “”.
- bgColor
Text background color, default "white"
- fgColor
Text foreground color, default "black"
- color
Window background color, default "#202020"