summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEllipticEllipsis <73679967+EllipticEllipsis@users.noreply.github.com>2021-09-13 18:19:34 +0100
committerGitHub <noreply@github.com>2021-09-13 13:19:34 -0400
commit3c00dcb30f33b763e215aebfa8ebdf96a8c3ee4d (patch)
treec397a7442330e580a827854f1421e8ce97a8dbdb /docs
parent4d051c0fa036d245027a211bc7fd6a4afdce207f (diff)
Texture Animation extraction from objects (#180)
* Initial files * Add resource header, first go at ExtractFromXML * Now prints plenty to terminal, but not to file * Main array now declared in file * Erroring, but need to checkout master to test * Not erroring any more, hooray * TextureScrollingParams working, missing pointer * Scrolling works * Cycling params should work completely now * Type 2 works, type 4 crashes * Fixed iterator bound, works for Type 4 too now * Correct a couple more EnvColor things * Add null checks to declarations * Switch to Seg2Offset, make TextureAnimationEntry an ordinary struct, delete some obsolete functions * Remove Unknown (throws exception at construction instead) * Move GetResourceType down * Begin rewrite of SetAnimatedMaterialList * Remove old structs in SetAnimatedMaterialList * Fix infinite loop * Tested and working for MM, objects and scenes * Add warnings for undeclared textures (MM OK) * Make `__PRETTY_FUNCTION__` work on GCC/Clang, at least * Remove address from GetDefault name, add fancy errors * Format (also added some extensive documentation last time) * More formatting * Fiddle with errors a bit more * Fix pointer offsets and alignment * Format, add comment to SetAnimatedMaterialList * Add to docs * Review * Add [[maybe_unused]] * uint to get rid of warnings * makefile * Fix most warnings * Add default to shut GCC up * Format
Diffstat (limited to 'docs')
-rw-r--r--docs/zapd_extraction_xml_reference.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/zapd_extraction_xml_reference.md b/docs/zapd_extraction_xml_reference.md
index e27e8bc..d07ef98 100644
--- a/docs/zapd_extraction_xml_reference.md
+++ b/docs/zapd_extraction_xml_reference.md
@@ -13,6 +13,7 @@ This document aims to be a small reference of how to create a compatible xml fil
- [Background](#background)
- [Blob](#blob)
- [DList](#dlist)
+ - [TextureAnimation](#textureanimation)
- [Scene and Room](#scene-and-room)
- [AltHeader](#altheader)
- [Animation](#animation)
@@ -197,6 +198,21 @@ A.k.a. Display list, or Gfx.
-------------------------
+### TextureAnimation
+
+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"/>
+```
+
+- Attributes:
+
+ - `Name`: Required. Suxffixed by `TexAnim`.
+
+-------------------------
+
### Scene and Room
`Scene`s and `Room`s are a bit special, because `Room`s usually needs assets declared in their respective `Scene` (which is in a different file), so they need to be extracted together.