library-mirrors/HC
1
0
Fork 0
mirror of https://github.com/vrld/HC.git synced 2024-11-18 12:54:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update MainModule.rst

Browse Source
This commit is contained in:
vrld 2016-07-06 14:51:11 +02:00 committed by GitHub
parent eac8874ef9
commit 92fb6a607f
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/MainModule.rst
View File

@ -67,11 +67,19 @@ not be able to find any collisions with those shapes anymore.
Bookkeeping Shapes
----------- ------
See also the :doc:`Shapes` sub-module. See also the :doc:`Shapes` sub-module.
.. note::
HC will only keep `weak references
<https://www.lua.org/manual/5.1/manual.html#2.10.2>`_ to the shapes you add
to the world. This means that if you don't store the shapes elsewhere, the
garbage collector will eventually come around and remove these shapes.See
also `this issue <https://github.com/vrld/HC/issues/44>`_ on github.
.. function:: HC.rectangle(x, y, w, h) .. function:: HC.rectangle(x, y, w, h)