Merge pull request pret#501 from mid-kid/reorg

Organize the engine/ directory
yenatch · Apr 5, 2018 · fe4377c · fe4377c
2 parents 0c44636 + 3810720
commit fe4377c
Show file tree

Hide file tree

Showing 268 changed files with 342 additions and 343 deletions.
diff --git a/Makefile b/Makefile
@@ -21,8 +21,8 @@ data/maps/map_data.o \
 data/pokemon/dex_entries.o \
 data/pokemon/egg_moves.o \
 data/pokemon/evos_attacks.o \
-engine/credits.o \
-engine/events.o \
+engine/movie/credits.o \
+engine/overworld/events.o \
 gfx/pics.o \
 gfx/sprites.o \
 lib/mobile/main.o

diff --git a/constants/audio_constants.asm b/constants/audio_constants.asm
@@ -17,7 +17,7 @@
 	const CC ; d (used for pitchoffset)
 
 ; channel
-; ChannelPointers indexes (see engine/audio.asm)
+; ChannelPointers indexes (see audio/engine.asm)
 	const_def
 	const CHAN1 ; 0
 	const CHAN2 ; 1

diff --git a/constants/battle_tower_constants.asm b/constants/battle_tower_constants.asm
diff --git a/constants/cry_constants.asm b/constants/cry_constants.asm
diff --git a/constants/deco_constants.asm b/constants/deco_constants.asm
@@ -35,7 +35,7 @@ const_value = 1
 	const YELLOW_CARPET
 	const GREEN_CARPET
 
-; DoDecorationAction2.DecoActions indexes (see engine/decorations.asm)
+; DoDecorationAction2.DecoActions indexes (see engine/overworld/decorations.asm)
 const_value = 1
 	const SET_UP_BED
 	const PUT_AWAY_BED
@@ -64,41 +64,41 @@ ENDM
 ; - DecorationIDs (see data/decorations/decorations.asm)
 const_value = 1
 __enum__ = 0
-; FindOwnedBeds.beds values (see engine/decorations.asm)
+; FindOwnedBeds.beds values (see engine/overworld/decorations.asm)
 	const BEDS
 	deco  FEATHERY_BED
 	deco  PINK_BED
 	deco  POLKADOT_BED
 	deco  PIKACHU_BED
-; FindOwnedCarpets.carpets values (see engine/decorations.asm)
+; FindOwnedCarpets.carpets values (see engine/overworld/decorations.asm)
 	const CARPETS
 	deco  RED_CARPET
 	deco  BLUE_CARPET
 	deco  YELLOW_CARPET
 	deco  GREEN_CARPET
-; FindOwnedPlants.plants values (see engine/decorations.asm)
+; FindOwnedPlants.plants values (see engine/overworld/decorations.asm)
 	const PLANTS
 	deco  MAGNAPLANT
 	deco  TROPICPLANT
 	deco  JUMBOPLANT
-; FindOwnedPosters.posters values (see engine/decorations.asm)
+; FindOwnedPosters.posters values (see engine/overworld/decorations.asm)
 	const POSTERS
 	deco  TOWN_MAP
 	deco  PIKACHU_POSTER
 	deco  CLEFAIRY_POSTER
 	deco  JIGGLYPUFF_POSTER
-; FindOwnedConsoles.consoles values (see engine/decorations.asm)
+; FindOwnedConsoles.consoles values (see engine/overworld/decorations.asm)
 	const CONSOLES
 	deco  FAMICOM
 	deco  SNES
 	deco  N64
 	deco  VIRTUAL_BOY
-; FindOwnedBigDolls.big_dolls values (see engine/decorations.asm)
+; FindOwnedBigDolls.big_dolls values (see engine/overworld/decorations.asm)
 	const BIG_DOLLS
 	deco  BIG_SNORLAX_DOLL
 	deco  BIG_ONIX_DOLL
 	deco  BIG_LAPRAS_DOLL
-; FindOwnedOrnaments.ornaments values (see engine/decorations.asm)
+; FindOwnedOrnaments.ornaments values (see engine/overworld/decorations.asm)
 	const DOLLS
 	deco  PIKACHU_DOLL
 	deco  SURF_PIKACHU_DOLL

