RGBDS syntax updates (#905)

New MACRO and DEF syntax

STYLE.md

@@ -79,19 +79,19 @@ hPascalCase: ; hram
 PascalCase:  ; rom
 
 ; Some constants are also prefixed
-rBGP EQU $ff47 ; hardware register
+DEF rBGP EQU $ff47 ; hardware register
 
 ; Most other constants should be upper case
-UPPER_CASE EQU 1
+DEF UPPER_CASE EQU 1
 
 
 ; Long lists of constants should be aligned
-SHORT_CONSTANT       EQU 1
+DEF SHORT_CONSTANT       EQU 1
-LONGER_CONSTANT      EQU 2
+DEF LONGER_CONSTANT      EQU 2
-PRETTY_LONG_CONSTANT EQU 3
+DEF PRETTY_LONG_CONSTANT EQU 3
-TINY                 EQU 4
+DEF TINY                 EQU 4
 
-BUT_ONLY_RELATED_CONSTANTS EQU 5
+DEF BUT_ONLY_RELATED_CONSTANTS EQU 5
 
 ```
 
@@ -103,12 +103,12 @@ BUT_ONLY_RELATED_CONSTANTS EQU 5
 SECTION "section", ROMX
 INCLUDE "filename"
 INCBIN "filename"
-my_macro: MACRO
+MACRO my_macro
 	nop
 ENDM
-TEST EQUS "test"
+DEF TEST EQUS "test"
 PURGE TEST
-TEST EQU 2
+DEF TEST EQU 2
 
 ; data macros should be lowercase
 	db 1
@@ -135,7 +135,7 @@ endr
 
 ```asm
 
-when_in_doubt_lowercase: MACRO
+MACRO when_in_doubt_lowercase
 
 ; only shift if it's required or more readable
 
@@ -158,7 +158,7 @@ endr
 ENDM
 
 
-UPPER_CASE_IS_OK_SOMETIMES: MACRO
+MACRO UPPER_CASE_IS_OK_SOMETIMES
 
 ; but I can't think of any examples besides ACRONYMS
 

constants/audio_constants.asm

@@ -13,7 +13,7 @@
 	const A_ ; a
 	const A# ; b
 	const B_ ; c
-NUM_NOTES EQU const_value - 1
+DEF NUM_NOTES EQU const_value - 1
 
 ; channel
 ; ChannelPointers indexes (see audio/engine.asm)
@@ -22,60 +22,60 @@ NUM_NOTES EQU const_value - 1
 	const CHAN2 ; 1
 	const CHAN3 ; 2
 	const CHAN4 ; 3
-NUM_MUSIC_CHANS EQU const_value
+DEF NUM_MUSIC_CHANS EQU const_value
 	const CHAN5 ; 4
 	const CHAN6 ; 5
 	const CHAN7 ; 6
 	const CHAN8 ; 7
-NUM_NOISE_CHANS EQU const_value - NUM_MUSIC_CHANS
+DEF NUM_NOISE_CHANS EQU const_value - NUM_MUSIC_CHANS
-NUM_CHANNELS EQU const_value
+DEF NUM_CHANNELS EQU const_value
 
 ; channel_struct members (see macros/wram.asm)
 rsreset
-CHANNEL_MUSIC_ID                    rw
+DEF CHANNEL_MUSIC_ID                    rw
-CHANNEL_MUSIC_BANK                  rb
+DEF CHANNEL_MUSIC_BANK                  rb
-CHANNEL_FLAGS1                      rb
+DEF CHANNEL_FLAGS1                      rb
-CHANNEL_FLAGS2                      rb
+DEF CHANNEL_FLAGS2                      rb
-CHANNEL_FLAGS3                      rb
+DEF CHANNEL_FLAGS3                      rb
-CHANNEL_MUSIC_ADDRESS               rw
+DEF CHANNEL_MUSIC_ADDRESS               rw
-CHANNEL_LAST_MUSIC_ADDRESS          rw
+DEF CHANNEL_LAST_MUSIC_ADDRESS          rw
-                                    rb_skip 2
+                                        rb_skip 2
-CHANNEL_NOTE_FLAGS                  rb
+DEF CHANNEL_NOTE_FLAGS                  rb
-CHANNEL_CONDITION                   rb
+DEF CHANNEL_CONDITION                   rb
-CHANNEL_DUTY_CYCLE                  rb
+DEF CHANNEL_DUTY_CYCLE                  rb
-CHANNEL_VOLUME_ENVELOPE             rb
+DEF CHANNEL_VOLUME_ENVELOPE             rb
-CHANNEL_FREQUENCY                   rw
+DEF CHANNEL_FREQUENCY                   rw
-CHANNEL_PITCH                       rb
+DEF CHANNEL_PITCH                       rb
-CHANNEL_OCTAVE                      rb
+DEF CHANNEL_OCTAVE                      rb
-CHANNEL_TRANSPOSITION               rb
+DEF CHANNEL_TRANSPOSITION               rb
-CHANNEL_NOTE_DURATION               rb
+DEF CHANNEL_NOTE_DURATION               rb
-CHANNEL_FIELD16                     rb
+DEF CHANNEL_FIELD16                     rb
-                                    rb_skip
+                                        rb_skip
-CHANNEL_LOOP_COUNT                  rb
+DEF CHANNEL_LOOP_COUNT                  rb
-CHANNEL_TEMPO                       rw
+DEF CHANNEL_TEMPO                       rw
-CHANNEL_TRACKS                      rb
+DEF CHANNEL_TRACKS                      rb
-CHANNEL_DUTY_CYCLE_PATTERN          rb
+DEF CHANNEL_DUTY_CYCLE_PATTERN          rb
-CHANNEL_VIBRATO_DELAY_COUNT         rb
+DEF CHANNEL_VIBRATO_DELAY_COUNT         rb
-CHANNEL_VIBRATO_DELAY               rb
+DEF CHANNEL_VIBRATO_DELAY               rb
-CHANNEL_VIBRATO_EXTENT              rb
+DEF CHANNEL_VIBRATO_EXTENT              rb
-CHANNEL_VIBRATO_RATE                rb
+DEF CHANNEL_VIBRATO_RATE                rb
-CHANNEL_PITCH_SLIDE_TARGET          rw
+DEF CHANNEL_PITCH_SLIDE_TARGET          rw
-CHANNEL_PITCH_SLIDE_AMOUNT          rb
+DEF CHANNEL_PITCH_SLIDE_AMOUNT          rb
-CHANNEL_PITCH_SLIDE_AMOUNT_FRACTION rb
+DEF CHANNEL_PITCH_SLIDE_AMOUNT_FRACTION rb
-CHANNEL_FIELD25                     rb
+DEF CHANNEL_FIELD25                     rb
-                                    rb_skip
+                                        rb_skip
-CHANNEL_PITCH_OFFSET                rw
+DEF CHANNEL_PITCH_OFFSET                rw
-CHANNEL_FIELD29                     rb
+DEF CHANNEL_FIELD29                     rb
-CHANNEL_FIELD2A                     rw
+DEF CHANNEL_FIELD2A                     rw
-CHANNEL_FIELD2C                     rb
+DEF CHANNEL_FIELD2C                     rb
-CHANNEL_NOTE_LENGTH                 rb
+DEF CHANNEL_NOTE_LENGTH                 rb
-CHANNEL_FIELD2E                     rb
+DEF CHANNEL_FIELD2E                     rb
-CHANNEL_FIELD2F                     rb
+DEF CHANNEL_FIELD2F                     rb
-CHANNEL_FIELD30                     rb
+DEF CHANNEL_FIELD30                     rb
-                                    rb_skip
+                                        rb_skip
-CHANNEL_STRUCT_LENGTH EQU _RS
+DEF CHANNEL_STRUCT_LENGTH EQU _RS
 
-NOISE_CHAN_F EQU 2 ; bit set in CHAN5-CHAN7
+DEF NOISE_CHAN_F EQU 2 ; bit set in CHAN5-CHAN7
 
 ; Flags1
 	const_def
@@ -113,22 +113,22 @@ NOISE_CHAN_F EQU 2 ; bit set in CHAN5-CHAN7
 	const NOTE_VIBRATO_OVERRIDE ; 6
 
 ; wVolume
-VOLUME_SO1_F     EQU 3
+DEF VOLUME_SO1_F     EQU 3
-VOLUME_SO2_F     EQU 7
+DEF VOLUME_SO2_F     EQU 7
-VOLUME_SO1_LEVEL EQU %00000111
+DEF VOLUME_SO1_LEVEL EQU %00000111
-VOLUME_SO2_LEVEL EQU %01110000
+DEF VOLUME_SO2_LEVEL EQU %01110000
-MAX_VOLUME       EQU $77
+DEF MAX_VOLUME       EQU $77
 
 ; wSoundInput
-SOUND_INPUT_CH1_F    EQU 0
+DEF SOUND_INPUT_CH1_F    EQU 0
-SOUND_INPUT_CH2_F    EQU 1
+DEF SOUND_INPUT_CH2_F    EQU 1
-SOUND_INPUT_CH3_F    EQU 2
+DEF SOUND_INPUT_CH3_F    EQU 2
-SOUND_INPUT_CH4_F    EQU 3
+DEF SOUND_INPUT_CH4_F    EQU 3
-SOUND_INPUT_GLOBAL_F EQU 7
+DEF SOUND_INPUT_GLOBAL_F EQU 7
 
 ; wLowHealthAlarm
-DANGER_PITCH_F EQU 4
+DEF DANGER_PITCH_F EQU 4
-DANGER_ON_F    EQU 7
+DEF DANGER_ON_F    EQU 7
 
 ; wMusicFade
-MUSIC_FADE_IN_F EQU 7
+DEF MUSIC_FADE_IN_F EQU 7

constants/battle_anim_constants.asm

@@ -1,32 +1,32 @@
 ; battle_anim_struct members (see macros/wram.asm)
 rsreset
-BATTLEANIMSTRUCT_INDEX           rb
+DEF BATTLEANIMSTRUCT_INDEX           rb
-BATTLEANIMSTRUCT_OAMFLAGS        rb
+DEF BATTLEANIMSTRUCT_OAMFLAGS        rb
-BATTLEANIMSTRUCT_FIX_Y           rb
+DEF BATTLEANIMSTRUCT_FIX_Y           rb
-BATTLEANIMSTRUCT_FRAMESET_ID     rb
+DEF BATTLEANIMSTRUCT_FRAMESET_ID     rb
-BATTLEANIMSTRUCT_FUNCTION        rb
+DEF BATTLEANIMSTRUCT_FUNCTION        rb
-BATTLEANIMSTRUCT_PALETTE         rb
+DEF BATTLEANIMSTRUCT_PALETTE         rb
-BATTLEANIMSTRUCT_TILEID          rb
+DEF BATTLEANIMSTRUCT_TILEID          rb
-BATTLEANIMOBJ_LENGTH EQU _RS - 1 ; discount BATTLEANIMSTRUCT_INDEX
+DEF BATTLEANIMOBJ_LENGTH EQU _RS - 1 ; discount BATTLEANIMSTRUCT_INDEX
-BATTLEANIMSTRUCT_XCOORD          rb
+DEF BATTLEANIMSTRUCT_XCOORD          rb
-BATTLEANIMSTRUCT_YCOORD          rb
+DEF BATTLEANIMSTRUCT_YCOORD          rb
-BATTLEANIMSTRUCT_XOFFSET         rb
+DEF BATTLEANIMSTRUCT_XOFFSET         rb
-BATTLEANIMSTRUCT_YOFFSET         rb
+DEF BATTLEANIMSTRUCT_YOFFSET         rb
-BATTLEANIMSTRUCT_PARAM           rb
+DEF BATTLEANIMSTRUCT_PARAM           rb
-BATTLEANIMSTRUCT_DURATION        rb
+DEF BATTLEANIMSTRUCT_DURATION        rb
-BATTLEANIMSTRUCT_FRAME           rb
+DEF BATTLEANIMSTRUCT_FRAME           rb
-BATTLEANIMSTRUCT_JUMPTABLE_INDEX rb
+DEF BATTLEANIMSTRUCT_JUMPTABLE_INDEX rb
-BATTLEANIMSTRUCT_VAR1            rb
+DEF BATTLEANIMSTRUCT_VAR1            rb
-BATTLEANIMSTRUCT_VAR2            rb
+DEF BATTLEANIMSTRUCT_VAR2            rb
-                                 rb_skip 7
+                                     rb_skip 7
-BATTLEANIMSTRUCT_LENGTH EQU _RS
+DEF BATTLEANIMSTRUCT_LENGTH EQU _RS
-NUM_ANIM_OBJECTS EQU 10 ; see wActiveAnimObjects
+DEF NUM_ANIM_OBJECTS EQU 10 ; see wActiveAnimObjects
 
 ; wBattleAnimTileDict size (see wram.asm)
-NUM_BATTLEANIMTILEDICT_ENTRIES EQU 5
+DEF NUM_BATTLEANIMTILEDICT_ENTRIES EQU 5
 
 ; Start tile for battle animation graphics
-BATTLEANIM_BASE_TILE EQU 7 * 7  ; Maximum size of a pokemon picture
+DEF BATTLEANIM_BASE_TILE EQU 7 * 7  ; Maximum size of a pokemon picture
 
 ; BattleAnimObjects indexes (see data/battle_anims/objects.asm)
 	const_def
@@ -218,7 +218,7 @@ BATTLEANIM_BASE_TILE EQU 7 * 7  ; Maximum size of a pokemon picture
 	const ANIM_OBJ_PLAYERHEAD_1ROW
 	const ANIM_OBJ_ENEMYFEET_2ROW
 	const ANIM_OBJ_PLAYERHEAD_2ROW
-NUM_ANIM_OBJS EQU const_value
+DEF NUM_ANIM_OBJS EQU const_value
 
 ; DoBattleAnimFrame arguments (see engine/battle_anims/functions.asm)
 	const_def
@@ -302,7 +302,7 @@ NUM_ANIM_OBJS EQU const_value
 	const BATTLEANIMFUNC_ANCIENT_POWER
 	const BATTLEANIMFUNC_ROCK_SMASH
 	const BATTLEANIMFUNC_COTTON
-NUM_BATTLEANIMFUNCS EQU const_value
+DEF NUM_BATTLEANIMFUNCS EQU const_value
 
 ; BattleAnimFrameData indexes (see data/battle_anims/framesets.asm)
 	const_def
@@ -491,7 +491,7 @@ NUM_BATTLEANIMFUNCS EQU const_value
 	const BATTLEANIMFRAMESET_B6
 	const BATTLEANIMFRAMESET_B7
 	const BATTLEANIMFRAMESET_B8
-NUM_BATTLEANIMFRAMESETS EQU const_value
+DEF NUM_BATTLEANIMFRAMESETS EQU const_value
 
 ; BattleAnimOAMData indexes (see data/battle_anims/oam.asm)
 	const_def
@@ -711,7 +711,7 @@ NUM_BATTLEANIMFRAMESETS EQU const_value
 	const BATTLEANIMOAMSET_D5
 	const BATTLEANIMOAMSET_D6
 	const BATTLEANIMOAMSET_D7
-NUM_BATTLEANIMOAMSETS EQU const_value
+DEF NUM_BATTLEANIMOAMSETS EQU const_value
 
 ; BattleBGEffects indexes (see engine/battle_anims/bg_effects.asm)
 	const_def 1
@@ -768,7 +768,7 @@ NUM_BATTLEANIMOAMSETS EQU const_value
 	const ANIM_BG_VIBRATE_MON
 	const ANIM_BG_WOBBLE_PLAYER
 	const ANIM_BG_WOBBLE_SCREEN
-NUM_ANIM_BGS EQU const_value - 1
+DEF NUM_ANIM_BGS EQU const_value - 1
 
 ; wBattleAnimTileDict keys (see wram.asm)
 ; AnimObjGFX indexes (see data/battle_anims/object_gfx.asm)
@@ -814,16 +814,16 @@ NUM_ANIM_BGS EQU const_value - 1
 	const ANIM_GFX_AEROBLAST
 	const ANIM_GFX_PLAYERHEAD
 	const ANIM_GFX_ENEMYFEET
-NUM_ANIM_GFX EQU const_value - 1
+DEF NUM_ANIM_GFX EQU const_value - 1
 
 ; battle_bg_effect struct members (see macros/wram.asm)
 rsreset
-BG_EFFECT_STRUCT_FUNCTION    rb
+DEF BG_EFFECT_STRUCT_FUNCTION    rb
-BG_EFFECT_STRUCT_JT_INDEX    rb
+DEF BG_EFFECT_STRUCT_JT_INDEX    rb
-BG_EFFECT_STRUCT_BATTLE_TURN rb
+DEF BG_EFFECT_STRUCT_BATTLE_TURN rb
-BG_EFFECT_STRUCT_PARAM       rb
+DEF BG_EFFECT_STRUCT_PARAM       rb
-BG_EFFECT_STRUCT_LENGTH EQU _RS
+DEF BG_EFFECT_STRUCT_LENGTH EQU _RS
-NUM_BG_EFFECTS EQU 5 ; see wActiveBGEffects
+DEF NUM_BG_EFFECTS EQU 5 ; see wActiveBGEffects
 
 ; anim_bgeffect battle turn values for some effects
 	const_def

constants/battle_constants.asm

@@ -1,31 +1,31 @@
 ; significant level values
-MAX_LEVEL EQU 100
+DEF MAX_LEVEL EQU 100
-MIN_LEVEL EQU 2
+DEF MIN_LEVEL EQU 2
-EGG_LEVEL EQU 5
+DEF EGG_LEVEL EQU 5
 
 ; maximum moves known per mon
-NUM_MOVES EQU 4
+DEF NUM_MOVES EQU 4
 
 ; significant stat values
-BASE_STAT_LEVEL EQU 7
+DEF BASE_STAT_LEVEL EQU 7
-MAX_STAT_LEVEL EQU 13
+DEF MAX_STAT_LEVEL EQU 13
 
 ; turns that sleep lasts
-REST_SLEEP_TURNS EQU 2
+DEF REST_SLEEP_TURNS EQU 2
-TREEMON_SLEEP_TURNS EQU 7
+DEF TREEMON_SLEEP_TURNS EQU 7
 
 ; default move priority
-BASE_PRIORITY EQU 1
+DEF BASE_PRIORITY EQU 1
 
 ; type effectiveness factors, scaled by 10
-SUPER_EFFECTIVE    EQU 20
+DEF SUPER_EFFECTIVE    EQU 20
-MORE_EFFECTIVE     EQU 15
+DEF MORE_EFFECTIVE     EQU 15
-EFFECTIVE          EQU 10
+DEF EFFECTIVE          EQU 10
-NOT_VERY_EFFECTIVE EQU 05
+DEF NOT_VERY_EFFECTIVE EQU 05
-NO_EFFECT          EQU 00
+DEF NO_EFFECT          EQU 00
 
 ; enemy AI behavior
-BASE_AI_SWITCH_SCORE EQU 10
+DEF BASE_AI_SWITCH_SCORE EQU 10
 
 ; wPlayerStatLevels and wEnemyStatLevels indexes (see wram.asm)
 ; GetStatName arguments (see data/battle/stat_names.asm)
@@ -38,18 +38,18 @@ BASE_AI_SWITCH_SCORE EQU 10
 	const ACCURACY
 	const EVASION
 	const ABILITY ; used for BattleCommand_Curse
-NUM_LEVEL_STATS EQU const_value
+DEF NUM_LEVEL_STATS EQU const_value
 
 ; move struct members (see data/moves/moves.asm)
 rsreset
-MOVE_ANIM   rb ; 0
+DEF MOVE_ANIM   rb ; 0
-MOVE_EFFECT rb ; 1
+DEF MOVE_EFFECT rb ; 1
-MOVE_POWER  rb ; 2
+DEF MOVE_POWER  rb ; 2
-MOVE_TYPE   rb ; 3
+DEF MOVE_TYPE   rb ; 3
-MOVE_ACC    rb ; 4
+DEF MOVE_ACC    rb ; 4
-MOVE_PP     rb ; 5
+DEF MOVE_PP     rb ; 5
-MOVE_CHANCE rb ; 6
+DEF MOVE_CHANCE rb ; 6
-MOVE_LENGTH EQU _RS
+DEF MOVE_LENGTH EQU _RS
 
 ; stat constants
 ; indexes for:
@@ -61,20 +61,20 @@ MOVE_LENGTH EQU _RS
 	const STAT_DEF
 	const STAT_SPD
 	const STAT_SATK
-NUM_EXP_STATS EQU const_value - 1
+DEF NUM_EXP_STATS EQU const_value - 1
 	const STAT_SDEF
-NUM_STATS EQU const_value - 1
+DEF NUM_STATS EQU const_value - 1
-NUM_BATTLE_STATS EQU NUM_STATS - 1 ; don't count HP
+DEF NUM_BATTLE_STATS EQU NUM_STATS - 1 ; don't count HP
 
 ; stat formula constants
-STAT_MIN_NORMAL EQU 5
+DEF STAT_MIN_NORMAL EQU 5
-STAT_MIN_HP EQU 10
+DEF STAT_MIN_HP EQU 10
 
-MAX_STAT_VALUE EQU 999
+DEF MAX_STAT_VALUE EQU 999
 
 ; shiny dvs
-ATKDEFDV_SHINY EQU $EA
+DEF ATKDEFDV_SHINY EQU $EA
-SPDSPCDV_SHINY EQU $AA
+DEF SPDSPCDV_SHINY EQU $AA
 
 ; battle classes (wBattleMode values)
 	const_def 1
@@ -120,7 +120,7 @@ SPDSPCDV_SHINY EQU $AA
 	const BATTLE_VARS_LAST_COUNTER_MOVE_OPP
 	const BATTLE_VARS_LAST_MOVE
 	const BATTLE_VARS_LAST_MOVE_OPP
-NUM_BATTLE_VARS EQU const_value
+DEF NUM_BATTLE_VARS EQU const_value
 
 ; BattleVarLocations indexes (see home/battle_vars.asm)
 	const_def
@@ -151,17 +151,17 @@ NUM_BATTLE_VARS EQU const_value
 	const PLAYER_LAST_MOVE
 	const ENEMY_LAST_MOVE
 assert const_value % 2 == 0
-NUM_BATTLE_VAR_LOCATION_PAIRS EQU const_value / 2
+DEF NUM_BATTLE_VAR_LOCATION_PAIRS EQU const_value / 2
 
 ; status condition bit flags
-SLP EQU %111 ; 0-7 turns
+DEF SLP EQU %111 ; 0-7 turns
 	const_def 3
 	const PSN
 	const BRN
 	const FRZ
 	const PAR
 
-ALL_STATUS EQU (1 << PSN) | (1 << BRN) | (1 << FRZ) | (1 << PAR) | SLP
+DEF ALL_STATUS EQU (1 << PSN) | (1 << BRN) | (1 << FRZ) | (1 << PAR) | SLP
 
 ; wPlayerSubStatus1 or wEnemySubStatus1 bit flags
 	const_def
@@ -260,10 +260,10 @@ ALL_STATUS EQU (1 << PSN) | (1 << BRN) | (1 << FRZ) | (1 << PAR) | SLP
 	const LOSE
 	const DRAW
 
-BATTLERESULT_CAUGHT_CELEBI EQU 6
+DEF BATTLERESULT_CAUGHT_CELEBI EQU 6
-BATTLERESULT_BOX_FULL EQU 7
+DEF BATTLERESULT_BOX_FULL EQU 7
-BATTLERESULT_BITMASK EQU (1 << BATTLERESULT_CAUGHT_CELEBI) | (1 << BATTLERESULT_BOX_FULL)
+DEF BATTLERESULT_BITMASK EQU (1 << BATTLERESULT_CAUGHT_CELEBI) | (1 << BATTLERESULT_BOX_FULL)
 
 ; link_battle_record struct
-LINK_BATTLE_RECORD_LENGTH EQU 2 + (NAME_LENGTH - 1) + 2 * 3
+DEF LINK_BATTLE_RECORD_LENGTH EQU 2 + (NAME_LENGTH - 1) + 2 * 3
-NUM_LINK_BATTLE_RECORDS EQU 5
+DEF NUM_LINK_BATTLE_RECORDS EQU 5

constants/battle_tower_constants.asm

@@ -1,11 +1,11 @@
-BATTLETOWER_PARTY_LENGTH EQU 3
+DEF BATTLETOWER_PARTY_LENGTH EQU 3
-BATTLETOWER_STREAK_LENGTH EQU 7
+DEF BATTLETOWER_STREAK_LENGTH EQU 7
 
-BATTLETOWER_NUM_UNIQUE_MON EQU 21
+DEF BATTLETOWER_NUM_UNIQUE_MON EQU 21
-BATTLETOWER_NUM_UNIQUE_TRAINERS EQU 70
+DEF BATTLETOWER_NUM_UNIQUE_TRAINERS EQU 70
 
-BATTLETOWER_TRAINERDATALENGTH EQU 18 * 2 ; $24
+DEF BATTLETOWER_TRAINERDATALENGTH EQU 18 * 2 ; $24
-BATTLE_TOWER_STRUCT_LENGTH EQU NAME_LENGTH + BATTLETOWER_PARTY_LENGTH * NICKNAMED_MON_STRUCT_LENGTH + BATTLETOWER_TRAINERDATALENGTH ; $e0
+DEF BATTLE_TOWER_STRUCT_LENGTH EQU NAME_LENGTH + BATTLETOWER_PARTY_LENGTH * NICKNAMED_MON_STRUCT_LENGTH + BATTLETOWER_TRAINERDATALENGTH ; $e0
 
 ; BattleTowerAction setval arguments (see engine/events/battle_tower/battle_tower.asm)
 	const_def
@@ -44,7 +44,7 @@ BATTLE_TOWER_STRUCT_LENGTH EQU NAME_LENGTH + BATTLETOWER_PARTY_LENGTH * NICKNAME
 
 ; BattleTowerAction return values
 ; - from BATTLETOWERACTION_CHECKMOBILEEVENT
-MOBILE_EVENT_OBJECT_GS_BALL EQU $b
+DEF MOBILE_EVENT_OBJECT_GS_BALL EQU $b
 
 ; BattleTowerText arguments (see engine/events/battle_tower/trainer_text.asm)
 	const_def 1

constants/collision_constants.asm

@@ -1,129 +1,129 @@
 ; collision permissions (see data/collision/collision_permissions.asm)
-LAND_TILE  EQU $00
+DEF LAND_TILE  EQU $00
-WATER_TILE EQU $01
+DEF WATER_TILE EQU $01
-WALL_TILE  EQU $0f
+DEF WALL_TILE  EQU $0f
-TALK       EQU $10
+DEF TALK       EQU $10
 
 ; collision data types (see data/tilesets/*_collision.asm)
 ; TileCollisionTable indexes (see data/collision/collision_permissions.asm)
-COLL_FLOOR             EQU $00
+DEF COLL_FLOOR             EQU $00
-COLL_01                EQU $01 ; garbage
+DEF COLL_01                EQU $01 ; garbage
-COLL_03                EQU $03 ; garbage
+DEF COLL_03                EQU $03 ; garbage
-COLL_04                EQU $04 ; garbage
+DEF COLL_04                EQU $04 ; garbage
-COLL_WALL              EQU $07
+DEF COLL_WALL              EQU $07
-COLL_CUT_08            EQU $08 ; unused
+DEF COLL_CUT_08            EQU $08 ; unused
-COLL_TALL_GRASS_10     EQU $10 ; unused
+DEF COLL_TALL_GRASS_10     EQU $10 ; unused
-COLL_CUT_TREE          EQU $12
+DEF COLL_CUT_TREE          EQU $12
-COLL_LONG_GRASS        EQU $14
+DEF COLL_LONG_GRASS        EQU $14
-COLL_HEADBUTT_TREE     EQU $15
+DEF COLL_HEADBUTT_TREE     EQU $15
-COLL_TALL_GRASS        EQU $18
+DEF COLL_TALL_GRASS        EQU $18
-COLL_CUT_TREE_1A       EQU $1a ; unused
+DEF COLL_CUT_TREE_1A       EQU $1a ; unused
-COLL_LONG_GRASS_1C     EQU $1c ; unused
+DEF COLL_LONG_GRASS_1C     EQU $1c ; unused
-COLL_HEADBUTT_TREE_1D  EQU $1d ; unused
+DEF COLL_HEADBUTT_TREE_1D  EQU $1d ; unused
-COLL_WATER_21          EQU $21 ; unused
+DEF COLL_WATER_21          EQU $21 ; unused
-COLL_ICE               EQU $23
+DEF COLL_ICE               EQU $23
-COLL_WHIRLPOOL         EQU $24
+DEF COLL_WHIRLPOOL         EQU $24
-COLL_BUOY              EQU $27
+DEF COLL_BUOY              EQU $27
-COLL_CUT_28            EQU $28 ; garbage
+DEF COLL_CUT_28            EQU $28 ; garbage
-COLL_WATER             EQU $29
+DEF COLL_WATER             EQU $29
-COLL_ICE_2B            EQU $2b ; unused
+DEF COLL_ICE_2B            EQU $2b ; unused
-COLL_WHIRLPOOL_2C      EQU $2c ; unused
+DEF COLL_WHIRLPOOL_2C      EQU $2c ; unused
-COLL_WATERFALL_RIGHT   EQU $30 ; unused
+DEF COLL_WATERFALL_RIGHT   EQU $30 ; unused
-COLL_WATERFALL_LEFT    EQU $31 ; unused
+DEF COLL_WATERFALL_LEFT    EQU $31 ; unused
-COLL_WATERFALL_UP      EQU $32 ; unused
+DEF COLL_WATERFALL_UP      EQU $32 ; unused
-COLL_WATERFALL         EQU $33
+DEF COLL_WATERFALL         EQU $33
-COLL_CURRENT_RIGHT     EQU $38 ; unused
+DEF COLL_CURRENT_RIGHT     EQU $38 ; unused
-COLL_CURRENT_LEFT      EQU $39 ; unused
+DEF COLL_CURRENT_LEFT      EQU $39 ; unused
-COLL_CURRENT_UP        EQU $3a ; unused
+DEF COLL_CURRENT_UP        EQU $3a ; unused
-COLL_CURRENT_DOWN      EQU $3b ; unused
+DEF COLL_CURRENT_DOWN      EQU $3b ; unused
-COLL_BRAKE             EQU $40 ; unused
+DEF COLL_BRAKE             EQU $40 ; unused
-COLL_WALK_RIGHT        EQU $41 ; unused
+DEF COLL_WALK_RIGHT        EQU $41 ; unused
-COLL_WALK_LEFT         EQU $42 ; unused
+DEF COLL_WALK_LEFT         EQU $42 ; unused
-COLL_WALK_UP           EQU $43 ; unused
+DEF COLL_WALK_UP           EQU $43 ; unused
-COLL_WALK_DOWN         EQU $44 ; unused
+DEF COLL_WALK_DOWN         EQU $44 ; unused
-COLL_BRAKE_45          EQU $45 ; garbage
+DEF COLL_BRAKE_45          EQU $45 ; garbage
-COLL_BRAKE_46          EQU $46 ; unused
+DEF COLL_BRAKE_46          EQU $46 ; unused
-COLL_BRAKE_47          EQU $47 ; unused
+DEF COLL_BRAKE_47          EQU $47 ; unused
-COLL_GRASS_48          EQU $48 ; unused
+DEF COLL_GRASS_48          EQU $48 ; unused
-COLL_GRASS_49          EQU $49 ; unused
+DEF COLL_GRASS_49          EQU $49 ; unused
-COLL_GRASS_4A          EQU $4a ; garbage
+DEF COLL_GRASS_4A          EQU $4a ; garbage
-COLL_GRASS_4B          EQU $4b ; garbage
+DEF COLL_GRASS_4B          EQU $4b ; garbage
-COLL_GRASS_4C          EQU $4c ; unused
+DEF COLL_GRASS_4C          EQU $4c ; unused
-COLL_WALK_RIGHT_ALT    EQU $50 ; unused
+DEF COLL_WALK_RIGHT_ALT    EQU $50 ; unused
-COLL_WALK_LEFT_ALT     EQU $51 ; unused
+DEF COLL_WALK_LEFT_ALT     EQU $51 ; unused
-COLL_WALK_UP_ALT       EQU $52 ; unused
+DEF COLL_WALK_UP_ALT       EQU $52 ; unused
-COLL_WALK_DOWN_ALT     EQU $53 ; unused
+DEF COLL_WALK_DOWN_ALT     EQU $53 ; unused
-COLL_BRAKE_ALT         EQU $54 ; unused
+DEF COLL_BRAKE_ALT         EQU $54 ; unused
-COLL_BRAKE_55          EQU $55 ; unused
+DEF COLL_BRAKE_55          EQU $55 ; unused
-COLL_BRAKE_56          EQU $56 ; unused
+DEF COLL_BRAKE_56          EQU $56 ; unused
-COLL_BRAKE_57          EQU $57 ; unused
+DEF COLL_BRAKE_57          EQU $57 ; unused
-COLL_5B                EQU $5b ; garbage
+DEF COLL_5B                EQU $5b ; garbage
-COLL_PIT               EQU $60
+DEF COLL_PIT               EQU $60
-COLL_VIRTUAL_BOY       EQU $61 ; garbage
+DEF COLL_VIRTUAL_BOY       EQU $61 ; garbage
-COLL_64                EQU $64 ; garbage
+DEF COLL_64                EQU $64 ; garbage
-COLL_65                EQU $65 ; garbage
+DEF COLL_65                EQU $65 ; garbage
-COLL_PIT_68            EQU $68 ; unused
+DEF COLL_PIT_68            EQU $68 ; unused
-COLL_WARP_CARPET_DOWN  EQU $70
+DEF COLL_WARP_CARPET_DOWN  EQU $70
-COLL_DOOR              EQU $71
+DEF COLL_DOOR              EQU $71
-COLL_LADDER            EQU $72
+DEF COLL_LADDER            EQU $72
-COLL_STAIRCASE_73      EQU $73 ; unused
+DEF COLL_STAIRCASE_73      EQU $73 ; unused
-COLL_CAVE_74           EQU $74 ; unused
+DEF COLL_CAVE_74           EQU $74 ; unused
-COLL_DOOR_75           EQU $75 ; unused
+DEF COLL_DOOR_75           EQU $75 ; unused
-COLL_WARP_CARPET_LEFT  EQU $76
+DEF COLL_WARP_CARPET_LEFT  EQU $76
-COLL_WARP_77           EQU $77 ; unused
+DEF COLL_WARP_77           EQU $77 ; unused
-COLL_WARP_CARPET_UP    EQU $78
+DEF COLL_WARP_CARPET_UP    EQU $78
-COLL_DOOR_79           EQU $79 ; unused
+DEF COLL_DOOR_79           EQU $79 ; unused
-COLL_STAIRCASE         EQU $7a
+DEF COLL_STAIRCASE         EQU $7a
-COLL_CAVE              EQU $7b
+DEF COLL_CAVE              EQU $7b
-COLL_WARP_PANEL        EQU $7c
+DEF COLL_WARP_PANEL        EQU $7c
-COLL_DOOR_7D           EQU $7d ; unused
+DEF COLL_DOOR_7D           EQU $7d ; unused
-COLL_WARP_CARPET_RIGHT EQU $7e
+DEF COLL_WARP_CARPET_RIGHT EQU $7e
-COLL_WARP_7F           EQU $7f ; unused
+DEF COLL_WARP_7F           EQU $7f ; unused
-COLL_COUNTER           EQU $90
+DEF COLL_COUNTER           EQU $90
-COLL_BOOKSHELF         EQU $91
+DEF COLL_BOOKSHELF         EQU $91
-COLL_PC                EQU $93
+DEF COLL_PC                EQU $93
-COLL_RADIO             EQU $94
+DEF COLL_RADIO             EQU $94
-COLL_TOWN_MAP          EQU $95
+DEF COLL_TOWN_MAP          EQU $95
-COLL_MART_SHELF        EQU $96
+DEF COLL_MART_SHELF        EQU $96
-COLL_TV                EQU $97
+DEF COLL_TV                EQU $97
-COLL_COUNTER_98        EQU $98 ; unused
+DEF COLL_COUNTER_98        EQU $98 ; unused
-COLL_9C                EQU $9c ; garbage
+DEF COLL_9C                EQU $9c ; garbage
-COLL_WINDOW            EQU $9d
+DEF COLL_WINDOW            EQU $9d
-COLL_INCENSE_BURNER    EQU $9f
+DEF COLL_INCENSE_BURNER    EQU $9f
-COLL_HOP_RIGHT         EQU $a0
+DEF COLL_HOP_RIGHT         EQU $a0
-COLL_HOP_LEFT          EQU $a1
+DEF COLL_HOP_LEFT          EQU $a1
-COLL_HOP_UP            EQU $a2 ; unused
+DEF COLL_HOP_UP            EQU $a2 ; unused
-COLL_HOP_DOWN          EQU $a3
+DEF COLL_HOP_DOWN          EQU $a3
-COLL_HOP_DOWN_RIGHT    EQU $a4
+DEF COLL_HOP_DOWN_RIGHT    EQU $a4
-COLL_HOP_DOWN_LEFT     EQU $a5
+DEF COLL_HOP_DOWN_LEFT     EQU $a5
-COLL_HOP_UP_RIGHT      EQU $a6 ; unused
+DEF COLL_HOP_UP_RIGHT      EQU $a6 ; unused
-COLL_HOP_UP_LEFT       EQU $a7 ; unused
+DEF COLL_HOP_UP_LEFT       EQU $a7 ; unused
-COLL_RIGHT_WALL        EQU $b0
+DEF COLL_RIGHT_WALL        EQU $b0
-COLL_LEFT_WALL         EQU $b1
+DEF COLL_LEFT_WALL         EQU $b1
-COLL_UP_WALL           EQU $b2
+DEF COLL_UP_WALL           EQU $b2
-COLL_DOWN_WALL         EQU $b3 ; unused
+DEF COLL_DOWN_WALL         EQU $b3 ; unused
-COLL_DOWN_RIGHT_WALL   EQU $b4 ; unused
+DEF COLL_DOWN_RIGHT_WALL   EQU $b4 ; unused
-COLL_DOWN_LEFT_WALL    EQU $b5 ; unused
+DEF COLL_DOWN_LEFT_WALL    EQU $b5 ; unused
-COLL_UP_RIGHT_WALL     EQU $b6 ; unused
+DEF COLL_UP_RIGHT_WALL     EQU $b6 ; unused
-COLL_UP_LEFT_WALL      EQU $b7 ; unused
+DEF COLL_UP_LEFT_WALL      EQU $b7 ; unused
-COLL_RIGHT_BUOY        EQU $c0 ; unused
+DEF COLL_RIGHT_BUOY        EQU $c0 ; unused
-COLL_LEFT_BUOY         EQU $c1 ; unused
+DEF COLL_LEFT_BUOY         EQU $c1 ; unused
-COLL_UP_BUOY           EQU $c2 ; unused
+DEF COLL_UP_BUOY           EQU $c2 ; unused
-COLL_DOWN_BUOY         EQU $c3 ; unused
+DEF COLL_DOWN_BUOY         EQU $c3 ; unused
-COLL_DOWN_RIGHT_BUOY   EQU $c4 ; unused
+DEF COLL_DOWN_RIGHT_BUOY   EQU $c4 ; unused
-COLL_DOWN_LEFT_BUOY    EQU $c5 ; unused
+DEF COLL_DOWN_LEFT_BUOY    EQU $c5 ; unused
-COLL_UP_RIGHT_BUOY     EQU $c6 ; unused
+DEF COLL_UP_RIGHT_BUOY     EQU $c6 ; unused
-COLL_UP_LEFT_BUOY      EQU $c7 ; unused
+DEF COLL_UP_LEFT_BUOY      EQU $c7 ; unused
-COLL_FF                EQU $ff ; garbage
+DEF COLL_FF                EQU $ff ; garbage
 
 ; collision data type nybbles
-LO_NYBBLE_GRASS      EQU $07
+DEF LO_NYBBLE_GRASS      EQU $07
-HI_NYBBLE_TALL_GRASS EQU $10
+DEF HI_NYBBLE_TALL_GRASS EQU $10
-HI_NYBBLE_WATER      EQU $20
+DEF HI_NYBBLE_WATER      EQU $20
-HI_NYBBLE_CURRENT    EQU $30
+DEF HI_NYBBLE_CURRENT    EQU $30
-HI_NYBBLE_WALK       EQU $40
+DEF HI_NYBBLE_WALK       EQU $40
-HI_NYBBLE_WALK_ALT   EQU $50
+DEF HI_NYBBLE_WALK_ALT   EQU $50
-HI_NYBBLE_WARPS      EQU $70
+DEF HI_NYBBLE_WARPS      EQU $70
-HI_NYBBLE_LEDGES     EQU $a0
+DEF HI_NYBBLE_LEDGES     EQU $a0
-HI_NYBBLE_SIDE_WALLS EQU $b0
+DEF HI_NYBBLE_SIDE_WALLS EQU $b0
-HI_NYBBLE_SIDE_BUOYS EQU $c0
+DEF HI_NYBBLE_SIDE_BUOYS EQU $c0

constants/credits_constants.asm

@@ -103,7 +103,7 @@
 	const US_COORDINATION
 	const TEXT_TRANSLATION
 	const PAAD_TESTING
-NUM_CREDITS_STRINGS EQU const_value
+DEF NUM_CREDITS_STRINGS EQU const_value
 
 ; CreditsScript indexes (see data/credits_script.asm)
 	const_def -1, -1

constants/cry_constants.asm

@@ -73,4 +73,4 @@
 	const CRY_DUNSPARCE
 	const CRY_DONPHAN
 
-NUM_CRIES EQU const_value
+DEF NUM_CRIES EQU const_value

constants/deco_constants.asm

@@ -1,11 +1,11 @@
 ; decoration attributes
 rsreset
-DECOATTR_TYPE       rb
+DEF DECOATTR_TYPE       rb
-DECOATTR_NAME       rb
+DEF DECOATTR_NAME       rb
-DECOATTR_ACTION     rb
+DEF DECOATTR_ACTION     rb
-DECOATTR_EVENT_FLAG rw
+DEF DECOATTR_EVENT_FLAG rw
-DECOATTR_SPRITE     rb
+DEF DECOATTR_SPRITE     rb
-DECOATTR_STRUCT_LENGTH EQU _RS
+DEF DECOATTR_STRUCT_LENGTH EQU _RS
 
 ; decoration types
 	const_def 1
@@ -15,7 +15,7 @@ DECOATTR_STRUCT_LENGTH EQU _RS
 	const DECO_POSTER
 	const DECO_DOLL
 	const DECO_BIGDOLL
-NUM_DECO_TYPES EQU const_value - 1
+DEF NUM_DECO_TYPES EQU const_value - 1
 
 ; DecorationNames indexes (see data/decorations/names.asm)
 	const_def
@@ -45,7 +45,7 @@ NUM_DECO_TYPES EQU const_value - 1
 	const BLUE_CARPET
 	const YELLOW_CARPET
 	const GREEN_CARPET
-NUM_DECO_NAMES EQU const_value
+DEF NUM_DECO_NAMES EQU const_value
 
 ; DoDecorationAction2.DecoActions indexes (see engine/overworld/decorations.asm)
 	const_def 1
@@ -63,14 +63,14 @@ NUM_DECO_NAMES EQU const_value
 	const PUT_AWAY_BIG_DOLL
 	const SET_UP_DOLL
 	const PUT_AWAY_DOLL
-NUM_DECO_ACTIONS EQU const_value - 1
+DEF NUM_DECO_ACTIONS EQU const_value - 1
 
-__deco_value__ = 0
+DEF __deco_value__ = 0
 
-deco: MACRO
+MACRO deco
 	const DECO_\1
-DECOFLAG_\1 EQU __deco_value__
+	DEF DECOFLAG_\1 EQU __deco_value__
-__deco_value__ += 1
+	DEF __deco_value__ += 1
 ENDM
 
 ; decorations:
@@ -134,8 +134,8 @@ ENDM
 	deco  GEODUDE_DOLL
 	deco  MACHOP_DOLL
 	deco  TENTACOOL_DOLL
-NUM_NON_TROPHY_DECOS EQU __deco_value__
+DEF NUM_NON_TROPHY_DECOS EQU __deco_value__
 	deco  GOLD_TROPHY_DOLL
 	deco  SILVER_TROPHY_DOLL
-NUM_DECOS EQU __deco_value__
+DEF NUM_DECOS EQU __deco_value__
-NUM_DECO_CATEGORIES EQU const_value - 1 - NUM_DECOS
+DEF NUM_DECO_CATEGORIES EQU const_value - 1 - NUM_DECOS

constants/engine_flags.asm

@@ -187,4 +187,4 @@
 ; wSwarmFlags
 	const ENGINE_DUNSPARCE_SWARM
 	const ENGINE_YANMA_SWARM
-NUM_ENGINE_FLAGS EQU const_value
+DEF NUM_ENGINE_FLAGS EQU const_value

constants/event_flags.asm

@@ -1459,4 +1459,4 @@
 ; Unused: next 48 events
 
 	const_next 2048
-NUM_EVENTS EQU const_value ; 800
+DEF NUM_EVENTS EQU const_value ; 800

constants/gfx_constants.asm

@@ -1,48 +1,48 @@
-TILE_WIDTH EQU 8 ; pixels
+DEF TILE_WIDTH EQU 8 ; pixels
-LEN_1BPP_TILE EQU 1 * TILE_WIDTH ; bytes
+DEF LEN_1BPP_TILE EQU 1 * TILE_WIDTH ; bytes
-LEN_2BPP_TILE EQU 2 * TILE_WIDTH ; bytes
+DEF LEN_2BPP_TILE EQU 2 * TILE_WIDTH ; bytes
 
-NUM_PAL_COLORS EQU 4
+DEF NUM_PAL_COLORS EQU 4
-PAL_COLOR_SIZE EQU 2
+DEF PAL_COLOR_SIZE EQU 2
-PALETTE_SIZE EQU NUM_PAL_COLORS * PAL_COLOR_SIZE
+DEF PALETTE_SIZE EQU NUM_PAL_COLORS * PAL_COLOR_SIZE
 
-PALRGB_WHITE EQU palred 31 + palgreen 31 + palblue 31 ; $7fff
+DEF PALRGB_WHITE EQU palred 31 + palgreen 31 + palblue 31 ; $7fff
 
-SCREEN_WIDTH  EQU 20 ; tiles
+DEF SCREEN_WIDTH  EQU 20 ; tiles
-SCREEN_HEIGHT EQU 18 ; tiles
+DEF SCREEN_HEIGHT EQU 18 ; tiles
-SCREEN_WIDTH_PX  EQU SCREEN_WIDTH  * TILE_WIDTH ; pixels
+DEF SCREEN_WIDTH_PX  EQU SCREEN_WIDTH  * TILE_WIDTH ; pixels
-SCREEN_HEIGHT_PX EQU SCREEN_HEIGHT * TILE_WIDTH ; pixels
+DEF SCREEN_HEIGHT_PX EQU SCREEN_HEIGHT * TILE_WIDTH ; pixels
 
-BG_MAP_WIDTH  EQU 32 ; tiles
+DEF BG_MAP_WIDTH  EQU 32 ; tiles
-BG_MAP_HEIGHT EQU 32 ; tiles
+DEF BG_MAP_HEIGHT EQU 32 ; tiles
 
-METATILE_WIDTH EQU 4 ; tiles
+DEF METATILE_WIDTH EQU 4 ; tiles
-SCREEN_META_WIDTH EQU 6 ; metatiles
+DEF SCREEN_META_WIDTH EQU 6 ; metatiles
-SCREEN_META_HEIGHT EQU 5 ; metatiles
+DEF SCREEN_META_HEIGHT EQU 5 ; metatiles
-SURROUNDING_WIDTH  EQU SCREEN_META_WIDTH * METATILE_WIDTH ; tiles
+DEF SURROUNDING_WIDTH  EQU SCREEN_META_WIDTH * METATILE_WIDTH ; tiles
-SURROUNDING_HEIGHT EQU SCREEN_META_HEIGHT * METATILE_WIDTH ; tiles
+DEF SURROUNDING_HEIGHT EQU SCREEN_META_HEIGHT * METATILE_WIDTH ; tiles
-MAP_CONNECTION_PADDING_WIDTH EQU 3 ; metatiles
+DEF MAP_CONNECTION_PADDING_WIDTH EQU 3 ; metatiles
 
-HP_BAR_LENGTH  EQU 6 ; tiles
+DEF HP_BAR_LENGTH  EQU 6 ; tiles
-EXP_BAR_LENGTH EQU 8 ; tiles
+DEF EXP_BAR_LENGTH EQU 8 ; tiles
-HP_BAR_LENGTH_PX  EQU HP_BAR_LENGTH  * TILE_WIDTH ; pixels
+DEF HP_BAR_LENGTH_PX  EQU HP_BAR_LENGTH  * TILE_WIDTH ; pixels
-EXP_BAR_LENGTH_PX EQU EXP_BAR_LENGTH * TILE_WIDTH ; pixels
+DEF EXP_BAR_LENGTH_PX EQU EXP_BAR_LENGTH * TILE_WIDTH ; pixels
 
 ; GetHPPal return values (see home/tilemap.asm)
-HP_GREEN  EQU 0
+DEF HP_GREEN  EQU 0
-HP_YELLOW EQU 1
+DEF HP_YELLOW EQU 1
-HP_RED    EQU 2
+DEF HP_RED    EQU 2
 
 ; sprite_oam_struct members (see macros/wram.asm)
 rsreset
-SPRITEOAMSTRUCT_YCOORD     rb ; 0
+DEF SPRITEOAMSTRUCT_YCOORD     rb ; 0
-SPRITEOAMSTRUCT_XCOORD     rb ; 1
+DEF SPRITEOAMSTRUCT_XCOORD     rb ; 1
-SPRITEOAMSTRUCT_TILE_ID    rb ; 2
+DEF SPRITEOAMSTRUCT_TILE_ID    rb ; 2
-SPRITEOAMSTRUCT_ATTRIBUTES rb ; 3
+DEF SPRITEOAMSTRUCT_ATTRIBUTES rb ; 3
-SPRITEOAMSTRUCT_LENGTH EQU _RS
+DEF SPRITEOAMSTRUCT_LENGTH EQU _RS
-NUM_SPRITE_OAM_STRUCTS EQU 40 ; see wVirtualOAM
+DEF NUM_SPRITE_OAM_STRUCTS EQU 40 ; see wVirtualOAM
 
-SPRITE_GFX_LIST_CAPACITY EQU 32 ; see wUsedSprites
+DEF SPRITE_GFX_LIST_CAPACITY EQU 32 ; see wUsedSprites
 
 ; PokeAnims indexes (see engine/gfx/pic_animation.asm)
 	const_def

constants/hardware_constants.asm

@@ -4,165 +4,165 @@
 ; http://gameboy.mongenel.com/dmg/asmmemmap.html
 
 ; memory map
-VRAM_Begin  EQU $8000
+DEF VRAM_Begin  EQU $8000
-VRAM_End    EQU $a000
+DEF VRAM_End    EQU $a000
-SRAM_Begin  EQU $a000
+DEF SRAM_Begin  EQU $a000
-SRAM_End    EQU $c000
+DEF SRAM_End    EQU $c000
-WRAM0_Begin EQU $c000
+DEF WRAM0_Begin EQU $c000
-WRAM0_End   EQU $d000
+DEF WRAM0_End   EQU $d000
-WRAM1_Begin EQU $d000
+DEF WRAM1_Begin EQU $d000
-WRAM1_End   EQU $e000
+DEF WRAM1_End   EQU $e000
 ; hardware registers $ff00-$ff80 (see below)
-HRAM_Begin  EQU $ff80
+DEF HRAM_Begin  EQU $ff80
-HRAM_End    EQU $ffff
+DEF HRAM_End    EQU $ffff
 
 ; MBC3
-MBC3SRamEnable EQU $0000
+DEF MBC3SRamEnable EQU $0000
-MBC3RomBank    EQU $2000
+DEF MBC3RomBank    EQU $2000
-MBC3SRamBank   EQU $4000
+DEF MBC3SRamBank   EQU $4000
-MBC3LatchClock EQU $6000
+DEF MBC3LatchClock EQU $6000
-MBC3RTC        EQU $a000
+DEF MBC3RTC        EQU $a000
 
-SRAM_DISABLE EQU $00
+DEF SRAM_DISABLE EQU $00
-SRAM_ENABLE  EQU $0a
+DEF SRAM_ENABLE  EQU $0a
 
-NUM_SRAM_BANKS EQU 4
+DEF NUM_SRAM_BANKS EQU 4
 
-RTC_S  EQU $08 ; Seconds   0-59 (0-3Bh)
+DEF RTC_S  EQU $08 ; Seconds   0-59 (0-3Bh)
-RTC_M  EQU $09 ; Minutes   0-59 (0-3Bh)
+DEF RTC_M  EQU $09 ; Minutes   0-59 (0-3Bh)
-RTC_H  EQU $0a ; Hours     0-23 (0-17h)
+DEF RTC_H  EQU $0a ; Hours     0-23 (0-17h)
-RTC_DL EQU $0b ; Lower 8 bits of Day Counter (0-FFh)
+DEF RTC_DL EQU $0b ; Lower 8 bits of Day Counter (0-FFh)
-RTC_DH EQU $0c ; Upper 1 bit of Day Counter, Carry Bit, Halt Flag
+DEF RTC_DH EQU $0c ; Upper 1 bit of Day Counter, Carry Bit, Halt Flag
-               ; Bit 0  Most significant bit of Day Counter (Bit 8)
+                   ; Bit 0  Most significant bit of Day Counter (Bit 8)
-               ; Bit 6  Halt (0=Active, 1=Stop Timer)
+                   ; Bit 6  Halt (0=Active, 1=Stop Timer)
-               ; Bit 7  Day Counter Carry Bit (1=Counter Overflow)
+                   ; Bit 7  Day Counter Carry Bit (1=Counter Overflow)
 
 ; interrupt flags
-VBLANK   EQU 0
+DEF VBLANK     EQU 0
-LCD_STAT EQU 1
+DEF LCD_STAT   EQU 1
-TIMER    EQU 2
+DEF TIMER      EQU 2
-SERIAL   EQU 3
+DEF SERIAL     EQU 3
-JOYPAD   EQU 4
+DEF JOYPAD     EQU 4
-IE_DEFAULT EQU (1 << SERIAL) | (1 << TIMER) | (1 << LCD_STAT) | (1 << VBLANK)
+DEF IE_DEFAULT EQU (1 << SERIAL) | (1 << TIMER) | (1 << LCD_STAT) | (1 << VBLANK)
 
 ; OAM attribute flags
-OAM_TILE_BANK EQU 3
+DEF OAM_TILE_BANK EQU 3
-OAM_OBP_NUM   EQU 4 ; non CGB Mode Only
+DEF OAM_OBP_NUM   EQU 4 ; non CGB Mode Only
-OAM_X_FLIP    EQU 5
+DEF OAM_X_FLIP    EQU 5
-OAM_Y_FLIP    EQU 6
+DEF OAM_Y_FLIP    EQU 6
-OAM_PRIORITY  EQU 7 ; 0: OBJ above BG, 1: OBJ behind BG (colors 1-3)
+DEF OAM_PRIORITY  EQU 7 ; 0: OBJ above BG, 1: OBJ behind BG (colors 1-3)
 
 ; BG Map attribute flags
-PALETTE_MASK EQU %111
+DEF PALETTE_MASK EQU %111
-VRAM_BANK_1  EQU 1 << OAM_TILE_BANK ; $08
+DEF VRAM_BANK_1  EQU 1 << OAM_TILE_BANK ; $08
-OBP_NUM      EQU 1 << OAM_OBP_NUM   ; $10
+DEF OBP_NUM      EQU 1 << OAM_OBP_NUM   ; $10
-X_FLIP       EQU 1 << OAM_X_FLIP    ; $20
+DEF X_FLIP       EQU 1 << OAM_X_FLIP    ; $20
-Y_FLIP       EQU 1 << OAM_Y_FLIP    ; $40
+DEF Y_FLIP       EQU 1 << OAM_Y_FLIP    ; $40
-PRIORITY     EQU 1 << OAM_PRIORITY  ; $80
+DEF PRIORITY     EQU 1 << OAM_PRIORITY  ; $80
 
 ; Hardware registers
-rJOYP       EQU $ff00 ; Joypad (R/W)
+DEF rJOYP                EQU $ff00 ; Joypad (R/W)
-rSB         EQU $ff01 ; Serial transfer data (R/W)
+DEF rSB                  EQU $ff01 ; Serial transfer data (R/W)
-rSC         EQU $ff02 ; Serial Transfer Control (R/W)
+DEF rSC                  EQU $ff02 ; Serial Transfer Control (R/W)
-rSC_ON      EQU 7
+DEF rSC_ON               EQU 7
-rSC_CGB     EQU 1
+DEF rSC_CGB              EQU 1
-rSC_CLOCK   EQU 0
+DEF rSC_CLOCK            EQU 0
-rDIV        EQU $ff04 ; Divider Register (R/W)
+DEF rDIV                 EQU $ff04 ; Divider Register (R/W)
-rTIMA       EQU $ff05 ; Timer counter (R/W)
+DEF rTIMA                EQU $ff05 ; Timer counter (R/W)
-rTMA        EQU $ff06 ; Timer Modulo (R/W)
+DEF rTMA                 EQU $ff06 ; Timer Modulo (R/W)
-rTAC        EQU $ff07 ; Timer Control (R/W)
+DEF rTAC                 EQU $ff07 ; Timer Control (R/W)
-rTAC_ON        EQU 2
+DEF rTAC_ON              EQU 2
-rTAC_4096_HZ   EQU %00
+DEF rTAC_4096_HZ         EQU %00
-rTAC_262144_HZ EQU %01
+DEF rTAC_262144_HZ       EQU %01
-rTAC_65536_HZ  EQU %10
+DEF rTAC_65536_HZ        EQU %10
-rTAC_16384_HZ  EQU %11
+DEF rTAC_16384_HZ        EQU %11
-rIF         EQU $ff0f ; Interrupt Flag (R/W)
+DEF rIF                  EQU $ff0f ; Interrupt Flag (R/W)
-rNR10       EQU $ff10 ; Channel 1 Sweep register (R/W)
+DEF rNR10                EQU $ff10 ; Channel 1 Sweep register (R/W)
-rNR11       EQU $ff11 ; Channel 1 Sound length/Wave pattern duty (R/W)
+DEF rNR11                EQU $ff11 ; Channel 1 Sound length/Wave pattern duty (R/W)
-rNR12       EQU $ff12 ; Channel 1 Volume Envelope (R/W)
+DEF rNR12                EQU $ff12 ; Channel 1 Volume Envelope (R/W)
-rNR13       EQU $ff13 ; Channel 1 Frequency lo (Write Only)
+DEF rNR13                EQU $ff13 ; Channel 1 Frequency lo (Write Only)
-rNR14       EQU $ff14 ; Channel 1 Frequency hi (R/W)
+DEF rNR14                EQU $ff14 ; Channel 1 Frequency hi (R/W)
-rNR20       EQU $ff15 ; Channel 2 Sweep register (R/W)
+DEF rNR20                EQU $ff15 ; Channel 2 Sweep register (R/W)
-rNR21       EQU $ff16 ; Channel 2 Sound Length/Wave Pattern Duty (R/W)
+DEF rNR21                EQU $ff16 ; Channel 2 Sound Length/Wave Pattern Duty (R/W)
-rNR22       EQU $ff17 ; Channel 2 Volume Envelope (R/W)
+DEF rNR22                EQU $ff17 ; Channel 2 Volume Envelope (R/W)
-rNR23       EQU $ff18 ; Channel 2 Frequency lo data (W)
+DEF rNR23                EQU $ff18 ; Channel 2 Frequency lo data (W)
-rNR24       EQU $ff19 ; Channel 2 Frequency hi data (R/W)
+DEF rNR24                EQU $ff19 ; Channel 2 Frequency hi data (R/W)
-rNR30       EQU $ff1a ; Channel 3 Sound on/off (R/W)
+DEF rNR30                EQU $ff1a ; Channel 3 Sound on/off (R/W)
-rNR31       EQU $ff1b ; Channel 3 Sound Length
+DEF rNR31                EQU $ff1b ; Channel 3 Sound Length
-rNR32       EQU $ff1c ; Channel 3 Select output level (R/W)
+DEF rNR32                EQU $ff1c ; Channel 3 Select output level (R/W)
-rNR33       EQU $ff1d ; Channel 3 Frequency's lower data (W)
+DEF rNR33                EQU $ff1d ; Channel 3 Frequency's lower data (W)
-rNR34       EQU $ff1e ; Channel 3 Frequency's higher data (R/W)
+DEF rNR34                EQU $ff1e ; Channel 3 Frequency's higher data (R/W)
-rNR40       EQU $ff1f ; Channel 4 Sweep register (R/W)
+DEF rNR40                EQU $ff1f ; Channel 4 Sweep register (R/W)
-rNR41       EQU $ff20 ; Channel 4 Sound Length (R/W)
+DEF rNR41                EQU $ff20 ; Channel 4 Sound Length (R/W)
-rNR42       EQU $ff21 ; Channel 4 Volume Envelope (R/W)
+DEF rNR42                EQU $ff21 ; Channel 4 Volume Envelope (R/W)
-rNR43       EQU $ff22 ; Channel 4 Polynomial Counter (R/W)
+DEF rNR43                EQU $ff22 ; Channel 4 Polynomial Counter (R/W)
-rNR44       EQU $ff23 ; Channel 4 Counter/consecutive; Inital (R/W)
+DEF rNR44                EQU $ff23 ; Channel 4 Counter/consecutive; Inital (R/W)
-rNR50       EQU $ff24 ; Channel control / ON-OFF / Volume (R/W)
+DEF rNR50                EQU $ff24 ; Channel control / ON-OFF / Volume (R/W)
-rNR51       EQU $ff25 ; Selection of Sound output terminal (R/W)
+DEF rNR51                EQU $ff25 ; Selection of Sound output terminal (R/W)
-rNR52       EQU $ff26 ; Sound on/off
+DEF rNR52                EQU $ff26 ; Sound on/off
-rWave_0     EQU $ff30
+DEF rWave_0              EQU $ff30
-rWave_1     EQU $ff31
+DEF rWave_1              EQU $ff31
-rWave_2     EQU $ff32
+DEF rWave_2              EQU $ff32
-rWave_3     EQU $ff33
+DEF rWave_3              EQU $ff33
-rWave_4     EQU $ff34
+DEF rWave_4              EQU $ff34
-rWave_5     EQU $ff35
+DEF rWave_5              EQU $ff35
-rWave_6     EQU $ff36
+DEF rWave_6              EQU $ff36
-rWave_7     EQU $ff37
+DEF rWave_7              EQU $ff37
-rWave_8     EQU $ff38
+DEF rWave_8              EQU $ff38
-rWave_9     EQU $ff39
+DEF rWave_9              EQU $ff39
-rWave_a     EQU $ff3a
+DEF rWave_a              EQU $ff3a
-rWave_b     EQU $ff3b
+DEF rWave_b              EQU $ff3b
-rWave_c     EQU $ff3c
+DEF rWave_c              EQU $ff3c
-rWave_d     EQU $ff3d
+DEF rWave_d              EQU $ff3d
-rWave_e     EQU $ff3e
+DEF rWave_e              EQU $ff3e
-rWave_f     EQU $ff3f
+DEF rWave_f              EQU $ff3f
-rLCDC       EQU $ff40 ; LCD Control (R/W)
+DEF rLCDC                EQU $ff40 ; LCD Control (R/W)
-rLCDC_BG_PRIORITY    EQU 0 ; 0=Off, 1=On
+DEF rLCDC_BG_PRIORITY    EQU 0     ; 0=Off, 1=On
-rLCDC_SPRITES_ENABLE EQU 1 ; 0=Off, 1=On
+DEF rLCDC_SPRITES_ENABLE EQU 1     ; 0=Off, 1=On
-rLCDC_SPRITE_SIZE    EQU 2 ; 0=8x8, 1=8x16
+DEF rLCDC_SPRITE_SIZE    EQU 2     ; 0=8x8, 1=8x16
-rLCDC_BG_TILEMAP     EQU 3 ; 0=9800-9BFF, 1=9C00-9FFF
+DEF rLCDC_BG_TILEMAP     EQU 3     ; 0=9800-9BFF, 1=9C00-9FFF
-rLCDC_TILE_DATA      EQU 4 ; 0=8800-97FF, 1=8000-8FFF
+DEF rLCDC_TILE_DATA      EQU 4     ; 0=8800-97FF, 1=8000-8FFF
-rLCDC_WINDOW_ENABLE  EQU 5 ; 0=Off, 1=On
+DEF rLCDC_WINDOW_ENABLE  EQU 5     ; 0=Off, 1=On
-rLCDC_WINDOW_TILEMAP EQU 6 ; 0=9800-9BFF, 1=9C00-9FFF
+DEF rLCDC_WINDOW_TILEMAP EQU 6     ; 0=9800-9BFF, 1=9C00-9FFF
-rLCDC_ENABLE         EQU 7 ; 0=Off, 1=On
+DEF rLCDC_ENABLE         EQU 7     ; 0=Off, 1=On
-LCDC_DEFAULT EQU (1 << rLCDC_ENABLE) | (1 << rLCDC_WINDOW_TILEMAP) | (1 << rLCDC_WINDOW_ENABLE) | (1 << rLCDC_SPRITES_ENABLE) | (1 << rLCDC_BG_PRIORITY)
+DEF LCDC_DEFAULT         EQU (1 << rLCDC_ENABLE) | (1 << rLCDC_WINDOW_TILEMAP) | (1 << rLCDC_WINDOW_ENABLE) | (1 << rLCDC_SPRITES_ENABLE) | (1 << rLCDC_BG_PRIORITY)
-rSTAT       EQU $ff41 ; LCDC Status (R/W)
+DEF rSTAT                EQU $ff41 ; LCDC Status (R/W)
-rSCY        EQU $ff42 ; Scroll Y (R/W)
+DEF rSCY                 EQU $ff42 ; Scroll Y (R/W)
-rSCX        EQU $ff43 ; Scroll X (R/W)
+DEF rSCX                 EQU $ff43 ; Scroll X (R/W)
-rLY         EQU $ff44 ; LCDC Y-Coordinate (R)
+DEF rLY                  EQU $ff44 ; LCDC Y-Coordinate (R)
-LY_VBLANK EQU 144
+DEF LY_VBLANK            EQU 144
-rLYC        EQU $ff45 ; LY Compare (R/W)
+DEF rLYC                 EQU $ff45 ; LY Compare (R/W)
-rDMA        EQU $ff46 ; DMA Transfer and Start Address (W)
+DEF rDMA                 EQU $ff46 ; DMA Transfer and Start Address (W)
-rBGP        EQU $ff47 ; BG Palette Data (R/W) - Non CGB Mode Only
+DEF rBGP                 EQU $ff47 ; BG Palette Data (R/W) - Non CGB Mode Only
-rOBP0       EQU $ff48 ; Object Palette 0 Data (R/W) - Non CGB Mode Only
+DEF rOBP0                EQU $ff48 ; Object Palette 0 Data (R/W) - Non CGB Mode Only
-rOBP1       EQU $ff49 ; Object Palette 1 Data (R/W) - Non CGB Mode Only
+DEF rOBP1                EQU $ff49 ; Object Palette 1 Data (R/W) - Non CGB Mode Only
-rWY         EQU $ff4a ; Window Y Position (R/W)
+DEF rWY                  EQU $ff4a ; Window Y Position (R/W)
-rWX         EQU $ff4b ; Window X Position minus 7 (R/W)
+DEF rWX                  EQU $ff4b ; Window X Position minus 7 (R/W)
-rLCDMODE    EQU $ff4c
+DEF rLCDMODE             EQU $ff4c
-rKEY1       EQU $ff4d ; CGB Mode Only - Prepare Speed Switch
+DEF rKEY1                EQU $ff4d ; CGB Mode Only - Prepare Speed Switch
-rVBK        EQU $ff4f ; CGB Mode Only - VRAM Bank
+DEF rVBK                 EQU $ff4f ; CGB Mode Only - VRAM Bank
-rBLCK       EQU $ff50
+DEF rBLCK                EQU $ff50
-rHDMA1      EQU $ff51 ; CGB Mode Only - New DMA Source, High
+DEF rHDMA1               EQU $ff51 ; CGB Mode Only - New DMA Source, High
-rHDMA2      EQU $ff52 ; CGB Mode Only - New DMA Source, Low
+DEF rHDMA2               EQU $ff52 ; CGB Mode Only - New DMA Source, Low
-rHDMA3      EQU $ff53 ; CGB Mode Only - New DMA Destination, High
+DEF rHDMA3               EQU $ff53 ; CGB Mode Only - New DMA Destination, High
-rHDMA4      EQU $ff54 ; CGB Mode Only - New DMA Destination, Low
+DEF rHDMA4               EQU $ff54 ; CGB Mode Only - New DMA Destination, Low
-rHDMA5      EQU $ff55 ; CGB Mode Only - New DMA Length/Mode/Start
+DEF rHDMA5               EQU $ff55 ; CGB Mode Only - New DMA Length/Mode/Start
-rRP         EQU $ff56 ; CGB Mode Only - Infrared Communications Port
+DEF rRP                  EQU $ff56 ; CGB Mode Only - Infrared Communications Port
-rRP_LED_ON EQU 0
+DEF rRP_LED_ON           EQU 0
-rRP_RECEIVING EQU 1
+DEF rRP_RECEIVING        EQU 1
-rRP_ENABLE_READ_MASK EQU %11000000
+DEF rRP_ENABLE_READ_MASK EQU %11000000
-rBGPI       EQU $ff68 ; CGB Mode Only - Background Palette Index
+DEF rBGPI                EQU $ff68 ; CGB Mode Only - Background Palette Index
-rBGPI_AUTO_INCREMENT EQU 7 ; increment rBGPI after write to rBGPD
+DEF rBGPI_AUTO_INCREMENT EQU 7     ; increment rBGPI after write to rBGPD
-rBGPD       EQU $ff69 ; CGB Mode Only - Background Palette Data
+DEF rBGPD                EQU $ff69 ; CGB Mode Only - Background Palette Data
-rOBPI       EQU $ff6a ; CGB Mode Only - Sprite Palette Index
+DEF rOBPI                EQU $ff6a ; CGB Mode Only - Sprite Palette Index
-rOBPI_AUTO_INCREMENT EQU 7 ; increment rOBPI after write to rOBPD
+DEF rOBPI_AUTO_INCREMENT EQU 7     ; increment rOBPI after write to rOBPD
-rOBPD       EQU $ff6b ; CGB Mode Only - Sprite Palette Data
+DEF rOBPD                EQU $ff6b ; CGB Mode Only - Sprite Palette Data
-rUNKNOWN1   EQU $ff6c ; (FEh) Bit 0 (Read/Write) - CGB Mode Only
+DEF rUNKNOWN1            EQU $ff6c ; (FEh) Bit 0 (Read/Write) - CGB Mode Only
-rSVBK       EQU $ff70 ; CGB Mode Only - WRAM Bank
+DEF rSVBK                EQU $ff70 ; CGB Mode Only - WRAM Bank
-rUNKNOWN2   EQU $ff72 ; (00h) - Bit 0-7 (Read/Write)
+DEF rUNKNOWN2            EQU $ff72 ; (00h) - Bit 0-7 (Read/Write)
-rUNKNOWN3   EQU $ff73 ; (00h) - Bit 0-7 (Read/Write)
+DEF rUNKNOWN3            EQU $ff73 ; (00h) - Bit 0-7 (Read/Write)
-rUNKNOWN4   EQU $ff74 ; (00h) - Bit 0-7 (Read/Write) - CGB Mode Only
+DEF rUNKNOWN4            EQU $ff74 ; (00h) - Bit 0-7 (Read/Write) - CGB Mode Only
-rUNKNOWN5   EQU $ff75 ; (8Fh) - Bit 4-6 (Read/Write)
+DEF rUNKNOWN5            EQU $ff75 ; (8Fh) - Bit 4-6 (Read/Write)
-rUNKNOWN6   EQU $ff76 ; (00h) - Always 00h (Read Only)
+DEF rUNKNOWN6            EQU $ff76 ; (00h) - Always 00h (Read Only)
-rUNKNOWN7   EQU $ff77 ; (00h) - Always 00h (Read Only)
+DEF rUNKNOWN7            EQU $ff77 ; (00h) - Always 00h (Read Only)
-rIE         EQU $ffff ; Interrupt Enable (R/W)
+DEF rIE                  EQU $ffff ; Interrupt Enable (R/W)

constants/icon_constants.asm

@@ -39,7 +39,7 @@
 	const ICON_SLOWPOKE
 	const ICON_SUDOWOODO
 	const ICON_BIGMON
-NUM_ICONS EQU const_value - 1
+DEF NUM_ICONS EQU const_value - 1
 
 ; LoadMenuMonIcon.Jumptable indexes (see engine/gfx/mon_icons.asm)
 	const_def

constants/input_constants.asm

@@ -9,18 +9,18 @@
 	const D_UP_F     ; 6
 	const D_DOWN_F   ; 7
 
-NO_INPUT   EQU %00000000
+DEF NO_INPUT   EQU %00000000
-A_BUTTON   EQU 1 << A_BUTTON_F
+DEF A_BUTTON   EQU 1 << A_BUTTON_F
-B_BUTTON   EQU 1 << B_BUTTON_F
+DEF B_BUTTON   EQU 1 << B_BUTTON_F
-SELECT     EQU 1 << SELECT_F
+DEF SELECT     EQU 1 << SELECT_F
-START      EQU 1 << START_F
+DEF START      EQU 1 << START_F
-D_RIGHT    EQU 1 << D_RIGHT_F
+DEF D_RIGHT    EQU 1 << D_RIGHT_F
-D_LEFT     EQU 1 << D_LEFT_F
+DEF D_LEFT     EQU 1 << D_LEFT_F
-D_UP       EQU 1 << D_UP_F
+DEF D_UP       EQU 1 << D_UP_F
-D_DOWN     EQU 1 << D_DOWN_F
+DEF D_DOWN     EQU 1 << D_DOWN_F
 
-BUTTONS    EQU A_BUTTON | B_BUTTON | SELECT | START
+DEF BUTTONS    EQU A_BUTTON | B_BUTTON | SELECT | START
-D_PAD      EQU D_RIGHT | D_LEFT | D_UP | D_DOWN
+DEF D_PAD      EQU D_RIGHT | D_LEFT | D_UP | D_DOWN
 
-R_DPAD     EQU %00100000
+DEF R_DPAD     EQU %00100000
-R_BUTTONS  EQU %00010000
+DEF R_BUTTONS  EQU %00010000

constants/item_constants.asm

@@ -196,16 +196,16 @@
 	const MUSIC_MAIL   ; bc
 	const MIRAGE_MAIL  ; bd
 	const ITEM_BE      ; be
-NUM_ITEMS EQU const_value - 1
+DEF NUM_ITEMS EQU const_value - 1
 
-__tmhm_value__ = 1
+DEF __tmhm_value__ = 1
 
-add_tmnum: MACRO
+MACRO add_tmnum
-\1_TMNUM EQU __tmhm_value__
+	DEF \1_TMNUM EQU __tmhm_value__
-__tmhm_value__ += 1
+	DEF __tmhm_value__ += 1
 ENDM
 
-add_tm: MACRO
+MACRO add_tm
 ; Defines three constants:
 ; - TM_\1: the item id, starting at $bf
 ; - \1_TMNUM: the learnable TM/HM flag, starting at 1
@@ -216,7 +216,7 @@ TM{02d:__tmhm_value__}_MOVE = \1
 ENDM
 
 ; see data/moves/tmhm_moves.asm for moves
-TM01 EQU const_value
+DEF TM01 EQU const_value
 	add_tm DYNAMICPUNCH ; bf
 	add_tm HEADBUTT     ; c0
 	add_tm CURSE        ; c1
@@ -269,20 +269,20 @@ TM01 EQU const_value
 	add_tm FIRE_PUNCH   ; f0
 	add_tm FURY_CUTTER  ; f1
 	add_tm NIGHTMARE    ; f2
-NUM_TMS EQU __tmhm_value__ - 1
+DEF NUM_TMS EQU __tmhm_value__ - 1
 
-add_hm: MACRO
+MACRO add_hm
 ; Defines three constants:
 ; - HM_\1: the item id, starting at $f3
 ; - \1_TMNUM: the learnable TM/HM flag, starting at 51
 ; - HM##_MOVE: alias for the move id, equal to the value of \1
 	const HM_\1
-HM_VALUE = __tmhm_value__ - NUM_TMS
+	DEF HM_VALUE = __tmhm_value__ - NUM_TMS
-HM{02d:HM_VALUE}_MOVE = \1
+	DEF HM{02d:HM_VALUE}_MOVE = \1
 	add_tmnum \1
 ENDM
 
-HM01 EQU const_value
+DEF HM01 EQU const_value
 	add_hm CUT          ; f3
 	add_hm FLY          ; f4
 	add_hm SURF         ; f5
@@ -290,31 +290,31 @@ HM01 EQU const_value
 	add_hm FLASH        ; f7
 	add_hm WHIRLPOOL    ; f8
 	add_hm WATERFALL    ; f9
-NUM_HMS EQU __tmhm_value__ - NUM_TMS - 1
+DEF NUM_HMS EQU __tmhm_value__ - NUM_TMS - 1
 
-add_mt: MACRO
+MACRO add_mt
 ; Defines two constants:
 ; - \1_TMNUM: the learnable TM/HM flag, starting at 58
 ; - MT##_MOVE: alias for the move id, equal to the value of \1
-MT_VALUE = __tmhm_value__ - NUM_TMS - NUM_HMS
+	DEF MT_VALUE = __tmhm_value__ - NUM_TMS - NUM_HMS
-MT{02d:MT_VALUE}_MOVE = \1
+	DEF MT{02d:MT_VALUE}_MOVE = \1
 	add_tmnum \1
 ENDM
 
-MT01 EQU const_value
+DEF MT01 EQU const_value
 	add_mt FLAMETHROWER
 	add_mt THUNDERBOLT
 	add_mt ICE_BEAM
-NUM_TUTORS = __tmhm_value__ - NUM_TMS - NUM_HMS - 1
+DEF NUM_TUTORS = __tmhm_value__ - NUM_TMS - NUM_HMS - 1
 
-NUM_TM_HM_TUTOR EQU NUM_TMS + NUM_HMS + NUM_TUTORS
+DEF NUM_TM_HM_TUTOR EQU NUM_TMS + NUM_HMS + NUM_TUTORS
 
 	const ITEM_FA       ; fa
 
-USE_SCRIPT_VAR EQU $00
+DEF USE_SCRIPT_VAR EQU $00
-ITEM_FROM_MEM  EQU $ff
+DEF ITEM_FROM_MEM  EQU $ff
 
 ; leftovers from red
-SAFARI_BALL    EQU $08 ; MOON_STONE
+DEF SAFARI_BALL    EQU $08 ; MOON_STONE
-MOON_STONE_RED EQU $0a ; BURN_HEAL
+DEF MOON_STONE_RED EQU $0a ; BURN_HEAL
-FULL_HEAL_RED  EQU $34 ; X_SPEED
+DEF FULL_HEAL_RED  EQU $34 ; X_SPEED

constants/item_data_constants.asm

@@ -1,15 +1,15 @@
 ; item_attributes struct members (see data/items/attributes.asm)
 rsreset
-ITEMATTR_PRICE       rw
+DEF ITEMATTR_PRICE       rw
 rsset ITEMATTR_PRICE
-ITEMATTR_PRICE_LO    rb
+DEF ITEMATTR_PRICE_LO    rb
-ITEMATTR_PRICE_HI    rb
+DEF ITEMATTR_PRICE_HI    rb
-ITEMATTR_EFFECT      rb
+DEF ITEMATTR_EFFECT      rb
-ITEMATTR_PARAM       rb
+DEF ITEMATTR_PARAM       rb
-ITEMATTR_PERMISSIONS rb
+DEF ITEMATTR_PERMISSIONS rb
-ITEMATTR_POCKET      rb
+DEF ITEMATTR_POCKET      rb
-ITEMATTR_HELP        rb
+DEF ITEMATTR_HELP        rb
-ITEMATTR_STRUCT_LENGTH EQU _RS
+DEF ITEMATTR_STRUCT_LENGTH EQU _RS
 
 ; item types
 	const_def 1
@@ -17,7 +17,7 @@ ITEMATTR_STRUCT_LENGTH EQU _RS
 	const KEY_ITEM ; 2
 	const BALL     ; 3
 	const TM_HM    ; 4
-NUM_ITEM_TYPES EQU const_value - 1
+DEF NUM_ITEM_TYPES EQU const_value - 1
 
 ; item menu types
 ; UseItem.dw indexes (see engine/items/pack.asm)
@@ -30,12 +30,12 @@ NUM_ITEM_TYPES EQU const_value - 1
 	const ITEMMENU_CLOSE   ; 6
 
 ; item actions
-CANT_SELECT_F EQU 6
+DEF CANT_SELECT_F EQU 6
-CANT_TOSS_F   EQU 7
+DEF CANT_TOSS_F   EQU 7
 
-NO_LIMITS   EQU 0
+DEF NO_LIMITS   EQU 0
-CANT_SELECT EQU 1 << CANT_SELECT_F
+DEF CANT_SELECT EQU 1 << CANT_SELECT_F
-CANT_TOSS   EQU 1 << CANT_TOSS_F
+DEF CANT_TOSS   EQU 1 << CANT_TOSS_F
 
 ; pack pockets
 	const_def
@@ -43,20 +43,20 @@ CANT_TOSS   EQU 1 << CANT_TOSS_F
 	const BALL_POCKET     ; 1
 	const KEY_ITEM_POCKET ; 2
 	const TM_HM_POCKET    ; 3
-NUM_POCKETS EQU const_value
+DEF NUM_POCKETS EQU const_value
 
-MAX_ITEMS     EQU 20
+DEF MAX_ITEMS     EQU 20
-MAX_BALLS     EQU 12
+DEF MAX_BALLS     EQU 12
-MAX_KEY_ITEMS EQU 25
+DEF MAX_KEY_ITEMS EQU 25
-MAX_PC_ITEMS  EQU 50
+DEF MAX_PC_ITEMS  EQU 50
 
-MAX_ITEM_STACK EQU 99
+DEF MAX_ITEM_STACK EQU 99
 
 ; mail
-MAIL_LINE_LENGTH   EQU $10
+DEF MAIL_LINE_LENGTH   EQU $10
-MAIL_MSG_LENGTH    EQU $20
+DEF MAIL_MSG_LENGTH    EQU $20
-MAILBOX_CAPACITY   EQU 10
+DEF MAILBOX_CAPACITY   EQU 10
-MAIL_STRUCT_LENGTH EQU $2f ; mailmsg struct
+DEF MAIL_STRUCT_LENGTH EQU $2f ; mailmsg struct
 
 ; held item effects
 	const_def

constants/landmark_constants.asm

@@ -48,7 +48,7 @@
 	const LANDMARK_DARK_CAVE         ; 2c
 	const LANDMARK_ROUTE_46          ; 2d
 	const LANDMARK_SILVER_CAVE       ; 2e
-KANTO_LANDMARK EQU const_value
+DEF KANTO_LANDMARK EQU const_value
 	const LANDMARK_PALLET_TOWN       ; 2f
 	const LANDMARK_ROUTE_1           ; 30
 	const LANDMARK_VIRIDIAN_CITY     ; 31
@@ -98,7 +98,7 @@ KANTO_LANDMARK EQU const_value
 	const LANDMARK_TOHJO_FALLS       ; 5d
 	const LANDMARK_ROUTE_28          ; 5e
 	const LANDMARK_FAST_SHIP         ; 5f
-NUM_LANDMARKS EQU const_value
+DEF NUM_LANDMARKS EQU const_value
 
 ; used in CaughtData
 	const_def $7f, -1
@@ -109,4 +109,4 @@ NUM_LANDMARKS EQU const_value
 	const_def
 	const JOHTO_REGION ; 0
 	const KANTO_REGION ; 1
-NUM_REGIONS EQU const_value
+DEF NUM_REGIONS EQU const_value

constants/map_constants.asm

@@ -1,25 +1,25 @@
-newgroup: MACRO
+MACRO newgroup
 ;\1: group id
 	const_skip
-MAPGROUP_\1 EQU const_value
+	DEF MAPGROUP_\1 EQU const_value
-CURRENT_NUM_MAPGROUP_MAPS EQUS "NUM_\1_MAPS"
+	DEF CURRENT_NUM_MAPGROUP_MAPS EQUS "NUM_\1_MAPS"
-__map_value__ = 1
+	DEF __map_value__ = 1
 ENDM
 
-map_const: MACRO
+MACRO map_const
 ;\1: map id
 ;\2: width: in blocks
 ;\3: height: in blocks
-GROUP_\1 EQU const_value
+	DEF GROUP_\1 EQU const_value
-MAP_\1 EQU __map_value__
+	DEF MAP_\1 EQU __map_value__
-__map_value__ += 1
+	DEF __map_value__ += 1
-\1_WIDTH EQU \2
+	DEF \1_WIDTH EQU \2
-\1_HEIGHT EQU \3
+	DEF \1_HEIGHT EQU \3
 ENDM
 
-endgroup: MACRO
+MACRO endgroup
-{CURRENT_NUM_MAPGROUP_MAPS} EQU __map_value__ - 1
+	DEF {CURRENT_NUM_MAPGROUP_MAPS} EQU __map_value__ - 1
-PURGE CURRENT_NUM_MAPGROUP_MAPS
+	PURGE CURRENT_NUM_MAPGROUP_MAPS
 ENDM
 
 ; map group ids
@@ -501,4 +501,4 @@ ENDM
 	map_const ROUTE_31_VIOLET_GATE,                         5,  4 ; 11
 	endgroup
 
-NUM_MAP_GROUPS EQU const_value ; 26
+DEF NUM_MAP_GROUPS EQU const_value ; 26

constants/map_data_constants.asm

@@ -1,21 +1,21 @@
-MAPGROUP_N_A  EQU -1
+DEF MAPGROUP_N_A  EQU -1
-GROUP_N_A     EQU -1
+DEF GROUP_N_A     EQU -1
-MAP_N_A       EQU -1
+DEF MAP_N_A       EQU -1
-MAPGROUP_NONE EQU 0
+DEF MAPGROUP_NONE EQU 0
-GROUP_NONE    EQU 0
+DEF GROUP_NONE    EQU 0
-MAP_NONE      EQU 0
+DEF MAP_NONE      EQU 0
 
 ; map struct members (see data/maps/maps.asm)
 rsreset
-MAP_MAPATTRIBUTES_BANK rb ; 0
+DEF MAP_MAPATTRIBUTES_BANK rb ; 0
-MAP_TILESET            rb ; 1
+DEF MAP_TILESET            rb ; 1
-MAP_ENVIRONMENT        rb ; 2
+DEF MAP_ENVIRONMENT        rb ; 2
-MAP_MAPATTRIBUTES      rw ; 3
+DEF MAP_MAPATTRIBUTES      rw ; 3
-MAP_LOCATION           rb ; 5
+DEF MAP_LOCATION           rb ; 5
-MAP_MUSIC              rb ; 6
+DEF MAP_MUSIC              rb ; 6
-MAP_PALETTE            rb ; 7
+DEF MAP_PALETTE            rb ; 7
-MAP_FISHGROUP          rb ; 8
+DEF MAP_FISHGROUP          rb ; 8
-MAP_LENGTH EQU _RS
+DEF MAP_LENGTH EQU _RS
 
 ; map environments (wEnvironment)
 ; EnvironmentColorsPointers indexes (see data/maps/environment_colors.asm)
@@ -27,7 +27,7 @@ MAP_LENGTH EQU _RS
 	const ENVIRONMENT_5
 	const GATE
 	const DUNGEON
-NUM_ENVIRONMENTS EQU const_value - 1
+DEF NUM_ENVIRONMENTS EQU const_value - 1
 
 ; map palettes (wEnvironment)
 	const_def
@@ -36,7 +36,7 @@ NUM_ENVIRONMENTS EQU const_value - 1
 	const PALETTE_NITE
 	const PALETTE_MORN
 	const PALETTE_DARK
-NUM_MAP_PALETTES EQU const_value
+DEF NUM_MAP_PALETTES EQU const_value
 
 ; FishGroups indexes (see data/wild/fish.asm)
 	const_def
@@ -54,7 +54,7 @@ NUM_MAP_PALETTES EQU const_value
 	const FISHGROUP_QWILFISH
 	const FISHGROUP_REMORAID
 	const FISHGROUP_QWILFISH_NO_SWARM
-NUM_FISHGROUPS EQU const_value - 1
+DEF NUM_FISHGROUPS EQU const_value - 1
 
 ; connection directions (see data/maps/data.asm)
 	const_def
@@ -102,14 +102,14 @@ NUM_FISHGROUPS EQU const_value - 1
 	const SPAWN_BLACKTHORN
 	const SPAWN_MT_SILVER
 	const SPAWN_FAST_SHIP
-NUM_SPAWNS EQU const_value
+DEF NUM_SPAWNS EQU const_value
 
-SPAWN_N_A EQU -1
+DEF SPAWN_N_A EQU -1
 
 ; Flypoints indexes (see data/maps/flypoints.asm)
 	const_def
 ; johto
-JOHTO_FLYPOINT EQU const_value
+DEF JOHTO_FLYPOINT EQU const_value
 	const FLY_NEW_BARK
 	const FLY_CHERRYGROVE
 	const FLY_VIOLET
@@ -123,7 +123,7 @@ JOHTO_FLYPOINT EQU const_value
 	const FLY_BLACKTHORN
 	const FLY_MT_SILVER
 ; kanto
-KANTO_FLYPOINT EQU const_value
+DEF KANTO_FLYPOINT EQU const_value
 	const FLY_PALLET
 	const FLY_VIRIDIAN
 	const FLY_PEWTER
@@ -136,6 +136,6 @@ KANTO_FLYPOINT EQU const_value
 	const FLY_FUCHSIA
 	const FLY_CINNABAR
 	const FLY_INDIGO
-NUM_FLYPOINTS EQU const_value
+DEF NUM_FLYPOINTS EQU const_value
 
-MAX_OUTDOOR_SPRITES EQU 23 ; see engine/overworld/overworld.asm
+DEF MAX_OUTDOOR_SPRITES EQU 23 ; see engine/overworld/overworld.asm