Better documentation for sub-properties and PPD support #481

Open
BanditHelps wants to merge 6 commits from BanditHelps/Palladium:26.1/documentation-for-subproperties into 26.1/dev
Contributor

The idea behind this PR is to create more "specific" documentation for "sub-properties" used throughout Palladium. A "Sub-Property" is any CODEC registered property that is an Object rather than a single value. For example in the case of the key_bind condition:

{ "type": "palladium:key_bind", "key_bind": { "type": "palladium:jump", "cancel_jump": true }, "behaviour": "held", "cooldown": 40 }

The property "key_bind" is an object, because it accepts multiple properties rather than a single value.

I went through and located what I believe are all of these instances that palladium uses. They now have documentation automatically generated inside of the HTML files, and look more or less like this:
image

As part of this, to further PPD support, I have added in definitions for all the generic "Ability Properties" and "UI Widget" properties in the appropriate HTML files. Also, this generates new 2 new JSON files with the properties included.
image

I chose to do this as PPD can pull from them directly, and it seems like a useful thing to have for developers.

If any changes are needed, feel free to mark them or make requests!

The idea behind this PR is to create more "specific" documentation for "sub-properties" used throughout Palladium. A "Sub-Property" is any CODEC registered property that is an Object rather than a single value. For example in the case of the key_bind condition: `{ "type": "palladium:key_bind", "key_bind": { "type": "palladium:jump", "cancel_jump": true }, "behaviour": "held", "cooldown": 40 }` The property "key_bind" is an object, because it accepts multiple properties rather than a single value. I went through and located what I believe are all of these instances that palladium uses. They now have documentation automatically generated inside of the HTML files, and look more or less like this: ![image](/attachments/250c1f11-b549-474d-9a52-e2b47658aa6e) As part of this, to further PPD support, I have added in definitions for all the generic "Ability Properties" and "UI Widget" properties in the appropriate HTML files. Also, this generates new 2 new JSON files with the properties included. ![image](/attachments/d168328b-c08b-4df3-acc7-b3ac1e82bad9) I chose to do this as PPD can pull from them directly, and it seems like a useful thing to have for developers. If any changes are needed, feel free to mark them or make requests!
This pull request can be merged automatically.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u 26.1/documentation-for-subproperties:BanditHelps-26.1/documentation-for-subproperties
git switch BanditHelps-26.1/documentation-for-subproperties

Merge

Merge the changes and update on Forgejo.
git switch 26.1/dev
git merge --no-ff BanditHelps-26.1/documentation-for-subproperties
git switch BanditHelps-26.1/documentation-for-subproperties
git rebase 26.1/dev
git switch 26.1/dev
git merge --ff-only BanditHelps-26.1/documentation-for-subproperties
git switch BanditHelps-26.1/documentation-for-subproperties
git rebase 26.1/dev
git switch 26.1/dev
git merge --no-ff BanditHelps-26.1/documentation-for-subproperties
git switch 26.1/dev
git merge --squash BanditHelps-26.1/documentation-for-subproperties
git switch 26.1/dev
git merge --ff-only BanditHelps-26.1/documentation-for-subproperties
git switch 26.1/dev
git merge BanditHelps-26.1/documentation-for-subproperties
git push origin 26.1/dev
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
ThreeTAG/Palladium!481
No description provided.