diff --git a/constants/engine_flags.asm b/constants/engine_flags.asm
@@ -1,4 +1,4 @@
-; EngineFlags indexes (see engine/engine_flasg.asm)
+; EngineFlags indexes (see engine/engine_flags.asm)
 	const_def
 ; wPokegearFlags
 	const ENGINE_RADIO_CARD

diff --git a/constants/gfx_constants.asm b/constants/gfx_constants.asm
@@ -41,7 +41,7 @@ SPRITEOAMSTRUCT_LENGTH EQU const_value
 NUM_SPRITE_OAM_STRUCTS EQU 40 ; see wVirtualOAM
 
 
-; PokeAnims indexes (see engine/pic_animation.asm)
+; PokeAnims indexes (see engine/gfx/pic_animation.asm)
 	const_def
 	const ANIM_MON_SLOW
 	const ANIM_MON_NORMAL

diff --git a/constants/item_constants.asm b/constants/item_constants.asm
@@ -3,7 +3,7 @@
 ; - ItemNames (see data/items/names.asm)
 ; - ItemDescriptions (see data/items/descriptions.asm)
 ; - ItemAttributes (see data/items/attributes.asm)
-; - ItemEffects (see engine/item_effects.asm)
+; - ItemEffects (see engine/items/item_effects.asm)
 	const_def
 	const NO_ITEM      ; 00
 	const MASTER_BALL  ; 01

diff --git a/constants/item_data_constants.asm b/constants/item_data_constants.asm
@@ -17,8 +17,8 @@ ITEMATTR_STRUCT_LENGTH EQU const_value
 	const TM_HM    ; 4
 
 ; item menu types
-; UseItem.dw indexes (see engine/pack.asm)
-; UseRegisteredItem.SwitchTo indexes (see engine/select_menu.asm)
+; UseItem.dw indexes (see engine/items/pack.asm)
+; UseRegisteredItem.SwitchTo indexes (see engine/overworld/select_menu.asm)
 ITEMMENU_NOUSE   EQU 0
 ITEMMENU_CURRENT EQU 4
 ITEMMENU_PARTY   EQU 5
@@ -130,7 +130,7 @@ MAIL_STRUCT_LENGTH EQU $2f ; mailmsg struct
 	const HELD_FOCUS_BAND
 
 
-; mart types (see engine/mart.asm)
+; mart types (see engine/items/mart.asm)
 	const_def
 	const MARTTYPE_STANDARD
 	const MARTTYPE_BITTER

diff --git a/constants/map_data_constants.asm b/constants/map_data_constants.asm
@@ -103,6 +103,6 @@ const_value = -1
 NUM_SPAWNS EQU const_value
 
 
-; outdoor sprite limits (see engine/overworld.asm)
+; outdoor sprite limits (see engine/overworld/overworld.asm)
 MAX_OUTDOOR_SPRITES EQU 23
 SPRITE_GFX_LIST_CAPACITY EQU $20
diff --git a/constants/map_object_constants.asm b/constants/map_object_constants.asm
@@ -121,7 +121,7 @@ MAPOBJECT_SCREEN_WIDTH EQU 12
 NUM_SPRITEMOVEDATA EQU const_value
 SPRITEMOVEDATA_FIELDS EQU 6
 
-; MapObjectMovementPattern.Pointers indexes (see engine/map_objects.asm)
+; MapObjectMovementPattern.Pointers indexes (see engine/overworld/map_objects.asm)
 	const_def
 	const SPRITEMOVEFN_00                    ; 00
 	const SPRITEMOVEFN_RANDOM_WALK_Y         ; 01
@@ -152,7 +152,7 @@ SPRITEMOVEDATA_FIELDS EQU 6
 	const SPRITEMOVEFN_BOULDERDUST           ; 1a
 	const SPRITEMOVEFN_GRASS                 ; 1b
 
