Rows
Members
catched
desc: Whether or not the members have already been calculate.
type: bool
default: false
expanders
desc: A collection of the sum of vertical GridGUI.Cell expansion weights of each GridGUI.Row in GridGUI.Rows.rows.
type: associative array
default: {}
meta: [object, cached]
expandersMaxValue
desc: A collection of the maximum vertical GridGUI.Cell expansion weight of each GridGUI.Row in GridGUI.Rows.rows.
type: associative array
default: {}
meta: [object, cached]
fixedHeights
desc: A collection of the fixed height of each GridGUI.Row in GridGUI.Rows.rows.
type: associative array
default: {}
meta: [object, cached]
minHeights
desc: A collection of the min height of each GridGUI.Row in GridGUI.Rows.rows.
type: associative array
default: {}
meta: [object, cached]
nonExpanders
desc: A collection of the amount of vertically fixed GridGUI.Cells in each GridGUI.Row in GridGUI.Rows.rows.
type: associative array
default: {}
meta: [object, cached]
rows
desc: A collection of the GridGUI.Rows where one or more GridGUI.Cells have been placed. That is only used rows are generated.
type: associative array
default: {}
meta: [object]
Methods
Add
Add(c)
Adds a GridGUI.Cell to the GridGUI.Rows that it spans over. If the GridGUI.Rows are not already in GridGUI.Rows.rows they are added before adding the cell.
parameters
CalculateConstants
CalculateConstants()
Calculates the values for the GridGUI.Rows members that are cached.
CalculateHeights
CalculateHeights(height, expandersH, nonExpandersH, width, expandersW, nonExpandersW)
Calculates the part of the available height that each GridGUI.Row in GridGUI.Rows.rows will get.
parameters
name: height
desc: The height of the grid. That is the height that the grid should fill.
type: number
name: width
desc: The unclaimed width of the grid. That is the width of the grid that is left after removing the width of the fixed cells.
type: number
return value
desc: The calculated heights of the GridGUI.Rows in GridGUI.Rows.rows.
type: associative array
GetFixedHeight
GetFixedHeight()
Returns the sum of the fixed heights of the GridGUI.Rows in GridGUI.Rows.rows.
return value
desc: The sum of the fixed heights of the GridGUI.Rows in GridGUI.Rows.rows.
type: number
GetMinHeight
GetMinHeight()
Returns the sum of the minimal heights of the GridGUI.Rows in GridGUI.Rows.rows.
return value
desc: The sum of the minimal heights of the GridGUI.Rows in GridGUI.Rows.rows.
type: number
ReduceToGuiSize
ReduceToGuiSize(heights, expandedHeights, sumExpandedHeights, excessHeight)
Fixes miscalculations in the height of expanding GridGUI.Cells by reducing their height down until they all fit in the available height or all have reach their min height. The reduction is done starting with the tallest GridGUI.Row to the shortest.
parameters
name: heights
desc: The calculated heights for the GridGUI.Rows in GridGUI.Rows.rows.
type: associative array
name: expandedHeights
desc: An array of the heights of GridGUI.Rows with one or more vertically expanding GridGUI.Cell if the current height in heights corresponding to the row is larger than the minimum of the row otherwise it wont be included in the expandedHeights
type: array
name: sumExpandedHeights
desc: The sum of the heights in expandedHeights.
type: number
name: excessHeight
desc: The amount of height that the sum of heights would exceed the height of the grid/gui.
type: number
Remove
Remove(c)
Removes a GridGUI.Cell from the GridGUI.Rows that it spans over. If the GridGUI.Rows are empty after removing the cell the row will be removed as well.