Merge pull request #274 from Rangi42/master

Indent comments that describe data table macro formats
This commit is contained in:
Rangi 2020-07-15 13:23:22 -04:00 committed by GitHub
commit 87f24a885d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 100 additions and 100 deletions

View file

@ -3,7 +3,7 @@ hidden_coin: MACRO
ENDM
HiddenCoinCoords:
; map id, x, y
; map id, x, y
hidden_coin GAME_CORNER, 0, 8
hidden_coin GAME_CORNER, 1, 16
hidden_coin GAME_CORNER, 3, 11

View file

@ -3,7 +3,7 @@ hidden_item: MACRO
ENDM
HiddenItemCoords:
; map id, x, y
; map id, x, y
hidden_item VIRIDIAN_FOREST, 1, 18
hidden_item VIRIDIAN_FOREST, 16, 42
hidden_item MT_MOON_B2F, 18, 12

View file

@ -1,5 +1,5 @@
TradeMons:
; give mon, get mon, dialog id, nickname
; give mon, get mon, dialog id, nickname
db NIDORINO, NIDORINA, TRADE_DIALOGSET_CASUAL, "TERRY@@@@@@"
db ABRA, MR_MIME, TRADE_DIALOGSET_CASUAL, "MARCEL@@@@@"
db BUTTERFREE, BEEDRILL, TRADE_DIALOGSET_HAPPY, "CHIKUCHIKU@"

View file

@ -6,7 +6,7 @@ mon_icon_header: MACRO
ENDM
MonPartySpritePointers:
; gfx pointer, gfx tile offset, # tiles, vSprites tile offset
; gfx pointer, gfx tile offset, # tiles, vSprites tile offset
mon_icon_header SlowbroSprite, 12, 4, $00
mon_icon_header BallSprite, 0, 8, $04
mon_icon_header ClefairySprite, 12, 4, $0c

View file

@ -4,7 +4,7 @@ vend_item: MACRO
ENDM
VendingPrices:
; item id, price
; item id, price
vend_item FRESH_WATER, 200
vend_item SODA_POP, 300
vend_item LEMONADE, 350

View file

@ -3,7 +3,7 @@ force_bike_surf: MACRO
ENDM
ForcedBikeOrSurfMaps:
; map id, x, y
; map id, x, y
force_bike_surf ROUTE_16, 17, 10
force_bike_surf ROUTE_16, 17, 11
force_bike_surf ROUTE_18, 33, 8

View file

@ -5,7 +5,7 @@ ENDM
; the appearance of towns and routes in the town map
ExternalMapEntries:
; x, y, name
; x, y, name
external_map 11, 2, PalletTownName
external_map 8, 2, ViridianCityName
external_map 3, 2, PewterCityName
@ -53,7 +53,7 @@ ENDM
; the appearance of buildings and dungeons in the town map
InternalMapEntries:
; maximum map id subject to this rule, x, y, name
; maximum map id subject to this rule, x, y, name
internal_map OAKS_LAB, 11, 2, PalletTownName
internal_map VIRIDIAN_GYM, 8, 2, ViridianCityName
internal_map VIRIDIAN_FOREST_SOUTH_GATE, 6, 2, Route2Name

View file

@ -4,7 +4,7 @@ special_effect: MACRO
ENDM
SpecialEffectPointers:
; special effect id, effect routine address
; special effect id, effect routine address
special_effect SE_DARK_SCREEN_FLASH, AnimationFlashScreen ; $FE
special_effect SE_DARK_SCREEN_PALETTE, AnimationDarkScreenPalette ; $FD
special_effect SE_RESET_SCREEN_PALETTE, AnimationResetScreenPalette ; $FC

View file

@ -4,7 +4,7 @@ anim_special_effect: MACRO
ENDM
AnimationIdSpecialEffects:
; animation id, effect routine address
; animation id, effect routine address
anim_special_effect MEGA_PUNCH, AnimationFlashScreen
anim_special_effect GUILLOTINE, AnimationFlashScreen
anim_special_effect MEGA_KICK, AnimationFlashScreen

View file