-; StepTypesJumptable indexes (see engine/map_objects.asm)
+; StepTypesJumptable indexes (see engine/overworld/map_objects.asm)
 	const_def
 	const STEP_TYPE_00              ; 00
 	const STEP_TYPE_SLEEP           ; 01
@@ -181,7 +181,7 @@ SPRITEMOVEDATA_FIELDS EQU 6
 	const STEP_TYPE_18              ; 18
 	const STEP_TYPE_SKYFALL_TOP     ; 19
 
-; ObjectActionPairPointers indexes (see engine/map_object_action.asm)
+; ObjectActionPairPointers indexes (see engine/overworld/map_object_action.asm)
 	const_def
 	const OBJECT_ACTION_00            ; 00
 	const OBJECT_ACTION_STAND         ; 01
@@ -237,7 +237,7 @@ SPRITEMOVEDATA_FIELDS EQU 6
 	const FACING_GRASS_2        ; 1f
 
 
-; DoPlayerMovement.DoStep arguments (see engine/player_movement.asm)
+; DoPlayerMovement.DoStep arguments (see engine/overworld/player_movement.asm)
 	const_def
 	const STEP_SLOW          ; 0
 	const STEP_WALK          ; 1

diff --git a/constants/map_setup_constants.asm b/constants/map_setup_constants.asm
@@ -14,7 +14,7 @@
 	const MAPSETUP_BADWARP    ; fb
 	const MAPSETUP_FLY        ; fc
 
-; MapSetupCommands indexes (see engine/map_setup.asm)
+; MapSetupCommands indexes (see engine/overworld/map_setup.asm)
 ; Names taken from Condensation water's scripting compendium
 ; https://hax.iimarck.us/files/scriptingcodes_eng.htm
 	const_def

diff --git a/constants/menu_constants.asm b/constants/menu_constants.asm
@@ -34,7 +34,7 @@
 
 
 ; MonMenuOptions indexes (see data/mon_menu.asm)
-; used by PokemonActionSubmenu (see engine/start_menu.asm)
+; used by PokemonActionSubmenu (see engine/menus/start_menu.asm)
 	const_def 1
 	; moves
 	const MONMENUITEM_CUT        ; 1
@@ -83,7 +83,7 @@ HMENURETURN_ASM    EQU %11111111
 	const PARTYMENUACTION_GIVE_MON_FEMALE ; unused
 	const PARTYMENUACTION_GIVE_ITEM
 	const PARTYMENUACTION_MOBILE ; mobile
-; PrintPartyMenuActionText arguments (see engine/party_menu.asm)
+; PrintPartyMenuActionText arguments (see engine/pokemon/party_menu.asm)
 	const_def $f0
 	const PARTYMENUTEXT_HEAL_PSN
 	const PARTYMENUTEXT_HEAL_BRN

diff --git a/constants/printer_constants.asm b/constants/printer_constants.asm
diff --git a/constants/radio_constants.asm b/constants/radio_constants.asm
@@ -1,8 +1,8 @@
 ; radio channel ids
 ; indexes for:
 ; - RadioChannelSongs (see data/radio/channel_music.asm)
-; - PlayRadioShow/RadioJumptable (see engine/radio.asm)
-; - RadioChannels (see engine/radio.asm)
+; - PlayRadioShow/RadioJumptable (see engine/pokegear/radio.asm)
+; - RadioChannels (see engine/pokegear/radio.asm)
 	const_def
 	const OAKS_POKEMON_TALK      ; 00
 	const POKEDEX_SHOW           ; 01
@@ -94,7 +94,7 @@
 	const POKEDEX_SHOW_7         ; 56
 	const POKEDEX_SHOW_8         ; 57
 
-; PlayRadio.StationPointers indexes (see engine/pokegear.asm)
+; PlayRadio.StationPointers indexes (see engine/pokegear/pokegear.asm)
 	const_def
 	const MAPRADIO_POKEMON_CHANNEL
 	const MAPRADIO_OAKS_POKEMON_TALK
@@ -106,7 +106,7 @@
 	const MAPRADIO_LETS_ALL_SING
 	const MAPRADIO_ROCKET
 
