Class Size

A Supercomponent used only within Frames to manage space.

Methods

Size:Size (_frame[, initialWidth=1.0][, initialHeight=1.0], _isFirst) Size constructor.

Properties

self.Dimensions.get () Returns the user-defined dimensions of the Frame.
self.Dimensions.set (value) Sets the user-defined dimensions of the Frame.
self.Absolute.get () Returns the actual dimensions of the Frame.
self.Content.get () Returns the content dimensions of the Frame.
self.Width.get () Returns the user-defined width of the Frame.
self.Width.set (value) Sets the user-defined width of the Frame.
self.Height.get () Returns the user-defined height of the Frame.
self.Height.set (value) Sets the user-defined height of the Frame.
self.AbsoluteWidth.get () Returns the actual width of the Frame.
self.AbsoluteHeight.get () Returns the actual height of the Frame.
self.ContentWidth.get () Returns the width of the Frame's content.
self.ContentHeight.get () Returns the height of the Frame's content.


Methods

Size:Size (_frame[, initialWidth=1.0][, initialHeight=1.0], _isFirst)
Size constructor.

Parameters:

  • _frame Frame The Frame to which this Size Supercomponent belongs.
  • initialWidth number Initial width of the Frame. (default 1.0)
  • initialHeight number Initial height of the Frame. (default 1.0)
  • _isFirst bool Determines whether or not the parent Frame is the HUD.

Returns:

    Size

Properties

self.Dimensions.get ()
Returns the user-defined dimensions of the Frame.

Returns:

    table
self.Dimensions.set (value)
Sets the user-defined dimensions of the Frame.

Parameters:

self.Absolute.get ()
Returns the actual dimensions of the Frame.

Returns:

    table
self.Content.get ()
Returns the content dimensions of the Frame.

Returns:

    table
self.Width.get ()
Returns the user-defined width of the Frame.

Returns:

    number
self.Width.set (value)
Sets the user-defined width of the Frame.

Parameters:

  • value number
self.Height.get ()
Returns the user-defined height of the Frame.

Returns:

    number
self.Height.set (value)
Sets the user-defined height of the Frame.

Parameters:

  • value number
self.AbsoluteWidth.get ()
Returns the actual width of the Frame.

Returns:

    number
self.AbsoluteHeight.get ()
Returns the actual height of the Frame.

Returns:

    number
self.ContentWidth.get ()
Returns the width of the Frame's content.

Returns:

    number
self.ContentHeight.get ()
Returns the height of the Frame's content.

Returns:

    number
generated by LDoc 1.4.6 Last updated 2017-11-15 22:27:55