@ -45,14 +45,14 @@ SpriteFacingAndAnimationTable:
.WalkingLeft: db $88, $89, $8a, $8b
.NormalOAM:
; y, x, attributes
; y, x, attributes
db 0, 0, $00 ; top left
db 0, 8, $00 ; top right
db 8, 0, OAMFLAG_CANBEMASKED ; bottom left
db 8, 8, OAMFLAG_CANBEMASKED | OAMFLAG_ENDOFDATA ; bottom right
.FlippedOAM:
; y, x, attributes
; y, x, attributes
db 0, 8, OAMFLAG_VFLIPPED ; top left
db 0, 0, OAMFLAG_VFLIPPED ; top right
db 8, 8, OAMFLAG_VFLIPPED | OAMFLAG_CANBEMASKED ; bottom left

View file

@ -5,76 +5,76 @@ overworld_sprite: MACRO
ENDM
SpriteSheetPointerTable:
; graphics, tile count
overworld_sprite RedSprite, 12 ; SPRITE_RED
overworld_sprite BlueSprite, 12 ; SPRITE_BLUE
overworld_sprite OakSprite, 12 ; SPRITE_OAK
overworld_sprite BugCatcherSprite, 12 ; SPRITE_BUG_CATCHER
overworld_sprite SlowbroSprite, 12 ; SPRITE_SLOWBRO
overworld_sprite LassSprite, 12 ; SPRITE_LASS
overworld_sprite BlackHairBoy1Sprite, 12 ; SPRITE_BLACK_HAIR_BOY_1
overworld_sprite LittleGirlSprite, 12 ; SPRITE_LITTLE_GIRL
overworld_sprite BirdSprite, 12 ; SPRITE_BIRD
overworld_sprite FatBaldGuySprite, 12 ; SPRITE_FAT_BALD_GUY
overworld_sprite GamblerSprite, 12 ; SPRITE_GAMBLER
overworld_sprite BlackHairBoy2Sprite, 12 ; SPRITE_BLACK_HAIR_BOY_2
overworld_sprite GirlSprite, 12 ; SPRITE_GIRL
overworld_sprite HikerSprite, 12 ; SPRITE_HIKER
overworld_sprite FoulardWomanSprite, 12 ; SPRITE_FOULARD_WOMAN
overworld_sprite GentlemanSprite, 12 ; SPRITE_GENTLEMAN
overworld_sprite DaisySprite, 12 ; SPRITE_DAISY
overworld_sprite BikerSprite, 12 ; SPRITE_BIKER
overworld_sprite SailorSprite, 12 ; SPRITE_SAILOR
overworld_sprite CookSprite, 12 ; SPRITE_COOK
overworld_sprite BikeShopGuySprite, 12 ; SPRITE_BIKE_SHOP_GUY
overworld_sprite MrFujiSprite, 12 ; SPRITE_MR_FUJI
overworld_sprite GiovanniSprite, 12 ; SPRITE_GIOVANNI
overworld_sprite RocketSprite, 12 ; SPRITE_ROCKET
overworld_sprite MediumSprite, 12 ; SPRITE_MEDIUM
overworld_sprite WaiterSprite, 12 ; SPRITE_WAITER
overworld_sprite ErikaSprite, 12 ; SPRITE_ERIKA
overworld_sprite MomGeishaSprite, 12 ; SPRITE_MOM_GEISHA
overworld_sprite BrunetteGirlSprite, 12 ; SPRITE_BRUNETTE_GIRL
overworld_sprite LanceSprite, 12 ; SPRITE_LANCE
overworld_sprite OakAideSprite, 12 ; SPRITE_OAK_SCIENTIST_AIDE
overworld_sprite OakAideSprite, 12 ; SPRITE_OAK_AIDE
overworld_sprite RockerSprite, 12 ; SPRITE_ROCKER
overworld_sprite SwimmerSprite, 12 ; SPRITE_SWIMMER
overworld_sprite WhitePlayerSprite, 12 ; SPRITE_WHITE_PLAYER
overworld_sprite GymHelperSprite, 12 ; SPRITE_GYM_HELPER
overworld_sprite OldPersonSprite, 12 ; SPRITE_OLD_PERSON
overworld_sprite MartGuySprite, 12 ; SPRITE_MART_GUY
overworld_sprite FisherSprite, 12 ; SPRITE_FISHER
; graphics, tile count
overworld_sprite RedSprite, 12 ; SPRITE_RED
overworld_sprite BlueSprite, 12 ; SPRITE_BLUE
overworld_sprite OakSprite, 12 ; SPRITE_OAK
overworld_sprite BugCatcherSprite, 12 ; SPRITE_BUG_CATCHER
overworld_sprite SlowbroSprite, 12 ; SPRITE_SLOWBRO
overworld_sprite LassSprite, 12 ; SPRITE_LASS
overworld_sprite BlackHairBoy1Sprite, 12 ; SPRITE_BLACK_HAIR_BOY_1
overworld_sprite LittleGirlSprite, 12 ; SPRITE_LITTLE_GIRL
overworld_sprite BirdSprite, 12 ; SPRITE_BIRD
overworld_sprite FatBaldGuySprite, 12 ; SPRITE_FAT_BALD_GUY
overworld_sprite GamblerSprite, 12 ; SPRITE_GAMBLER
overworld_sprite BlackHairBoy2Sprite, 12 ; SPRITE_BLACK_HAIR_BOY_2
overworld_sprite GirlSprite, 12 ; SPRITE_GIRL
overworld_sprite HikerSprite, 12 ; SPRITE_HIKER
overworld_sprite FoulardWomanSprite, 12 ; SPRITE_FOULARD_WOMAN
overworld_sprite GentlemanSprite, 12 ; SPRITE_GENTLEMAN
overworld_sprite DaisySprite, 12 ; SPRITE_DAISY
overworld_sprite BikerSprite, 12 ; SPRITE_BIKER
overworld_sprite SailorSprite, 12 ; SPRITE_SAILOR
overworld_sprite CookSprite, 12 ; SPRITE_COOK
overworld_sprite BikeShopGuySprite, 12 ; SPRITE_BIKE_SHOP_GUY
overworld_sprite MrFujiSprite, 12 ; SPRITE_MR_FUJI
overworld_sprite GiovanniSprite, 12 ; SPRITE_GIOVANNI
overworld_sprite RocketSprite, 12 ; SPRITE_ROCKET
overworld_sprite MediumSprite, 12 ; SPRITE_MEDIUM
overworld_sprite WaiterSprite, 12 ; SPRITE_WAITER
overworld_sprite ErikaSprite, 12 ; SPRITE_ERIKA
overworld_sprite MomGeishaSprite, 12 ; SPRITE_MOM_GEISHA
overworld_sprite BrunetteGirlSprite, 12 ; SPRITE_BRUNETTE_GIRL
overworld_sprite LanceSprite, 12 ; SPRITE_LANCE
overworld_sprite OakAideSprite, 12 ; SPRITE_OAK_SCIENTIST_AIDE
overworld_sprite OakAideSprite, 12 ; SPRITE_OAK_AIDE
overworld_sprite RockerSprite, 12 ; SPRITE_ROCKER
overworld_sprite SwimmerSprite, 12 ; SPRITE_SWIMMER
overworld_sprite WhitePlayerSprite, 12 ; SPRITE_WHITE_PLAYER
overworld_sprite GymHelperSprite, 12 ; SPRITE_GYM_HELPER
overworld_sprite OldPersonSprite, 12 ; SPRITE_OLD_PERSON
overworld_sprite MartGuySprite, 12 ; SPRITE_MART_GUY
overworld_sprite FisherSprite, 12 ; SPRITE_FISHER
overworld_sprite OldMediumWomanSprite, 12 ; SPRITE_OLD_MEDIUM_WOMAN
overworld_sprite NurseSprite, 12 ; SPRITE_NURSE
overworld_sprite NurseSprite, 12 ; SPRITE_NURSE
overworld_sprite CableClubWomanSprite, 12 ; SPRITE_CABLE_CLUB_WOMAN
overworld_sprite MrMasterballSprite, 12 ; SPRITE_MR_MASTERBALL
overworld_sprite LaprasGiverSprite, 12 ; SPRITE_LAPRAS_GIVER
overworld_sprite WardenSprite, 12 ; SPRITE_WARDEN
overworld_sprite SsCaptainSprite, 12 ; SPRITE_SS_CAPTAIN
overworld_sprite Fisher2Sprite, 12 ; SPRITE_FISHER2
overworld_sprite BlackbeltSprite, 12 ; SPRITE_BLACKBELT
overworld_sprite GuardSprite, 12 ; SPRITE_GUARD
overworld_sprite GuardSprite, 12 ; $32
overworld_sprite MomSprite, 12 ; SPRITE_MOM
overworld_sprite BaldingGuySprite, 12 ; SPRITE_BALDING_GUY
overworld_sprite YoungBoySprite, 12 ; SPRITE_YOUNG_BOY
overworld_sprite GameboyKidSprite, 12 ; SPRITE_GAMEBOY_KID
overworld_sprite GameboyKidSprite, 12 ; SPRITE_GAMEBOY_KID_COPY
overworld_sprite ClefairySprite, 12 ; SPRITE_CLEFAIRY
overworld_sprite AgathaSprite, 12 ; SPRITE_AGATHA
overworld_sprite BrunoSprite, 12 ; SPRITE_BRUNO
overworld_sprite LoreleiSprite, 12 ; SPRITE_LORELEI
overworld_sprite SeelSprite, 12 ; SPRITE_SEEL
overworld_sprite BallSprite, 4 ; SPRITE_BALL
overworld_sprite OmanyteSprite, 4 ; SPRITE_OMANYTE
overworld_sprite BoulderSprite, 4 ; SPRITE_BOULDER
overworld_sprite PaperSheetSprite, 4 ; SPRITE_PAPER_SHEET
overworld_sprite BookMapDexSprite, 4 ; SPRITE_BOOK_MAP_DEX
overworld_sprite ClipboardSprite, 4 ; SPRITE_CLIPBOARD
overworld_sprite SnorlaxSprite, 4 ; SPRITE_SNORLAX
overworld_sprite OldAmberSprite, 4 ; SPRITE_OLD_AMBER_COPY
overworld_sprite OldAmberSprite, 4 ; SPRITE_OLD_AMBER
overworld_sprite LyingOldManSprite, 4 ; SPRITE_LYING_OLD_MAN_UNUSED_1
overworld_sprite LyingOldManSprite, 4 ; SPRITE_LYING_OLD_MAN_UNUSED_2
overworld_sprite LyingOldManSprite, 4 ; SPRITE_LYING_OLD_MAN
overworld_sprite MrMasterballSprite, 12 ; SPRITE_MR_MASTERBALL
overworld_sprite LaprasGiverSprite, 12 ; SPRITE_LAPRAS_GIVER
overworld_sprite WardenSprite, 12 ; SPRITE_WARDEN
overworld_sprite SsCaptainSprite, 12 ; SPRITE_SS_CAPTAIN
overworld_sprite Fisher2Sprite, 12 ; SPRITE_FISHER2
overworld_sprite BlackbeltSprite, 12 ; SPRITE_BLACKBELT
overworld_sprite GuardSprite, 12 ; SPRITE_GUARD
overworld_sprite GuardSprite, 12 ; $32
overworld_sprite MomSprite, 12 ; SPRITE_MOM
overworld_sprite BaldingGuySprite, 12 ; SPRITE_BALDING_GUY
overworld_sprite YoungBoySprite, 12 ; SPRITE_YOUNG_BOY
overworld_sprite GameboyKidSprite, 12 ; SPRITE_GAMEBOY_KID
overworld_sprite GameboyKidSprite, 12 ; SPRITE_GAMEBOY_KID_COPY
overworld_sprite ClefairySprite, 12 ; SPRITE_CLEFAIRY
overworld_sprite AgathaSprite, 12 ; SPRITE_AGATHA
overworld_sprite BrunoSprite, 12 ; SPRITE_BRUNO
overworld_sprite LoreleiSprite, 12 ; SPRITE_LORELEI
overworld_sprite SeelSprite, 12 ; SPRITE_SEEL
overworld_sprite BallSprite, 4 ; SPRITE_BALL
overworld_sprite OmanyteSprite, 4 ; SPRITE_OMANYTE
overworld_sprite BoulderSprite, 4 ; SPRITE_BOULDER
overworld_sprite PaperSheetSprite, 4 ; SPRITE_PAPER_SHEET
overworld_sprite BookMapDexSprite, 4 ; SPRITE_BOOK_MAP_DEX
overworld_sprite ClipboardSprite, 4 ; SPRITE_CLIPBOARD
overworld_sprite SnorlaxSprite, 4 ; SPRITE_SNORLAX
overworld_sprite OldAmberSprite, 4 ; SPRITE_OLD_AMBER_COPY
overworld_sprite OldAmberSprite, 4 ; SPRITE_OLD_AMBER
overworld_sprite LyingOldManSprite, 4 ; SPRITE_LYING_OLD_MAN_UNUSED_1
overworld_sprite LyingOldManSprite, 4 ; SPRITE_LYING_OLD_MAN_UNUSED_2
overworld_sprite LyingOldManSprite, 4 ; SPRITE_LYING_OLD_MAN

