Page 3 of 4
Re: LÖVE-API Documentation (as a lua table)
Posted: Tue Jul 28, 2015 12:48 pm
by rmcode
Re: LÖVE-API Documentation (as a lua table)
Posted: Sat Dec 05, 2015 11:09 am
by rmcode
Small heads-up about a change in structure: I decided to move all enums and types to separate files (makes it a bit easier for me to keep the whole thing up to date). You should still be able to use the API as before though.
The structure looks like this now:
Code: Select all
love_api.lua
> modules
> audio
audio.lua
> enums
DistanceModel.lua
...
> types
Source.lua
> event
> filesystem
...
Re: LÖVE-API Documentation (as a lua table)
Posted: Sun Dec 27, 2015 6:21 pm
by s-ol
May I suggest that instead of structuring things like
Code: Select all
modules.keyboard.Keyboard
modules.keyboard.enums.KeyConstant
you put the main files as init.lua?
Code: Select all
modules.keyboard (modules/keyboard/init.lua) requires
modules.keyboard.enums (modules/keyboard/enums/init.lua) returns
modules.keyboard.enums.KeyConstant
or something like that. At least I find it weird that modules.keyboard.Keyboard exists.
Re: LÖVE-API Documentation (as a lua table)
Posted: Mon Dec 28, 2015 10:45 pm
by rmcode
S0lll0s wrote:At least I find it weird that modules.keyboard.Keyboard exists.
True, but it's just a simple way of structuring the whole thing. Personally I don't really mind since the require statements are just needed inside of the doc itself.
Hmm ... Unless you want to require them on their own for some reason?
Anyway I'd be open for a pull request
Re: LÖVE-API Documentation (as a lua table)
Posted: Tue Dec 29, 2015 12:31 am
by s-ol
rmcode wrote:S0lll0s wrote:At least I find it weird that modules.keyboard.Keyboard exists.
True, but it's just a simple way of structuring the whole thing. Personally I don't really mind since the require statements are just needed inside of the doc itself.
Hmm ... Unless you want to require them on their own for some reason?
Anyway I'd be open for a pull request
I'll put something together tomorrow if I remember to...
Re: LÖVE-API Documentation (as a lua table)
Posted: Tue Jan 26, 2016 7:56 am
by Santos
Thanks to rmcode and contributors I've been able to update my one-page reference to 0.10.0. Edit: New location:
http://love2d-community.github.io/love-api/
Re: LÖVE-API Documentation (as a lua table)
Posted: Wed Jan 27, 2016 9:46 am
by rmcode
Santos wrote:Thanks to rmcode and contributors I've been able to update my one-page reference to 0.10.0:
http://loveref.github.io/
Very nice
I finally added travis-ci integration to check the integrity of the api-table (missing brackets, old require statements, etc.). I use busted for testing.
Currently the test is really simple:
Code: Select all
describe( 'LÖVE-API Integrity test', function()
it( 'makes sure the api table is valid', function()
local api = require( 'love_api' )
assert( api )
end)
end)
But it could be extended to make sure the tables are filled correctly (e.g. arguments are kept in a sub-table and so on).
Re: LÖVE-API Documentation (as a lua table)
Posted: Fri Feb 12, 2016 3:39 pm
by rmcode
The api has been transferred to the
LÖVE organisation on github.
Re: LÖVE-API Documentation (as a lua table)
Posted: Fri Feb 12, 2016 10:32 pm
by pgimeno
Nice! Updating the
list of libraries to reflect that would be a good idea.
Re: LÖVE-API Documentation (as a lua table)
Posted: Sat Feb 13, 2016 12:04 am
by rmcode
Done.