Document various OAM and sprite data and functions #34
Conversation
The decompressCoordEventData_8030aa4 routine parses the header of a map's trigger data. Document the structure of this header and a few bits of related code.
sub_803189C touches some structures and variables. Name these structure members and variables, and document the code for sub_803189C.
* Remove unnecessary .align directives * Make labels function-local * Document the loc_8031904 label
* Rename sub_8030B1E to findTriggerForTilePosition * Add interface documentation to findTriggerForTilePosition * Remove unnecessary .align directives * Document .loc_8030B66 label
Document the interface of the getObjectTilePosition routine, and label some struct members used by that routine.
See the interesting changes in asm/sprite.s.
| // | ||
| // Clobbers: r3, r4, r6, r7, r8 | ||
| thumb_local_start | ||
| findTriggerForTilePosition: |
There was a problem hiding this comment.
Use PascalCase for known non-local labels.
| // | ||
| // Clobbers: r1, r2, r3 | ||
| thumb_local_start | ||
| getObjectTilePosition: |
There was a problem hiding this comment.
Use PascalCase for known non-local labels.
| // | ||
| // Clobbers: r0, r1, r5 | ||
| thumb_local_start | ||
| initializeLayerPriorityTriggers: |
There was a problem hiding this comment.
Use PascalCase for known non-local labels.
| thumb_local_start | ||
| sub_8033B80: | ||
| updateHUDPETSprite: |
There was a problem hiding this comment.
Use PascalCase for known non-local labels.
| byte_8619BD0:: .byte 0x0, 0x0, 0x0, 0x0, 0x94, 0x8, 0x0, 0x0, 0x98, 0x8, 0x0, 0x0, 0x90, 0x12 | ||
| .byte 0x0, 0x0, 0x10, 0x78, 0x14, 0x0, 0x0, 0x16, 0x2, 0x0, 0x0, 0x8A, 0x66, 0x5C | ||
|
|
||
| ACDCTownMapTriggers:: |
There was a problem hiding this comment.
Map Triggers/Wall Data shouldn't be included as GNU Assembler source, as they are binary files. You can keep these here for now, but remember that the end product would have these included as a custom binary format. I would also recommend reading this post by GreigaMaster which goes into extensive detail about the Map Trigger/Wall Data/Map Region format.
| u32 UnkOffset_00, \unk_offset_00 // loc=0x0 | ||
| u32 UnkOffset_04, \unk_offset_04 // loc=0x4 | ||
| u32 LayerPriorityTriggersOffset, \layer_priority_triggers_offset // loc=0x8 | ||
| u32 UnkOffset_0C, \unk_offset_0c // loc=0xc |
There was a problem hiding this comment.
Letters in Hex offsets should be lowercase (e.g. UnkOffset_0C -> UnkOffset_0c)
No description provided.