Mirror/opentx
1
0
Fork 0
mirror of https://github.com/opentx/opentx.git synced 2025-07-21 15:25:17 +03:00
Code Issues Wiki Activity

Fixes #4129: error in lua documentation of model.setGlobalVariable for flight mode parameter

Browse source
This commit is contained in:
Damjan Adamic 2016-12-16 19:21:38 +01:00
parent a7e7050af3
commit d6d91b5798
1 changed files with 11 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

24
radio/src/lua/api_model.cpp
View file

@ -1043,7 +1043,7 @@ static int luaModelSetOutput(lua_State *L)
} }
/*luadoc /*luadoc
@function model.getGlobalVariable(index [, phase]) @function model.getGlobalVariable(index [, flight_mode])
Return current global variable value Return current global variable value
@ -1051,7 +1051,7 @@ Return current global variable value
@param index zero based global variable index, use 0 for GV1, 8 for GV9 @param index zero based global variable index, use 0 for GV1, 8 for GV9
@param phase zero based phase index, use 0 for Phase 1, 5 for Phase 6 @param flight_mode Flight mode number (0 = FM0, 8 = FM8)
@retval nil requested global variable does not exist @retval nil requested global variable does not exist
@ -1060,7 +1060,7 @@ Return current global variable value
Example: Example:
```lua ```lua
-- get GV3 (index = 2) from flight phase 1 (phase = 0) -- get GV3 (index = 2) from Flight mode 0 (FM0)
val = model.getGlobalVariable(2, 0) val = model.getGlobalVariable(2, 0)
``` ```
*/ */
@ -1076,22 +1076,20 @@ static int luaModelGetGlobalVariable(lua_State *L)
} }
/*luadoc /*luadoc
@function model.setGlobalVariable(index, phase, value) @function model.setGlobalVariable(index, flight_mode, value)
Sets current global variable value. See also model.getGlobalVariable() Sets current global variable value. See also model.getGlobalVariable()
@param index zero based global variable index, use 0 for GV1, 8 for GV9 @param index zero based global variable index, use 0 for GV1, 8 for GV9
@param phase zero based phase index, use 0 for Phase 1, 5 for Phase 6 @param flight_mode Flight mode number (0 = FM0, 8 = FM8)
@param value new value for global variable. Permitted range is
from -1024 to 1024.
@notice If a parameter is missing from the value, then
that parameter remains unchanged.
@notice Global variable can only store integer values, @param value new value for global variable. Permitted range is
any floating point value is converted (todo check how) into integer value. from -1024 to 1024.
@notice Global variable can only store integer values,
any floating point value is converted into integer value
by truncating everything behind a floating point.
*/ */
static int luaModelSetGlobalVariable(lua_State *L) static int luaModelSetGlobalVariable(lua_State *L)
{ {