Skip to content

Commit c5d5a93

Browse files
committed
address feedback
1 parent f0ee1e2 commit c5d5a93

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

code/scripting/lua/LuaUtil.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,10 @@ void tableToList(LuaTable& table, Container& list) {
9393
const char* getValueName(ValueType type);
9494

9595
/**
96-
* Processes a LuaValue and returns a vec3d. The LuaValue could be a Vector, an array with three elements, or a table with x/X, y/Y, and z/Z entries.
96+
* Processes a LuaValue and returns a vec3d. Variants of LuaValue that are understood by this function are:
97+
* a) a Vector object, e.g. something returned from ba.createVector()
98+
* b) an array with three elements, e.g. {0.0, 0.0, 0.0}
99+
* c) a table with x/X, y/Y, and z/Z entries, e.g. {'x': 0.0, 'y': 0.0, 'z': 0.0}
97100
*
98101
* Throws a LuaException if the conversion was not successful.
99102
*/

0 commit comments

Comments
 (0)