Преглед на файлове

Doc changes for RayInfo distance

Doc changes for the containerRayCast DefineEngineFunction to include the
distance.
Steven Saric преди 13 години
родител
ревизия
ac9d24deb4
променени са 1 файла, в които са добавени 2 реда и са изтрити 1 реда
  1. 2 1
      Engine/source/scene/sceneContainer.cpp

+ 2 - 1
Engine/source/scene/sceneContainer.cpp

@@ -1612,7 +1612,8 @@ DefineEngineFunction( containerRayCast, const char*,
    "@returns A string containing either null, if nothing was struck, or these fields:\n"
    "@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>"
    "<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 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")
    "@ingroup Game")
 {
 {