View file

@ -4,7 +4,7 @@ bookshelf_tile: MACRO
ENDM
BookshelfTileIDs:
; tileset id, bookshelf tile id, text id
; tileset id, bookshelf tile id, text id
bookshelf_tile PLATEAU, $30, IndigoPlateauStatues
bookshelf_tile HOUSE, $3D, TownMapText
bookshelf_tile HOUSE, $1E, BookOrSculptureText

View file

@ -1,6 +1,6 @@
CutTreeBlockSwaps:
; first byte = tileset block containing the cut tree
; second byte = corresponding tileset block after the cut animation happens
; first byte = tileset block containing the cut tree
; second byte = corresponding tileset block after the cut animation happens
db $32, $6D
db $33, $6C
db $34, $6F

View file

@ -7,7 +7,7 @@ tileset: MACRO
ENDM
Tilesets:
; block, gfx, coll, 3 counter tiles, grass tile, permission
; block, gfx, coll, 3 counter tiles, grass tile, permission
tileset Overworld_Block, Overworld_GFX, Overworld_Coll, $FF,$FF,$FF, $52, OUTDOOR
tileset RedsHouse1_Block, RedsHouse1_GFX, RedsHouse1_Coll, $FF,$FF,$FF, $FF, INDOOR
tileset Mart_Block, Mart_GFX, Mart_Coll, $18,$19,$1E, $FF, INDOOR

