Better documentation for sub-properties and PPD support #481
No reviewers
Labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
ThreeTAG/Palladium!481
Loading…
Reference in a new issue
No description provided.
Delete branch "BanditHelps/Palladium:26.1/documentation-for-subproperties"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
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:

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.

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!
View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.Merge
Merge the changes and update on Forgejo.