-; These tables in engine/radio.asm are all sized to a power of 2
+; These tables in engine/pokegear/radio.asm are all sized to a power of 2
 ; so there's no need for a rejection sampling loop
 NUM_OAKS_POKEMON_TALK_ADVERBS    EQU 16 ; OaksPKMNTalk8.Adverbs
 NUM_OAKS_POKEMON_TALK_ADJECTIVES EQU 16 ; OaksPKMNTalk9.Adjectives
@@ -117,7 +117,7 @@ NUM_PNP_PLACES_ADJECTIVES    EQU 16 ; PeoplePlaces7.Adjectives
 NUM_PASSWORD_CATEGORIES    EQU 11
 NUM_PASSWORDS_PER_CATEGORY EQU  3
 
-; GetBuenasPassword.StringFunctionJumpTable indexes (see engine/radio.asm)
+; GetBuenasPassword.StringFunctionJumpTable indexes (see engine/pokegear/radio.asm)
 	const_def
 	const BUENA_MON
 	const BUENA_ITEM

diff --git a/constants/scgb_constants.asm b/constants/scgb_constants.asm
@@ -1,4 +1,4 @@
-; GetSGBLayout arguments (see engine/cgb_layouts.asm and engine/sgb_layouts.asm)
+; GetSGBLayout arguments (see engine/gfx/cgb_layouts.asm and engine/gfx/sgb_layouts.asm)
 	const_def
 	const SCGB_BATTLE_GRAYSCALE
 	const SCGB_BATTLE_COLORS
@@ -36,7 +36,7 @@ SCGB_PARTY_MENU_HP_PALS  EQU -4
 SCGB_RAM EQU -1
 
 ; PredefPals indexes (see gfx/sgb/predef.pal)
-; GetPredefPal arguments (see engine/color.asm)
+; GetPredefPal arguments (see engine/gfx/color.asm)
 	const_def
 	const PREDEFPAL_00
 	const PREDEFPAL_PALLET

diff --git a/constants/script_constants.asm b/constants/script_constants.asm
@@ -38,7 +38,7 @@ NUM_MEM_BUFFERS EQU const_value
 
 
 ; writecode/checkcode arguments
-; _GetVarAction.VarActionTable indexes (see engine/variables.asm)
+; _GetVarAction.VarActionTable indexes (see engine/overworld/variables.asm)
 	const_def
 	const VAR_STRINGBUFFER2    ; 00
 	const VAR_PARTYCOUNT       ; 01
@@ -75,7 +75,7 @@ RETVAR_ADDR_DE EQU (1 << 6)
 RETVAR_EXECUTE EQU (2 << 6)
 
 
-; PlayerEventScriptPointers indexes (see engine/events.asm)
+; PlayerEventScriptPointers indexes (see engine/overworld/events.asm)
 	const_def -1
 	const PLAYEREVENT_MAPSCRIPT
 	const PLAYEREVENT_NONE
@@ -92,7 +92,7 @@ NUM_PLAYER_EVENTS EQU const_value
 
 
 ; bg_event types
-; TryBGEvent arguments (see engine/events.asm)
+; TryBGEvent arguments (see engine/overworld/events.asm)
 	const_def
 	const BGEVENT_READ
 	const BGEVENT_UP
@@ -105,7 +105,7 @@ NUM_PLAYER_EVENTS EQU const_value
 	const BGEVENT_COPY
 
 ; object_event types
-; TryObjectEvent arguments (see engine/events.asm)
+; TryObjectEvent arguments (see engine/overworld/events.asm)
 	const_def
 	const OBJECTTYPE_SCRIPT
 	const OBJECTTYPE_ITEMBALL
@@ -203,7 +203,7 @@ EMOTE_MEM EQU -1
 NUM_FRUIT_TREES EQU const_value + -1
 
 ; describedecoration arguments
-; DescribeDecoration.JumpTable indexes (see engine/decorations.asm)
+; DescribeDecoration.JumpTable indexes (see engine/overworld/decorations.asm)
 	const_def
 	const DECODESC_POSTER     ; 0
 	const DECODESC_LEFT_DOLL  ; 1
