The Lua Documentation has been released by Data. In which he describes every single function. I've taken the time to format all these objects and functions into the existing structure, and it can be found in the below link. Moving over the actual description arguments and return arguments is appreciated to their counterpart on the formatted side of the wiki.Official Cortex Command Documentation

Joined: Wed Dec 13, 2006 5:27 amPosts: 3134Location: A little south and a lot west of Moscow

Re: Lua Documentation

The LuaDocs page on the wiki is automatically updated by a script Data made -- it pulls straight from documentation in the source code. There's some chunks missing, and he's currently trying to figure out why they aren't showing up. Unfortunately, due to the nature of the script, any edits will be overwritten whenever he runs it. I'm not sure whether that'll cause a problem, but I figured I should at least let you know.

Thu Jun 07, 2012 11:51 pm

Daman

Joined: Fri Jan 26, 2007 3:22 amPosts: 1450

Re: Lua Documentation

That's good to hear, actually. I could write a script to pull descriptions and methods into the formatted entries. It'd be nice if the argument entries for methods were formatted somehow(like, for example, it said (string) DESCRIPTION or (int) DESCRIPTION). I'd like to have the formatted area up to date because I think having lua-examples for each method is really helpful in understanding how it they are used.

Fri Jun 08, 2012 1:01 am

TheLastBanana

DRL Developer

Joined: Wed Dec 13, 2006 5:27 amPosts: 3134Location: A little south and a lot west of Moscow

Re: Lua Documentation

Yeah, that would be really useful. Adding that to Data's script is pretty unlikely until after 1.0, since we're basically in crunch time at the moment, but I'd love to see it implemented in the near future.

Who is online

Users browsing this forum: No registered users

You cannot post new topics in this forumYou cannot reply to topics in this forumYou cannot edit your posts in this forumYou cannot delete your posts in this forumYou cannot post attachments in this forum