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

Added documentation for raycast function

Browse Source
This commit is contained in:
rzvxa 2023-08-18 21:40:48 +03:30
parent 2eecdb452f
commit c40c8fba05
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/MainModule.rst
View File

@ -254,6 +254,25 @@ You can iterate over the shapes using ``pairs`` (see example).
game.selectUnit(s)
end
.. function:: HC.raycast(x, y, dx, dy, range)
:param numbers x,y: Origin point of ray
:param numbers dx,dy: Direction vector of ray(normal vector)
:param number range: Range of raycast
:returns: Table of shapes that got hit and its hit points.
Gets shapes that got hit by a given ray and the points which that shape intersects with the ray.
The table is a *set*, meaning that the shapes are stored in *keys* of the table. The values are the points of intersection. You can iterate over the shapes using ``pairs`` (see example).
**Example**::
local hits = HC.raycast(originx, originy, directionx, directiony, range)
for shape, points in pairs(hits) do
for _, point in ipairs(points) do
love.graphics.points(point.x, point.y)
end
end
.. function:: HC.hash()