Class ShipLCDBox
Gauges that sit at the bottom and do gauge things related to things to do on a ship.
Initialisation
| ShipLCDBox:new (_instanceName, _elementX, _elementY, _inputText, _backingText, _fontSize, _fontColour) | Creates a new instance of the ShipLCDBox class. |
Misc methods
| ShipLCDBox:setVisible (_visible) | Shows or hides the whole object on the screen. |
| ShipLCDBox:build (_positionTable, _type) | Shows or hides the whole object on the screen. |
Initialisation
For creating and Initialising ShipCompass object.- ShipLCDBox:new (_instanceName, _elementX, _elementY, _inputText, _backingText, _fontSize, _fontColour) line 29
-
Creates a new instance of the ShipLCDBox class.
Parameters:
- _instanceName string Instance name, should be identical to variable instance is assigned to.
- _elementX int X position of
- _elementY int
- _inputText string Text to display.
- _backingText test Dark backing text to mimic unlit LCD segments.
- _fontSize int[opt=30] Font size of the attached text.
- _fontColour string[opt="HotPink"] Font colour in a QtCSS compatible string.
Returns:
-
table
A new instance of the ShipLCDBox class.
Usage:
lcds = ShipLCDBox:new("lcds")
Misc methods
- ShipLCDBox:setVisible (_visible) line 121
-
Shows or hides the whole object on the screen.
Just a shortcut for things like getting into my ship UI.
Parameters:
- _visible bool True to show object, false to hide.
Usage:
ShipLCDBox:setVisible(true) - ShipLCDBox:build (_positionTable, _type) line 134
-
Shows or hides the whole object on the screen.
Just a shortcut for things like getting into my ship UI.
Parameters:
- _positionTable table Key/value table, with key being
- _type
string
Type of display to instantiate. Valid options are
hull,sails,speed, 'wind`
Usage:
ShipLCDBox:setVisible(true)