View file

@ -1,5 +1,5 @@
WarpPadAndHoleData:
; tileset id, tile id, value for [wStandingOnWarpPadOrHole]
; tileset id, tile id, value for [wStandingOnWarpPadOrHole]
db FACILITY, $20, 1 ; warp pad
db FACILITY, $11, 2 ; hole
db CAVERN, $22, 2 ; hole

View file

@ -1,8 +1,8 @@
TrainerAIPointers:
; one entry per trainer class
; first byte, number of times (per Pokémon) it can occur
; next two bytes, pointer to AI subroutine for trainer class
; subroutines are defined in engine/battle/trainer_ai.asm
; one entry per trainer class
; first byte, number of times (per Pokémon) it can occur
; next two bytes, pointer to AI subroutine for trainer class
; subroutines are defined in engine/battle/trainer_ai.asm
dbw 3, GenericAI
dbw 3, GenericAI
dbw 3, GenericAI

View file

@ -4,8 +4,8 @@ pic_money: MACRO
ENDM
TrainerPicAndMoneyPointers::
; pic pointer, base reward money
; money received after battle = base money × level of highest-level enemy mon
; pic pointer, base reward money
; money received after battle = base money × level of highest-level enemy mon
pic_money YoungsterPic, 1500
pic_money BugCatcherPic, 1000
pic_money LassPic, 1500

