diff options
| author | Anghelo Carvajal <angheloalf95@gmail.com> | 2021-10-16 21:05:09 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-16 20:05:09 -0400 |
| commit | e243634e5b0e7a7e3a6a5b2e7e9d73676df956ca (patch) | |
| tree | e0759e2414c7e3bb23737559cc066453ce30cf88 /docs | |
| parent | e7a8a48cf361a7591b88592eb3e333ddf8d3ab34 (diff) | |
ZPlayerAnimationData extraction (#200)
* ZPlayerAnimationData
* hex
* Add docs
* docs
* format
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/zapd_extraction_xml_reference.md | 19 | ||||
| -rw-r--r-- | docs/zapd_xml_spec.md | 59 |
2 files changed, 49 insertions, 29 deletions
diff --git a/docs/zapd_extraction_xml_reference.md b/docs/zapd_extraction_xml_reference.md index 03fb4f1..818d9f1 100644 --- a/docs/zapd_extraction_xml_reference.md +++ b/docs/zapd_extraction_xml_reference.md @@ -32,6 +32,7 @@ This document aims to be a small reference of how to create a compatible xml fil - [Cutscene](#cutscene) - [Array](#array) - [Path](#path) + - [PlayerAnimationData](#playeranimationdata) ## Basic XML @@ -216,7 +217,6 @@ A.k.a. Display list, or Gfx. A data type exclusive to Majora's Mask, that has scrolling, color changing, and texture changing capabilities. Declaring the main array will generate everything else; textures for the TextureCycle type must be declared manually in the XML to use symbols. (If it does reference any undeclared textures, ZAPD will warn and give the their offsets.) - ```xml <TextureAnimation Name="gRosaSistersTexAnim" Offset="0xD768"/> ``` @@ -599,3 +599,20 @@ Currently, only [`Scalar`](#scalar), [`Vector`](#vector) and [`Vtx`](#vtx) suppo - `NumPaths`: Optional. The amount of paths contained in the array. It must be a positive integer. ------------------------- + +### PlayerAnimationData + +Allows the extraction of the specific data of the player animations which are found in the `link_animetion` file. + +- Example: + +```xml +<PlayerAnimationData Name="gPlayerAnimData_000000" FrameCount="20" Offset="0x0"/> +``` + +- Attributes: + + - `Name`: Required. Suxffixed by `AnimData`. + - `FrameCount`: Required. The length of the animation in frames. It must be a positive integer. + +------------------------- diff --git a/docs/zapd_xml_spec.md b/docs/zapd_xml_spec.md index e060ec5..9fcc0d4 100644 --- a/docs/zapd_xml_spec.md +++ b/docs/zapd_xml_spec.md @@ -1,8 +1,9 @@ # ZAPD XML specification -ZAPD XMLs use a restrictive subset of the XML standard: any ZAPD XML must be a valid XML (All elements starting with `<tag>` ending appropriately with `</tag>`, single "empty-element" tags with `/` at the end, etc.). +ZAPD XMLs use a restrictive subset of the XML standard: any ZAPD XML must be a valid XML (All elements starting with `<tag>` ending appropriately with `</tag>`, single "empty-element" tags with `/` at the end, etc.). Reminder that in + ```xml <a> <b1> @@ -14,39 +15,41 @@ Reminder that in <e/> </a> ``` + `<b1>`, `<b2>`, `<e/>` are *children* of `<a>`, but `<c/>` is not. `<c/>` is a *descendent* of `<a>` and a child of `<b>`. - Every XML's outermost element start/end tag is a single `<Root>`. - The children of a `<Root>` must be `<File>`s. - A `<File>` has *resources* as children. A resource is almost always single empty-element tag, and has one of the types - - `<Texture>` - - `<Background>` - - `<Blob>` - - `<DList>` - - `<TextureAnimation>` - - `<Scene>` - - `<Room>` - - `<AltHeader>` - - `<Animation>` - - `<PlayerAnimation>` - - `<CurveAnimation>` - - `<LegacyAnimation>` - - `<Skeleton>` - - `<LimbTable>` - - `<Limb>` - - `<Symbol>` - - `<Collision>` - - `<Scalar>` - - `<Vector>` - - `<Vtx>` - - `<Mtx>` - - `<Cutscene>` - - `<Array>` - - `<Path>` + - `<Texture>` + - `<Background>` + - `<Blob>` + - `<DList>` + - `<TextureAnimation>` + - `<Scene>` + - `<Room>` + - `<AltHeader>` + - `<Animation>` + - `<PlayerAnimation>` + - `<CurveAnimation>` + - `<LegacyAnimation>` + - `<Skeleton>` + - `<LimbTable>` + - `<Limb>` + - `<Symbol>` + - `<Collision>` + - `<Scalar>` + - `<Vector>` + - `<Vtx>` + - `<Mtx>` + - `<Cutscene>` + - `<Array>` + - `<Path>` + - `<PlayerAnimationData>` - A `<File>` cannot descend from a `<File>`. - All resources must be children of a `<File>`. - `<Array>` is the only paired resource tag enclosing an element; the element must be a single resource tag, one of - - `<Scalar>` - - `<Vector>` - - `<Vtx>` + - `<Scalar>` + - `<Vector>` + - `<Vtx>` |