@@ -259,7 +259,7 @@ NUM_FRUIT_TREES EQU const_value + -1
 	const HEALMACHINE_HALL_OF_FAME ; 2
 
 ; UnownPuzzle writebyte arguments
-; LoadUnownPuzzlePiecesGFX.LZPointers indexes (see engine/unown_puzzle.asm)
+; LoadUnownPuzzlePiecesGFX.LZPointers indexes (see engine/games/unown_puzzle.asm)
 	const_def
 	const UNOWNPUZZLE_KABUTO     ; 0
 	const UNOWNPUZZLE_OMANYTE    ; 1

diff --git a/constants/sprite_anim_constants.asm b/constants/sprite_anim_constants.asm
@@ -67,7 +67,7 @@ NUM_SPRITE_ANIM_STRUCTS EQU 10 ; see wSpriteAnimationStructs
 	const SPRITE_ANIM_INDEX_INTRO_SUICUNE_AWAY       ; 2b
 	const SPRITE_ANIM_INDEX_CELEBI                   ; 2c
 
-; DoAnimFrame.Jumptable indexes (see engine/sprite_anims.asm)
+; DoAnimFrame.Jumptable indexes (see engine/gfx/sprite_anims.asm)
 	const_def
 	const SPRITE_ANIM_SEQ_NULL                    ; 00
 	const SPRITE_ANIM_SEQ_PARTY_MON               ; 01

diff --git a/constants/sprite_constants.asm b/constants/sprite_constants.asm
@@ -144,7 +144,7 @@ SPRITE_POKEMON EQU const_value
 	const SPRITE_LUGIA ; a1
 	const SPRITE_HO_OH ; a2
 
-; special GetMonSprite values (see engine/overworld.asm)
+; special GetMonSprite values (see engine/overworld/overworld.asm)
 	const_def $e0
 	const SPRITE_DAY_CARE_MON_1 ; e0
 	const SPRITE_DAY_CARE_MON_2 ; e1

diff --git a/constants/text_constants.asm b/constants/text_constants.asm
@@ -36,7 +36,7 @@ TEXTBOX_INNERY EQU TEXTBOX_Y + 2
 	const PRINTNUM_RIGHTALIGN_F   ; 6
 	const PRINTNUM_LEADINGZEROS_F ; 7
 
-; PrintNum arguments (see engine/printnum.asm)
+; PrintNum arguments (see engine/math/print_num.asm)
 PRINTNUM_MONEY          EQU 1 << PRINTNUM_MONEY_F
 PRINTNUM_RIGHTALIGN     EQU 1 << PRINTNUM_RIGHTALIGN_F
 PRINTNUM_LEADINGZEROS   EQU 1 << PRINTNUM_LEADINGZEROS_F

diff --git a/data/battle_anims/framesets.asm b/data/battle_anims/framesets.asm
diff --git a/data/battle_anims/oam.asm b/data/battle_anims/oam.asm
diff --git a/data/battle_anims/object_gfx.asm b/data/battle_anims/object_gfx.asm
diff --git a/data/battle_anims/objects.asm b/data/battle_anims/objects.asm
diff --git a/data/battle_tower/unknown.asm b/data/battle_tower/unknown.asm
diff --git a/data/sprite_anims/framesets.asm b/data/sprite_anims/framesets.asm
diff --git a/data/sprites/map_objects.asm b/data/sprites/map_objects.asm
diff --git a/data/trainers/class_names.asm b/data/trainers/class_names.asm
diff --git a/data/unused_53d84.asm b/data/unused_53d84.asm
diff --git a/docs/battle_anim_commands.md b/docs/battle_anim_commands.md
@@ -88,7 +88,7 @@ Temporarily creates sprites from the top row of the player backpic, so that the
 
 ## `$DB`: `anim_checkpokeball`
 
-Sets `BattleAnimVar` to the result of [GetPokeBallWobble](/engine/battle_anims/getpokeballwobble.asm).
+Sets `BattleAnimVar` to the result of [GetPokeBallWobble](/engine/battle_anims/pokeball_wobble.asm).
 
 
 ## `$DC`: `anim_transform`