diff options
| author | Anghelo Carvajal <angheloalf95@gmail.com> | 2022-01-20 23:47:57 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-20 21:47:57 -0500 |
| commit | 119a6883e6f795815744b9afd6a79084c619ddb6 (patch) | |
| tree | a8c34608bd215d56564ad46f03e235ddb9ed12e8 /docs | |
| parent | be71e26d9afc470a9293e74a6f56ca87f7412be0 (diff) | |
Automatic limbs enum generation (#221)
* proof of concept
* SetLimbIndex
* LIMB_DONE
* use proper enum name in limbs
* fix naming
* add ifdefs
* fix me being dumb
* format
* Add EnumPrefix
* EnumName
* Remove autogenerator stuff
* Add warnings
* format
* Use HANDLE_WARNING_RESOURCE for warning
* object_box special case
* whoops
* Remove overloaded bitconverter methods and use boundary-checker .at method when possible
* Fix warning
* Fix warning
* format
* Hopefully fix every warning now
* docs
* Review
* typo
* Update jenkinsfile for MM
* format
* Force functionpreamble printing in development mode
* Use ARRAY_COUNT on SkeletonHeaders
* Simplify endif in header guards
* fix limbs using the wrong enum value
* use hex in enum comments
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/zapd_extraction_xml_reference.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/zapd_extraction_xml_reference.md b/docs/zapd_extraction_xml_reference.md index b3f5575..89ce33a 100644 --- a/docs/zapd_extraction_xml_reference.md +++ b/docs/zapd_extraction_xml_reference.md @@ -382,6 +382,13 @@ Useful only for the unused `object_human`'s animation data. - `Name`: Required. Suxffixed by `Skel`. - `Type`: Required. Valid values: `Normal`, `Flex` and `Curve`. - `LimbType`: Required. Valid values: `Standard`, `LOD`, `Skin`, `Curve` and `Legacy`. + - `EnumName`: Optional. The name of `typedef`'d limb enum. + - `LimbNone`: Optional. The name of the limb with index zero in the limb enum. + - `LimbMax`: Optional. The name of the max limb index in the limb enum. + +ZAPD is able to generate a limb enum by itself only if all the required data is provided. Providing some but not all the required data would trigger an error and the execution will halt. + +The required data is providing the `EnumName`, `LimbNone` and `LimbMax` attributes in the `Skeleton` or `LimbTable` node and the `EnumName` attribute in every `Limb` of this skeleton. ※ There are no restrictions in the `Type` and `LimbType` attributes besides the valid values, so any skeleton type can be combined with any limb type. @@ -400,6 +407,11 @@ Useful only for the unused `object_human`'s animation data. - `Name`: Required. Suxffixed by `Skel`. - `LimbType`: Required. Valid values: `Standard`, `LOD`, `Skin`, `Curve` and `Legacy`. - `Count`: Required. Amount of limbs. Integer. + - `EnumName`: Optional. The name of `typedef`'d limb enum. + - `LimbNone`: Optional. The name of the limb with index zero in the limb enum. + - `LimbMax`: Optional. The name of the max limb index in the limb enum. + +See [Skeleton](#skeleton) for info on the limb enum generation. ------------------------- @@ -415,6 +427,9 @@ Useful only for the unused `object_human`'s animation data. - `Name`: Required. Suxffixed by `Limb`. - `LimbType`: Required. Valid values: `Standard`, `LOD`, `Skin`, `Curve` and `Legacy`. + - `EnumName`: Optional. The name used for this limb in the limbs enum. It must be either present in every limb or in none. + +See [Skeleton](#skeleton) for info on the limb enum generation. ------------------------- |