1
0
Fork 0
mirror of https://github.com/ctruLua/ctruLua.git synced 2025-10-27 16:39:29 +00:00

Fixed the QTM documentation, Added an usage note about indexing an object with a number

This commit is contained in:
Firew0lf 2015-09-12 19:57:28 +02:00
parent 337b19f9a7
commit ab06123f7a

View file

@ -119,8 +119,8 @@ Convert QTM coordinates to screen coordinates
@function convertCoordToScreen @function convertCoordToScreen
@tparam qtmInfos qtmInfos QTM informations @tparam qtmInfos qtmInfos QTM informations
@tparam number coordinates index @tparam number coordinates index
@tparam number [screenWidth] specify a screen width (default `400`) @tparam[opt=400] number screenWidth specify a screen width
@tparam number [screenHeight] specify a screen height (default `320`) @tparam[opt=320] number screenHeight specify a screen height
@treturn number screen X coordinate @treturn number screen X coordinate
@treturn number screen Y coordinate @treturn number screen Y coordinate
*/ */
@ -160,16 +160,17 @@ Check if the head is fully detected
Convert QTM coordinates to screen coordinates Convert QTM coordinates to screen coordinates
@function :convertCoordToScreen @function :convertCoordToScreen
@tparam number coordinates index @tparam number coordinates index
@tparam number [screenWidth] specify a screen width (default `400`) @tparam[opt=400] number screenWidth specify a screen width
@tparam number [screenHeight] specify a screen height (default `320`) @tparam[opt=320] number screenHeight specify a screen height
@treturn number screen X coordinate @treturn number screen X coordinate
@treturn number screen Y coordinate @treturn number screen Y coordinate
*/ */
/*** /***
When the object is indexed with a number from 1 to 4, it returns a coordinate When the object is indexed with a number from 1 to 4, it returns the coordinates
of one of the headtracker point. of one of the headtracker points.
@tfield number index coordinates, as two numbers (not a table) @tfield number index coordinates, as two numbers (not a table)
@usage coordX, coordY = qtmInfos[index]
*/ */
// object // object