Defines the primary container for Vyzor Components. Frames are modified via Components, and may hold other Frames.
Frame | Defines the primary container for Vyzor Components. |
Variables | |
first_frame | Used for very specific handling of the master Vyzor HUD. |
resize_registered | Determines whether or not the resize function has been registered as an event handler. |
master_list | Holds all Frames for reference. |
Functions | |
new | |
New Frame | A new Frame object. |
Variables | |
is_first | Is this the HUD? |
is_drawn | Has this Frame been drawn? |
is_bounding | Does this object obey bounding rules? |
bounding_type | The BoundingMode rules to which this object adheres. |
container | The Frame that contains this one. |
components | A list of Components this Frame contains. |
mini_consoles | Stores MiniConsole Components. |
compounds | Stores Compounds. |
frames | A list of Frames this Frame contains. |
callback | The name of a function to be used as a Label callback. |
callback_args | A table holding the arguments for a Label callback. |
position | The Position Supercomponent managing this Frame’s location. |
size | The Size Supercomponent managing this Frame’s space. |
stylesheet | This Frame’s Stylesheet. |
Functions and Properties | |
updateStylesheet | Polls all Component’s for their Stylesheets. |
Frame Properties | |
Add | Adds a new object to this Frame. |
Remove | Removes an object from this Frame. |
Draw | Draws this Frame. |
Resize | Resizes the Frame. |
Move | Repositions the Frame. |
Hide | Hides the Frame. |
Show | Reveals the Frame. |
Echo | Displays text on a Frame. |
Echo | Displays text on a Frame. |
Clear | Clears all text from the Frame. |
local function new ( _, name, x, y, width, height )
name | The name of the Frame, used for addressing. |
x | Initial X position of the Frame. Defaults to 0. |
y | Initial Y position of the Frame. Defaults to 0. |
width | Initial width of the Frame. Defaults to 1. |
height | Initial height of the Frame. Defaults to 1. |
A new Frame.
A new Frame object.
Variables | |
is_first | Is this the HUD? |
is_drawn | Has this Frame been drawn? |
is_bounding | Does this object obey bounding rules? |
bounding_type | The BoundingMode rules to which this object adheres. |
container | The Frame that contains this one. |
components | A list of Components this Frame contains. |
mini_consoles | Stores MiniConsole Components. |
compounds | Stores Compounds. |
frames | A list of Frames this Frame contains. |
callback | The name of a function to be used as a Label callback. |
callback_args | A table holding the arguments for a Label callback. |
position | The Position Supercomponent managing this Frame’s location. |
size | The Size Supercomponent managing this Frame’s space. |
stylesheet | This Frame’s Stylesheet. |
Functions and Properties | |
updateStylesheet | Polls all Component’s for their Stylesheets. |
Frame Properties | |
Add | Adds a new object to this Frame. |
Remove | Removes an object from this Frame. |
Draw | Draws this Frame. |
Resize | Resizes the Frame. |
Move | Repositions the Frame. |
Hide | Hides the Frame. |
Show | Reveals the Frame. |
Echo | Displays text on a Frame. |
Echo | Displays text on a Frame. |
Clear | Clears all text from the Frame. |
local bounding_type
The BoundingMode rules to which this object adheres.
local stylesheet
This Frame’s Stylesheet. Generated via updateStylesheet.
local function updateStylesheet ()
Polls all Component’s for their Stylesheets. Constructs the final stylesheet applied by setLabelStyleSheet.
Used for very specific handling of the master Vyzor HUD.
local first_frame
Determines whether or not the resize function has been registered as an event handler.
local resize_registered
Holds all Frames for reference.
local master_list
local function new ( _, name, x, y, width, height )
Is this the HUD?
local is_first
Has this Frame been drawn?
local is_drawn
Does this object obey bounding rules?
local is_bounding
The BoundingMode rules to which this object adheres.
local bounding_type
The Frame that contains this one.
local container
A list of Components this Frame contains.
local components
Stores MiniConsole Components.
local mini_consoles
Stores Compounds.
local compounds
A list of Frames this Frame contains.
local frames
The name of a function to be used as a Label callback.
local callback
A table holding the arguments for a Label callback.
local callback_args
The Position Supercomponent managing this Frame’s location.
local position
The Size Supercomponent managing this Frame’s space.
local size
This Frame’s Stylesheet.
local stylesheet
Polls all Component’s for their Stylesheets.
local function updateStylesheet ()
Adds a new object to this Frame.
function new_frame:Add ( object )
Removes an object from this Frame.
function new_frame:Remove ( object )
Draws this Frame.
function new_frame:Draw ()
Resizes the Frame.
function new_frame:Resize ( new_width, new_height )
Repositions the Frame.
function new_frame:Move ( new_x, new_y )
Hides the Frame.
function new_frame:Hide ()
Reveals the Frame.
function new_frame:Show ()
Displays text on a Frame.
function new_frame:Echo ( text )
Clears all text from the Frame.
function new_frame:Clear ( do_children )