Progress Report

[LeeThompson]

Currently, a spreadsheet is being built (newlife.ods) that contains methods, ENUMs and everything else.

This is the Wiki tables need to be pre-sorted, and it will also provide developers with yet another way to reference Newlife's methods and strings.

All 435 functions are now in the "Method" tab, however, the other fields are still being added. Once this is complete the ENUM tab will be processed.

• Method/Function Tab
• ENUM Tab
• Stats Tab
• Flags Tab
• Spellings Tab

---

General updates will appear in comments below.

[LeeThompson]

November 12th 2023

Context Objects Wiki Page

• I think adding a horizontal rule before each function improves readability, it was tending to blend together too much.
• Decided to add a specific "Related Methods" section, where appropriate, instead of having "Also see" in notes.
• Decided to "standardize" specifying the flag types as "SceneFlag" etc (v.s. "scene flag") to have it jump out more.
• Added more code examples.

Spreadsheet

• Still filling in data, I'm now updating the spreadsheet and the Context Object wiki simultaneously.

[LeeThompson]

Related Methods etc

My initial format of related methods was simply an unordered list but when there are more than 3-4 entries it starts taking up too much space.

Today I came up with the following format:

New Format

RELATED METHODS:

Type	Methods
Add	addArousalTiny, addArousalSmall, addArousalMedium, addArousalLarge, addArousalHuge
Condition	isArousalComfort,isArousalEnjoy, isArousalClose, isArousalOrgasm
Reduce	reduceArousalTiny, reduceArousalSmall, reduceArousalMedium, reduceArousalLarge, reduceArousalHuge
Set	setArousalDiscomfort, setArousalComfort, setArousalEnjoy, setArousalClose, setArousalOrgasm

This format groups related methods by function type and then simply lists them horizontally.

My current thought is if the article being viewed is listed that instead of a linked entry i.e. isArousalComfort it would be shown as isArousalComfort in the list.

[LeeThompson]

November 20th 2023

Due to the holiday in the United States progress will be slow for most of this week. I am also researching some of the methods in the documentation, especially if the documentation is a little unclear, to make sure the wiki will be correct and, hopefully, clearer.

Changelog

• Added Related Methods section to PC alcohol modifiers.
• Added some link references.
• Minor tweaks
• Created templates.md (mostly for me).

[LeeThompson]

December 4th 2023

Ongoing behind the scenes stuff.
0.8.4 changes have been added.

There will be an update pushed to github this week.

[LeeThompson]

December 7th 2023

• Minor updates (mostly to the spreadsheet).
• I think I've settled on the style for related methods, it takes a bit more time to populate but doesn't take up as much space
• I've also settled on the style for noting parameters (and return values) that are enum strings. That syntax is Enum String <Type>. Collections are Collection <Type> and structures are just StructureName. This may change if something better comes up but I'm fairly happy with it. (You are all welcome to comment.)

[LeeThompson]

December 19th 2023

Work has continued, again with organizing of data, the goal is to have this really easy to use as a reference work. When I began this project I underestimated how many methods and enums the game uses. But the good news is once everything's organized it will be relatively easy to maintain.

Unfortunately, I have accepted a contract for some paid work and I have a tight deadline so this is on hold until early January 2024. I will work on this in bits in my spare time (such as it is) so I'm not saying there won't be any progress but best to assume no progress.

[LeeThompson]

February 26th 2024

Contract work went longer than originally scheduled but is complete. There will likely be a new sprint of contract work (I hope so anyway, I do need to eat) but for new I am returning to this project.

At present I am going through the newest release (0.8.6) and will be incorporating the changes.

[LeeThompson]

July 26th 2024

There doesn't seem to be any documentation changes for 0.8.7, 0.8.8 or 0.8.8b, at least not official documentation changes although I know from the release notes that there have been some, so I need to update those and then I can get back to work.