Offline LÖVE documentation for download

General discussion about LÖVE, Lua, game development, puns, and unicorns.
Post Reply
Santos
Party member
Posts: 375
Joined: Sat Oct 22, 2011 7:37 am

Re: Offline LÖVE documentation for download

Post by Santos » Tue Aug 07, 2012 10:18 am

:ultrahappy: Thank you all, I'm really happy it's useful!

It has been updated!

Öbey
Prole
Posts: 13
Joined: Wed Aug 08, 2012 7:18 am

Re: Offline LÖVE documentation for download

Post by Öbey » Mon Aug 13, 2012 10:20 am

Code: Select all

<html>
<head>
<meta http-equiv="Refresh" content="0; url=jar:docs.zip!/wiki/index.html" />
</head>
<body>
<a href="jar:docs.zip!/wiki/index.html">Löve Wiki</a>
</body>
</html>
Save this as docs.html
Put it in the same folder with docs.zip
Open docs.html with Firefox.
You should be able to view docs.zip without extracting its contents.

User avatar
BlackBulletIV
Inner party member
Posts: 1260
Joined: Wed Dec 29, 2010 8:19 pm
Location: Queensland, Australia
Contact:

Re: Offline LÖVE documentation for download

Post by BlackBulletIV » Mon Oct 01, 2012 2:58 am

I've used Santos's excellent API script to generate a regular expression for a Love2D language definition. Since I thought you guys may find it useful, I've attached the files below.

There were a couple mistakes with API script which I've corrected:
  • love.graphics.newStencil's name wasn't set to "newStencil" but the full "love.graphics.newStencil".
  • love.physics.setMeter wasn't present, so I added it manually.
Attachments
api_pattern.zip
Added love.physics.setMeter
(41.54 KiB) Downloaded 283 times

paulclinger
Party member
Posts: 216
Joined: Thu Jun 28, 2012 8:46 pm

Re: Offline LÖVE documentation for download

Post by paulclinger » Wed Nov 14, 2012 12:47 am

Santos, thank you for the update. I notice couple of things that seem to be incorrect in the most recent file:

Code: Select all

					name = 'pause',
					description = 'Pauses all audio',
					functions = {
						{}, --<-- this one
						{
This section should not have the first "{}," group. This applies to pause, resume, rewind, stop (note that there are two groups, the first one is correct), setColor, and setScissor.

Also, there were several names that have spaces in them, like 'inverse clamped', 'linear clamped', and 'exponent clamped'. Not sure if it was intentional.

Santos
Party member
Posts: 375
Joined: Sat Oct 22, 2011 7:37 am

Re: Offline LÖVE documentation for download

Post by Santos » Wed Nov 14, 2012 1:49 am

The functions that you mention actually have a variant when called with no arguments, for example calling love.audio.pause() will pause all audio, and calling love.graphics.setScissor() will disable the scissor.

Thanks for pointing it out, it made me realise that there was an inconsistency with some other functions which have variants like this, so now the information about what calling these functions without arguments does has been moved into the description of the function.

And the distance model names actually do have spaces in them, I think. :ultraglee:

And it's been updated again just now.

Thanks for letting me know what seems out of place, and if you find anything else, please let me know!

And thanks BlackBulletIV for noticing those errors!

^^

User avatar
IndieKid
Citizen
Posts: 80
Joined: Sat Dec 22, 2012 7:05 pm
Contact:

Re: Offline LÖVE documentation for download

Post by IndieKid » Tue Jan 15, 2013 8:51 pm

Do anyone know if there is(or is there a way to create) offline LÖVE wiki for iOS?

Santos
Party member
Posts: 375
Joined: Sat Oct 22, 2011 7:37 am

Re: Offline LÖVE documentation for download

Post by Santos » Sun May 26, 2013 3:05 pm

Here's another one page HTML reference. It's... experimental. :ultraglee: For 0.8.0.

Hover over the function names, arguments, and return values for information.
Attachments
love_reference.zip
(15.21 KiB) Downloaded 284 times
generate_love_reference.lua
(95.23 KiB) Downloaded 220 times
Last edited by Santos on Sun Dec 15, 2013 10:02 am, edited 1 time in total.

Mikaboshi
Prole
Posts: 12
Joined: Mon Jul 22, 2013 8:55 pm

Re: Offline LÖVE documentation for download

Post by Mikaboshi » Wed Jul 31, 2013 10:45 am

Santos wrote:Here is the LÖVE API as a Lua table.

It may not be complete or totally accurate! ^^

generate_love_snippets.lua is a Lua script which generates snipMate (for Vim) snippets from the LÖVE API table.
Hi Santos, do you mind divulging how you generated love_api.lua? Or was that hand-made? I'm using 0.9.0 nightly, and since ZBStudio uses your love_api.lua for autocompletion and calltips, it would be nice to update it.

Santos
Party member
Posts: 375
Joined: Sat Oct 22, 2011 7:37 am

Re: Offline LÖVE documentation for download

Post by Santos » Fri Aug 02, 2013 3:07 am

It was actually hand-made, haha. A whole lot of copy and pasting. :ultraglee:

I plan on updating it once 0.9.0 is released, but I might wait until then since the API is changing a bit, and so I can get the information from the wiki, hehe.

Mikaboshi
Prole
Posts: 12
Joined: Mon Jul 22, 2013 8:55 pm

Re: Offline LÖVE documentation for download

Post by Mikaboshi » Fri Aug 02, 2013 7:19 am

Santos wrote:It was actually hand-made, haha. A whole lot of copy and pasting. :ultraglee:

I plan on updating it once 0.9.0 is released, but I might wait until then since the API is changing a bit, and so I can get the information from the wiki, hehe.
Oh wow, thanks for hand-making the files then! And yeah, definitely wait until it is released. There may be some more large changes coming down the pipeline.

Post Reply

Who is online

Users browsing this forum: DekuJuice and 9 guests