RGBDS syntax updates (#905)

New MACRO and DEF syntax
2022-06-06 16:25:42 -05:00
parent a4d346cc8c
commit 3648afda16
179 changed files with 2546 additions and 2545 deletions
--- a/constants/map_object_constants.asm
+++ b/constants/map_object_constants.asm
@@ -1,47 +1,47 @@
 ; object_struct members (see macros/wram.asm)
 rsreset
-OBJECT_SPRITE              rb ; 00
-OBJECT_MAP_OBJECT_INDEX    rb ; 01
-OBJECT_SPRITE_TILE         rb ; 02
-OBJECT_MOVEMENTTYPE        rb ; 03
-OBJECT_FLAGS1              rb ; 04
-OBJECT_FLAGS2              rb ; 05
-OBJECT_PALETTE             rb ; 06
-OBJECT_DIRECTION_WALKING   rb ; 07
-OBJECT_FACING              rb ; 08
-OBJECT_STEP_TYPE           rb ; 09
-OBJECT_STEP_DURATION       rb ; 0a
-OBJECT_ACTION              rb ; 0b
-OBJECT_STEP_FRAME          rb ; 0c
-OBJECT_FACING_STEP         rb ; 0d
-OBJECT_NEXT_TILE           rb ; 0e
-OBJECT_STANDING_TILE       rb ; 0f
-OBJECT_NEXT_MAP_X          rb ; 10
-OBJECT_NEXT_MAP_Y          rb ; 11
-OBJECT_MAP_X               rb ; 12
-OBJECT_MAP_Y               rb ; 13
-OBJECT_INIT_X              rb ; 14
-OBJECT_INIT_Y              rb ; 15
-OBJECT_RADIUS              rb ; 16
-OBJECT_SPRITE_X            rb ; 17
-OBJECT_SPRITE_Y            rb ; 18
-OBJECT_SPRITE_X_OFFSET     rb ; 19
-OBJECT_SPRITE_Y_OFFSET     rb ; 1a
-OBJECT_MOVEMENT_BYTE_INDEX rb ; 1b
-OBJECT_1C                  rb ; 1c
-OBJECT_1D                  rb ; 1d
-OBJECT_1E                  rb ; 1e
-OBJECT_1F                  rb ; 1f
-OBJECT_RANGE               rb ; 20
-                           rb_skip 7
-OBJECT_LENGTH EQU _RS
-NUM_OBJECT_STRUCTS EQU 13 ; see wObjectStructs
+DEF OBJECT_SPRITE              rb ; 00
+DEF OBJECT_MAP_OBJECT_INDEX    rb ; 01
+DEF OBJECT_SPRITE_TILE         rb ; 02
+DEF OBJECT_MOVEMENTTYPE        rb ; 03
+DEF OBJECT_FLAGS1              rb ; 04
+DEF OBJECT_FLAGS2              rb ; 05
+DEF OBJECT_PALETTE             rb ; 06
+DEF OBJECT_DIRECTION_WALKING   rb ; 07
+DEF OBJECT_FACING              rb ; 08
+DEF OBJECT_STEP_TYPE           rb ; 09
+DEF OBJECT_STEP_DURATION       rb ; 0a
+DEF OBJECT_ACTION              rb ; 0b
+DEF OBJECT_STEP_FRAME          rb ; 0c
+DEF OBJECT_FACING_STEP         rb ; 0d
+DEF OBJECT_NEXT_TILE           rb ; 0e
+DEF OBJECT_STANDING_TILE       rb ; 0f
+DEF OBJECT_NEXT_MAP_X          rb ; 10
+DEF OBJECT_NEXT_MAP_Y          rb ; 11
+DEF OBJECT_MAP_X               rb ; 12
+DEF OBJECT_MAP_Y               rb ; 13
+DEF OBJECT_INIT_X              rb ; 14
+DEF OBJECT_INIT_Y              rb ; 15
+DEF OBJECT_RADIUS              rb ; 16
+DEF OBJECT_SPRITE_X            rb ; 17
+DEF OBJECT_SPRITE_Y            rb ; 18
+DEF OBJECT_SPRITE_X_OFFSET     rb ; 19
+DEF OBJECT_SPRITE_Y_OFFSET     rb ; 1a
+DEF OBJECT_MOVEMENT_BYTE_INDEX rb ; 1b
+DEF OBJECT_1C                  rb ; 1c
+DEF OBJECT_1D                  rb ; 1d
+DEF OBJECT_1E                  rb ; 1e
+DEF OBJECT_1F                  rb ; 1f
+DEF OBJECT_RANGE               rb ; 20
+                               rb_skip 7
+DEF OBJECT_LENGTH EQU _RS
+DEF NUM_OBJECT_STRUCTS EQU 13 ; see wObjectStructs

 ; object_struct OBJECT_FACING values
-OW_DOWN  EQU DOWN  << 2
-OW_UP    EQU UP    << 2
-OW_LEFT  EQU LEFT  << 2
-OW_RIGHT EQU RIGHT << 2
+DEF OW_DOWN  EQU DOWN  << 2
+DEF OW_UP    EQU UP    << 2
+DEF OW_LEFT  EQU LEFT  << 2
+DEF OW_RIGHT EQU RIGHT << 2

 ; object_struct OBJECT_FLAGS1 bit flags
 	const_def
@@ -54,14 +54,14 @@ OW_RIGHT EQU RIGHT << 2
 	const NOCLIP_OBJS_F   ; 6
 	const EMOTE_OBJECT_F  ; 7

-INVISIBLE     EQU 1 << INVISIBLE_F
-WONT_DELETE   EQU 1 << WONT_DELETE_F
-FIXED_FACING  EQU 1 << FIXED_FACING_F
-SLIDING       EQU 1 << SLIDING_F
-NOCLIP_TILES  EQU 1 << NOCLIP_TILES_F
-MOVE_ANYWHERE EQU 1 << MOVE_ANYWHERE_F
-NOCLIP_OBJS   EQU 1 << NOCLIP_OBJS_F
-EMOTE_OBJECT  EQU 1 << EMOTE_OBJECT_F
+DEF INVISIBLE     EQU 1 << INVISIBLE_F
+DEF WONT_DELETE   EQU 1 << WONT_DELETE_F
+DEF FIXED_FACING  EQU 1 << FIXED_FACING_F
+DEF SLIDING       EQU 1 << SLIDING_F
+DEF NOCLIP_TILES  EQU 1 << NOCLIP_TILES_F
+DEF MOVE_ANYWHERE EQU 1 << MOVE_ANYWHERE_F
+DEF NOCLIP_OBJS   EQU 1 << NOCLIP_OBJS_F
+DEF EMOTE_OBJECT  EQU 1 << EMOTE_OBJECT_F

 ; object_struct OBJECT_FLAGS2 bit flags
 	const_def
@@ -74,10 +74,10 @@ EMOTE_OBJECT  EQU 1 << EMOTE_OBJECT_F
 	const OBJ_FLAGS2_6    ; 6
 	const OBJ_FLAGS2_7    ; 7

-LOW_PRIORITY  EQU 1 << LOW_PRIORITY_F
-HIGH_PRIORITY EQU 1 << HIGH_PRIORITY_F
-OVERHEAD      EQU 1 << OVERHEAD_F
-USE_OBP1      EQU 1 << USE_OBP1_F
+DEF LOW_PRIORITY  EQU 1 << LOW_PRIORITY_F
+DEF HIGH_PRIORITY EQU 1 << HIGH_PRIORITY_F
+DEF OVERHEAD      EQU 1 << OVERHEAD_F
+DEF USE_OBP1      EQU 1 << USE_OBP1_F

 ; object_struct OBJECT_PALETTE bit flags
 	const_def 5
@@ -85,48 +85,48 @@ USE_OBP1      EQU 1 << USE_OBP1_F
 	const STRENGTH_BOULDER_F ; 6
 	const BIG_OBJECT_F       ; 7

-SWIMMING         EQU 1 << SWIMMING_F
-STRENGTH_BOULDER EQU 1 << STRENGTH_BOULDER_F
-BIG_OBJECT       EQU 1 << BIG_OBJECT_F
+DEF SWIMMING         EQU 1 << SWIMMING_F
+DEF STRENGTH_BOULDER EQU 1 << STRENGTH_BOULDER_F
+DEF BIG_OBJECT       EQU 1 << BIG_OBJECT_F

 ; facing attribute bit flags
-RELATIVE_ATTRIBUTES_F EQU 1
-ABSOLUTE_TILE_ID_F    EQU 2
+DEF RELATIVE_ATTRIBUTES_F EQU 1
+DEF ABSOLUTE_TILE_ID_F    EQU 2

-RELATIVE_ATTRIBUTES EQU 1 << RELATIVE_ATTRIBUTES_F
-ABSOLUTE_TILE_ID    EQU 1 << ABSOLUTE_TILE_ID_F
+DEF RELATIVE_ATTRIBUTES EQU 1 << RELATIVE_ATTRIBUTES_F
+DEF ABSOLUTE_TILE_ID    EQU 1 << ABSOLUTE_TILE_ID_F

 ; map_object struct members (see macros/wram.asm)
 rsreset
-MAPOBJECT_OBJECT_STRUCT_ID rb ; 0
-MAPOBJECT_SPRITE           rb ; 1
-MAPOBJECT_Y_COORD          rb ; 2
-MAPOBJECT_X_COORD          rb ; 3
-MAPOBJECT_MOVEMENT         rb ; 4
-MAPOBJECT_RADIUS           rb ; 5
-MAPOBJECT_HOUR             rb ; 6
-MAPOBJECT_TIMEOFDAY        rb ; 7
-MAPOBJECT_COLOR            rb ; 8
-MAPOBJECT_RANGE            rb ; 9
-MAPOBJECT_SCRIPT_POINTER   rw ; a
-MAPOBJECT_EVENT_FLAG       rw ; c
-                           rb_skip 2
-MAPOBJECT_LENGTH EQU _RS
-NUM_OBJECTS EQU 16
-PLAYER_OBJECT EQU 0
+DEF MAPOBJECT_OBJECT_STRUCT_ID rb ; 0
+DEF MAPOBJECT_SPRITE           rb ; 1
+DEF MAPOBJECT_Y_COORD          rb ; 2
+DEF MAPOBJECT_X_COORD          rb ; 3
+DEF MAPOBJECT_MOVEMENT         rb ; 4
+DEF MAPOBJECT_RADIUS           rb ; 5
+DEF MAPOBJECT_HOUR             rb ; 6
+DEF MAPOBJECT_TIMEOFDAY        rb ; 7
+DEF MAPOBJECT_COLOR            rb ; 8
+DEF MAPOBJECT_RANGE            rb ; 9
+DEF MAPOBJECT_SCRIPT_POINTER   rw ; a
+DEF MAPOBJECT_EVENT_FLAG       rw ; c
+                               rb_skip 2
+DEF MAPOBJECT_LENGTH EQU _RS
+DEF NUM_OBJECTS EQU 16
+DEF PLAYER_OBJECT EQU 0

 ; SpriteMovementData struct members (see data/sprites/map_objects.asm)
 rsreset
-SPRITEMOVEATTR_MOVEMENT rb ; 0
-SPRITEMOVEATTR_FACING   rb ; 1
-SPRITEMOVEATTR_ACTION   rb ; 2
-SPRITEMOVEATTR_FLAGS1   rb ; 3
-SPRITEMOVEATTR_FLAGS2   rb ; 4
-SPRITEMOVEATTR_PALFLAGS rb ; 5
-NUM_SPRITEMOVEDATA_FIELDS EQU _RS
+DEF SPRITEMOVEATTR_MOVEMENT rb ; 0
+DEF SPRITEMOVEATTR_FACING   rb ; 1
+DEF SPRITEMOVEATTR_ACTION   rb ; 2
+DEF SPRITEMOVEATTR_FLAGS1   rb ; 3
+DEF SPRITEMOVEATTR_FLAGS2   rb ; 4
+DEF SPRITEMOVEATTR_PALFLAGS rb ; 5
+DEF NUM_SPRITEMOVEDATA_FIELDS EQU _RS

-MAPOBJECT_SCREEN_WIDTH  EQU (SCREEN_WIDTH / 2) + 2
-MAPOBJECT_SCREEN_HEIGHT EQU (SCREEN_HEIGHT / 2) + 2
+DEF MAPOBJECT_SCREEN_WIDTH  EQU (SCREEN_WIDTH / 2) + 2
+DEF MAPOBJECT_SCREEN_HEIGHT EQU (SCREEN_HEIGHT / 2) + 2

 ; SpriteMovementData indexes (see data/sprites/map_objects.asm)
 	const_def
@@ -167,7 +167,7 @@ MAPOBJECT_SCREEN_HEIGHT EQU (SCREEN_HEIGHT / 2) + 2
 	const SPRITEMOVEDATA_BOULDERDUST          ; 22
 	const SPRITEMOVEDATA_GRASS                ; 23
 	const SPRITEMOVEDATA_SWIM_WANDER          ; 24
-NUM_SPRITEMOVEDATA EQU const_value
+DEF NUM_SPRITEMOVEDATA EQU const_value

 ; StepFunction_FromMovement.Pointers indexes (see engine/overworld/map_objects.asm)
 	const_def
@@ -199,7 +199,7 @@ NUM_SPRITEMOVEDATA EQU const_value
 	const SPRITEMOVEFN_SPIN_COUNTERCLOCKWISE ; 19
 	const SPRITEMOVEFN_BOULDERDUST           ; 1a
 	const SPRITEMOVEFN_GRASS                 ; 1b
-NUM_SPRITEMOVEFN EQU const_value
+DEF NUM_SPRITEMOVEFN EQU const_value

 ; StepTypesJumptable indexes (see engine/overworld/map_objects.asm)
 	const_def
@@ -229,7 +229,7 @@ NUM_SPRITEMOVEFN EQU const_value
 	const STEP_TYPE_17               ; 17
 	const STEP_TYPE_DELETE           ; 18
 	const STEP_TYPE_SKYFALL_TOP      ; 19
-NUM_STEP_TYPES EQU const_value
+DEF NUM_STEP_TYPES EQU const_value

 ; ObjectActionPairPointers indexes (see engine/overworld/map_object_action.asm)
 	const_def
@@ -250,7 +250,7 @@ NUM_STEP_TYPES EQU const_value
 	const OBJECT_ACTION_BOULDER_DUST  ; 0e
 	const OBJECT_ACTION_GRASS_SHAKE   ; 0f
 	const OBJECT_ACTION_SKYFALL       ; 10
-NUM_OBJECT_ACTIONS EQU const_value
+DEF NUM_OBJECT_ACTIONS EQU const_value

 ; Facings indexes (see data/sprites/facings.asm)
 	const_def
@@ -286,7 +286,7 @@ NUM_OBJECT_ACTIONS EQU const_value
 	const FACING_BOULDER_DUST_2 ; 1d
 	const FACING_GRASS_1        ; 1e
 	const FACING_GRASS_2        ; 1f
-NUM_FACINGS EQU const_value
+DEF NUM_FACINGS EQU const_value

 ; DoPlayerMovement.DoStep arguments (see engine/overworld/player_movement.asm)
 	const_def
@@ -298,4 +298,4 @@ NUM_FACINGS EQU const_value
 	const STEP_TURN          ; 5
 	const STEP_BACK_LEDGE    ; 6
 	const STEP_WALK_IN_PLACE ; 7
-NUM_STEPS EQU const_value
+DEF NUM_STEPS EQU const_value