Lua Documentation 2.0

Matrix Games Forums

Forums Register Login Photo Gallery Member List Search Calendars FAQ

My Profile Inbox Address Book My Subscription My Forums Log Out

Lua Documentation 2.0

View related threads: (in this forum | in all forums)

Logged in as: Guest

Users viewing this topic: none

Printable Version

All Forums >> [New Releases from Matrix Games] >> Command: Modern Operations series >> Lua Documentation 2.0

Page: [1]

Message

<< Older Topic Newer Topic >>

Lua Documentation 2.0 - 4/17/2020 9:47:03 AM

Rory Noonan

Posts: 2719
Joined: 12/18/2014
From: Brooklyn, NY
Status: offline

After 5 years using the LDoc format, the Command Lua API Documentation struts into the 2020's with a sleek new interface, inspired by industry leaders in web documentation. The new look is accompanied by an extensive re-write and reorganisation of existing content, consolidation of content from various sources, and brand new content to assist Lua newbies and pros alike in their Command Lua adventures.

It's a live document, and improvements will be made daily for the next few months to improve useability.

Check it out at https://commandlua.github.io/

_____________________________

Post #: 1

RE: Lua Documentation 2.0 - 4/17/2020 11:10:12 AM

TitaniumTrout

Posts: 312
Joined: 10/20/2014
From: Michigan
Status: offline

Great work Apache, really like the color coding. Bravo!

_____________________________

CMO WIKI - http://wiki.weaponsrelease.com

(in reply to Rory Noonan)

Post #: 2

RE: Lua Documentation 2.0 - 4/17/2020 12:00:40 PM

SeaQueen

Posts: 1289
Joined: 4/14/2007
From: Washington D.C.
Status: offline

Gorgeous!

(in reply to Rory Noonan)

Post #: 3

RE: Lua Documentation 2.0 - 4/17/2020 5:52:27 PM

c3k

Posts: 315
Joined: 4/25/2017
Status: offline

Wow. I've never done ANYTHING with Lua, but after looking at that page, I'm thinking it's a pretty cool thing.

(in reply to SeaQueen)

Post #: 4

RE: Lua Documentation 2.0 - 4/17/2020 7:49:39 PM

Primarchx

Posts: 3094
Joined: 1/20/2013
Status: offline

Wonderful!

(in reply to c3k)

Post #: 5

RE: Lua Documentation 2.0 - 4/17/2020 8:24:10 PM

KnightHawk75

Posts: 775
Joined: 11/15/2018
Status: offline

Nice work.

Also very much appreciate you left a link to the old format.

Suggestions:
-Mark the following as *Professional Edition* only. (or cough cough remove restriction?

)
ScenEdit_ImportScenarioFromXML()
ScenEdit_ExportScenarioToXML()

- The top section CommandLUA takes up a lot of screen real estate for in my opinion little or no value, can it be shrunk or eliminated allowing more to be seen in the scrolling area? (The prior version showed more per screen\scroll)

- The left margin side wastes inch or two of white space, can this be reduced, or swap the right margin menu to the left margin and shrink the right margin, as that might also reduce the number of lateral scroll bars that have to appear for examples?

- Some examples aren't wrapping or maybe just missing carriage returns. (examples VP_GetSides,VP_GetContacts)

- ZoneMarker states:
"Zone marker fields are the same as a ReferencePoint marker."
I think that should say ReferencePoint wrapper and link to #wrapper_ReferencePoint while also noting that said ZoneMarker table will include the same fields, but NOT the 'side' field. Been meaning to mention this for awhile.

- Unit Wrapper: add the largely undocumented updateorbit method applicable to satellites.
Buried in the forums\release notes (1.15.2) is a way to set\update TLE on an existing satellite, any chance of getting a \ the working example documented in the lua docs? ref: http://www.matrixgames.com/forums/fb.asp?m=4726924

- Things that contain list of codes (wra type,stance,targettypewra,size,etc) perhaps a 'click for list' indicator or a color change to indicate click to show list is in order? Also the fact their not shown by default makes quick searching via the browser for the name or code problematic.

< Message edited by KnightHawk75 -- 4/17/2020 8:31:56 PM >

(in reply to c3k)

Post #: 6

RE: Lua Documentation 2.0 - 4/17/2020 8:34:56 PM

Gunner98

Posts: 4813
Joined: 4/29/2005
From: The Great White North!
Status: offline

Wow - that is fantastic! Thanks

_____________________________

Check out our novel, Northern Fury: H-Hour!: http://northernfury.us/
And our blog: http://northernfury.us/blog/post2/
Twitter: @NorthernFury94 or Facebook https://www.facebook.com/northernfury/

(in reply to KnightHawk75)

Post #: 7

RE: Lua Documentation 2.0 - 4/18/2020 3:30:51 PM

kevinkins