Differences

This shows you the differences between two versions of the page.

--- maxrects-lua [2021/02/13 08:21]
muragami
+++ maxrects-lua [2021/02/13 10:21] (current)
muragami [:insertCollection(collect,sort)]
@@ Line 130: / Line 130: @@
 Inserts a rectangle into the collection, using the algorithm to assign a location. If the rectangle can't fit, returns false.
+==== :insertRect(rect) ====
+  * **rect**: The rectangle to insert. X/Y([0]/[1]) are ignored, only Width([3]) and Height([4]) count.
+  * **return**: Boolean. True if the rectangle was inserted, False if it didn't fit.
+Inserts a rectangle into the collection, using the algorithm to assign a location. If the rectangle can't fit, returns false. Copies .data into the stored node in the collection.
+==== :insertCollection(collect,sort) ====
+  * **collect**: A table array of rectangles to insert into the collection (see [[#:insertRect(rect)]])
+  * **//sort//**: //optional// A method to sort the rectangles before insert.
+  * **return**: Boolean, Number. True if all were inserted, False if only some fit. The number is the amount added.
+Inserts rectangles into the collection, from an array table. If you define sort to one of: 'SortArea', 'SortShortSide', or 'SortLongSide' it will sort them from biggest to smallest using that method before inserting. If you pass anything else as sort, it'll throw an error. Note: If you pass a sort, then **table.sort() is applied to collect, so it's order might/will be changed by this function.**
 ==== :occupancy() ====

Muragami's Project Docs