Document Field Warp animations and transition#942
Merged
lhearachel merged 2 commits intopret:mainfrom Feb 16, 2026
Merged
Conversation
lhearachel
reviewed
Feb 15, 2026
Collaborator
lhearachel
left a comment
lhearachel
left a comment
There was a problem hiding this comment.
Looks good, just a few polish-bits to take care of.
src/field_map_change.c
Outdated
| } | ||
|
|
||
| void FieldTask_ChangeMapChangeByDig(FieldTask *task, const Location *location, u32 param2) | ||
| void FieldTask_ChangeMapChangeByFieldWarp(FieldTask *task, const Location *location, enum FieldWarpType fieldWarpType) |
Collaborator
There was a problem hiding this comment.
suggestion: ChangeMapByFieldWarp
src/field_map_change.c
Outdated
| if (mapChangeData->fieldWarpType == FIELD_WARP_TYPE_TELEPORT) { | ||
| FieldSystem_SetTeleportFlags(fieldSystem); | ||
| } else if ((mapChangeData->unk_04 == 0) || (mapChangeData->unk_04 == 1)) { | ||
| } else if ((mapChangeData->fieldWarpType == FIELD_WARP_TYPE_ESCAPE_ROPE) || (mapChangeData->fieldWarpType == FIELD_WARP_TYPE_DIG)) { |
Collaborator
There was a problem hiding this comment.
polish: Remove extraneous parens.
src/field_move_tasks.c
Outdated
|
|
||
| Heap_Free(v1); | ||
| FieldTask_InitJump(param0, ov6_02247554, v2); | ||
| FieldTask_InitJump(param0, FieldWarp_TeleportFadeOut, fieldWarp); |
Collaborator
There was a problem hiding this comment.
polish: Just for completeness, let's name param0 in the FieldTask functions that you're handling here.
| #ifndef POKEPLATINUM_FIELD_WARP_H | ||
| #define POKEPLATINUM_FIELD_WARP_H | ||
|
|
||
| #include "struct_decls/struct_02061AB4_decl.h" |
Collaborator
There was a problem hiding this comment.
note: Out of scope for your PR, but we should really clean up the MapObject struct declarations.
VicSevenT
force-pushed
the
field_warp
branch
from
e6195d7 to
c1fca85
Compare
VicSevenT
force-pushed
the
field_warp
branch
from
c1fca85 to
fa14b99
Compare
lhearachel
approved these changes
Feb 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The file
field_warp.chandles the spinning animation and map transition that occurs when using Dig, Teleport, or an Escape Rope. Along with this documentation, I found that a series of functions infield_map_change.cthat were associated with Dig could actually be called from any of the 3 warp types, and so updated their names as well.