View file

@ -1,9 +1,9 @@
; unique moves for gym leaders
LoneMoves:
; pokemon index, move to give nth pokemon
; this is not automatic! you have to write the index you want to [wLoneAttackNo]
; first. e.g., erika's script writes 4 to [wLoneAttackNo] to get mega drain,
; the fourth entry in the list.
LoneMoves:
; pokemon index, move to give nth pokemon
db 1, BIDE
db 1, BUBBLEBEAM
db 2, THUNDERBOLT
@ -14,10 +14,10 @@ LoneMoves:
db 4, FISSURE
; unique moves for elite 4
TeamMoves:
; trainer, move
; all trainers in this class are given this move automatically
; (unrelated to LoneMoves)
TeamMoves:
; trainer, move
db LORELEI, BLIZZARD
db BRUNO, FISSURE
db AGATHA, TOXIC

View file

@ -1,5 +1,5 @@
; random choice of 2 good rod encounters
GoodRodMons:
; level, species
; level, species
db 10, GOLDEEN
db 10, POLIWAG

View file

@ -1,6 +1,6 @@
; super rod encounters
SuperRodData:
; map, fishing group
; map, fishing group
dbw PALLET_TOWN, .Group1
dbw VIRIDIAN_CITY, .Group1
dbw CERULEAN_CITY, .Group3