Doc changes for RayInfo distance

Doc changes for the containerRayCast DefineEngineFunction to include the
distance.
This commit is contained in:
Steven Saric 2012-10-06 13:15:09 +08:00
parent 75baf20d5f
commit ac9d24deb4

View file

@ -1612,7 +1612,8 @@ DefineEngineFunction( containerRayCast, const char*,
"@returns A string containing either null, if nothing was struck, or these fields:\n"
"<ul><li>The ID of the object that was struck.</li>"
"<li>The x, y, z position that it was struck.</li>"
"<li>The x, y, z of the normal of the face that was struck.</li></ul>"
"<li>The x, y, z of the normal of the face that was struck.</li>"
"<li>The distance between the start point and the position we hit.</li></ul>"
"@ingroup Game")
{