equal
deleted
inserted
replaced

1 #summary Lua library documentation: Utils 

2 #labels LuaLibrary 

3 

4 == Lua library: `Utils` == 

5 

6 **NOTE: Documentation of this library is incomplete, some functions are still undocumented.** 

7 

8 This library includes miscellaneous functions to use, they are all independent of each other and can be used everywhere. 

9 

10 === `gearIsInBox(gear, x, y, w, h)` === 

11 

12 Returns whether the gear is inside (centre point of the gear) a box with x and y as the top left corner and having the width and height of w and h respectively. 

13 

14 

15 === `gearIsInCircle(gear, x, y, r, useRadius)` === 

16 

17 Returns whether the gear is inside a circle with x and y being the centre point and r being the radius of the circle. The boolean useRadius determine whether only the centre point of the gear will be used or the radius of the gear will be checked too. 