New Functions and Command Lua Documentation

[jkgarner]

OK, I went out to the Command Lua page (https://commandlua.github.io/index.html) and noticed a bunch of new functions added to the documentation. This is not surprising, as the guys and gals at Matrix keep working on improving the system. A I also happen to know that they are working on some excellent capabilities, funded by the US Marines. This will greatly improve the game experience for all users.

The following list are the functions that stood out to me as being new. Now, I have to admit, that while I look at the function list frequently, my memory is not 100%. In other words, some of these functions may have been added some time ago, but I did not notice them. Others, I am certain have been added quite recently.

Code: Select all

     ScenEdit_AddCustomLoss()
     ScenEdit_AddWeaponToUnitMagazine()
     ScenEdit_AddZone()
     ScenEdit_AssignUnitAsTarget()
     ScenEdit_ClearKeyValue()
     ScenEdit_DeleteUnit()
     ScenEdit_ExecuteEventAction()
     ScenEdit_ExecuteSpecialAction()
     ScenEdit_ExportMission()
     ScenEdit_FillMagsForLoadout()
     ScenEdit_ImportMission()
     ScenEdit_KillUnit()
     ScenEdit_QueryDB()
     ScenEdit_RefuelUnit()
     ScenEdit_RemoveUnitAsTarget()
     ScenEdit_SetLoadout()
     ScenEdit_SetUnitSide()
     ScenEdit_TransferCargo()
     ScenEdit_UpdateUnit()
     ScenEdit_UpdateUnitCargo()
     Tool_DumpEvents()

I also see a section for Pro Version only funcitonality, where Import and Export the entire Scenario to XML has been addid.

To anyone finding errors in my list, I would say that those errors underscore what I've been saying for some time about a key component of documentation that is lacking: an indication of in which version each function become available.

This can be accomplished with a simple line that reads:
"since CMANO version 1147, or PRO 1.15.3"

I can not speak to what other gamers do about loading the latest at each release. For me, life is busy, there are many demands upon my time. So, while the license may say that I am entitled to all updates during a calendar year, unless there is a compelling reason, I generally don't grab the latest, I just work with the version I downloaded at these start of the term, and download a new version when renewing the license.

[KnightHawk75]

Not to burst your bubble but most of those have been in the CMO product for ~ a year, a couple since last summer, none of them are very recent, though many have been improved over the last year.

"I also see a section for Pro Version only funcitonality, where Import and Export the entire Scenario to XML has been addid. "
--
That's been there for months.

Glad to hear about the US Marines helping to fund some enhancements though.

[jkgarner]

The fact that I can not tell which functions are very new, versus, just somewhat new, verses old, only serves to underscodes the point I was trying to make with the post.

The documentation needs each function to have a statement that tells in which version the function was first included.

Something like:
"since CMANO 1146, of Pro 1.15.3"

would work out great and let me know which functions I can use at a glance, rather than discovering when my code does not work as expected.

Happy St. Patrick's Day.