Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

invaders: add luadoc comments 

this commit adds luadoc comments right before invaders.run() so that all
its parameters are explained in luadoc.
This commit is contained in:
Gregor Best 2008-10-21 19:28:45 +02:00 committed by Julien Danjou
parent c846da24e1
commit 7041a4680d
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lib/invaders.lua.in
View File

@ -450,6 +450,12 @@ function game.highscore (score)
end end
end end
--- Run Awesome Invaders
-- @param args A table with parameters.
-- x the X coordinate of the playing field.
-- y the Y coordinate of the playing field.
-- if either of these is left out, the game is placed in the center of the focused screen.
-- solidbg the background color of the playing field. If none is given, the playing field is transparent.
function run(args) function run(args)
gamedata.screen = capi.screen[capi.mouse.screen] gamedata.screen = capi.screen[capi.mouse.screen]
gamedata.field.x = gamedata.screen.geometry.x + math.floor((gamedata.screen.geometry.width - gamedata.field.w) / 2) gamedata.field.x = gamedata.screen.geometry.x + math.floor((gamedata.screen.geometry.width - gamedata.field.w) / 2)