Class Position

A Supercomponent, for use only with Frames.

Responsible for managing the coordinate positioning of the Frame within its parent.

Methods

Position:Position (_frame[, initialX=0][, initialY=0], _isFirst) Position constructor.

Properties

self.Coordinates.get () Returns the user-defined coordinates of the Frame.
self.Coordinates.set (value) Sets the user-defined coordinates of the Frame.
self.Absolute.get () Returns the actual coordinates of the Frame.
self.Content.get () Returns the content coordinates of the Frame.
self.X.get () Returns the user-defined X coordinate of the Frame.
self.X.set (value) Sets the user-defined X coordinate of the Frame.
self.Y.get () Returns the user-defined Y coordinate of the Frame.
self.Y.set (value) Sets the user-defined Y coordinate of the Frame.
self.AbsoluteX.get () Returns the actual X coordinate of the Frame.
self.AbsoluteY.get () Returns the actual Y coordinate of the Frame.
self.ContentX.get () Returns the X coordinate of the Frame content.
self.ContentY.get () Returns the Y coordinate of the Frame content.


Methods

Position:Position (_frame[, initialX=0][, initialY=0], _isFirst)
Position constructor.

Parameters:

  • _frame Frame The Frame to which this Supercomponent belongs.
  • initialX number The initial x coordinate position. (default 0)
  • initialY number The initial y coordinate position. (default 0)
  • _isFirst bool Determines whether or not the parent Frame is the HUD.

Returns:

    Position

Properties

self.Coordinates.get ()
Returns the user-defined coordinates of the Frame.

Returns:

    table
self.Coordinates.set (value)
Sets the user-defined coordinates of the Frame.

Parameters:

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

Returns:

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

Returns:

    table
self.X.get ()
Returns the user-defined X coordinate of the Frame.

Returns:

    number
self.X.set (value)
Sets the user-defined X coordinate of the Frame.

Parameters:

  • value number
self.Y.get ()
Returns the user-defined Y coordinate of the Frame.

Returns:

    number
self.Y.set (value)
Sets the user-defined Y coordinate of the Frame.

Parameters:

  • value number
self.AbsoluteX.get ()
Returns the actual X coordinate of the Frame.

Returns:

    number
self.AbsoluteY.get ()
Returns the actual Y coordinate of the Frame.

Returns:

    number
self.ContentX.get ()
Returns the X coordinate of the Frame content.

Returns:

    number
self.ContentY.get ()
Returns the Y coordinate of the Frame content.

Returns:

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