Document constants with comments, actual names, and more thorough usage
This commit is contained in:
Remy Oukaour
@@ -1,5 +1,5 @@
|
||||
|
||||
; sprites
|
||||
; sprite ids
|
||||
; SpriteHeaders indexes (see gfx/overworld/sprite_headers.asm)
|
||||
const_def
|
||||
const SPRITE_NONE ; 00
|
||||
const SPRITE_CHRIS ; 01
|
||||
@@ -105,8 +105,8 @@
|
||||
const SPRITE_RAIKOU ; 65
|
||||
const SPRITE_STANDING_YOUNGSTER ; 66
|
||||
|
||||
; SpriteMons indexes (see engine/overworld.asm)
|
||||
const_value SET $80
|
||||
|
||||
SPRITE_POKEMON EQU const_value
|
||||
const SPRITE_UNOWN ; 80
|
||||
const SPRITE_GEODUDE ; 81
|
||||
@@ -144,10 +144,12 @@ SPRITE_POKEMON EQU const_value
|
||||
const SPRITE_LUGIA ; a1
|
||||
const SPRITE_HO_OH ; a2
|
||||
|
||||
; special GetMonSprite values (see engine/overworld.asm)
|
||||
const_value SET $e0
|
||||
const SPRITE_DAYCARE_MON_1 ; e0
|
||||
const SPRITE_DAYCARE_MON_2 ; e1
|
||||
|
||||
; VariableSprites indexes (see wram.asm)
|
||||
const_value SET $f0
|
||||
SPRITE_VARS EQU const_value
|
||||
const SPRITE_CONSOLE ; f0
|
||||
@@ -164,13 +166,7 @@ SPRITE_VARS EQU const_value
|
||||
const SPRITE_COPYCAT ; fb
|
||||
const SPRITE_JANINE_IMPERSONATOR ; fc
|
||||
|
||||
; sprite types
|
||||
const_value SET 1
|
||||
const WALKING_SPRITE
|
||||
const STANDING_SPRITE
|
||||
const STILL_SPRITE
|
||||
|
||||
; sprite header fields
|
||||
; sprite_header struct members (see gfx/overworld/sprite_headers.asm)
|
||||
const_def
|
||||
const SPRITEHEADER_ADDR_LO
|
||||
const SPRITEHEADER_ADDR_HI
|
||||
@@ -180,18 +176,24 @@ const_value SET 1
|
||||
const SPRITEHEADER_PALETTE
|
||||
NUM_SPRITEHEADER_FIELDS EQU const_value
|
||||
|
||||
; sprite types
|
||||
const_value SET 1
|
||||
const WALKING_SPRITE
|
||||
const STANDING_SPRITE
|
||||
const STILL_SPRITE
|
||||
|
||||
; sprite palettes
|
||||
const_def
|
||||
const PAL_OW_RED
|
||||
const PAL_OW_BLUE
|
||||
const PAL_OW_GREEN
|
||||
const PAL_OW_BROWN
|
||||
const PAL_OW_PINK
|
||||
const PAL_OW_SILVER
|
||||
const PAL_OW_TREE
|
||||
const PAL_OW_ROCK
|
||||
const PAL_OW_RED ; 0
|
||||
const PAL_OW_BLUE ; 1
|
||||
const PAL_OW_GREEN ; 2
|
||||
const PAL_OW_BROWN ; 3
|
||||
const PAL_OW_PINK ; 4
|
||||
const PAL_OW_SILVER ; 5
|
||||
const PAL_OW_TREE ; 6
|
||||
const PAL_OW_ROCK ; 7
|
||||
|
||||
; sprite movement data table indices
|
||||
; SpriteMovementData indexes (see data/map_objects.asm)
|
||||
const_def
|
||||
const SPRITEMOVEDATA_00 ; 00
|
||||
const SPRITEMOVEDATA_ITEM_TREE ; 01
|
||||
@@ -233,7 +235,7 @@ NUM_SPRITEHEADER_FIELDS EQU const_value
|
||||
NUM_SPRITEMOVEDATA EQU const_value
|
||||
SPRITEMOVEDATA_FIELDS EQU 6
|
||||
|
||||
; sprite movement functions
|
||||
; MapObjectMovementPattern.Pointers indexes (see engine/map_objects.asm)
|
||||
const_def
|
||||
const SPRITEMOVEFN_00
|
||||
const SPRITEMOVEFN_RANDOM_WALK_Y
|
||||
@@ -264,8 +266,7 @@ SPRITEMOVEDATA_FIELDS EQU 6
|
||||
const SPRITEMOVEFN_BOULDERDUST
|
||||
const SPRITEMOVEFN_GRASS
|
||||
|
||||
MAX_OUTDOOR_SPRITES EQU 23
|
||||
|
||||
; StepTypesJumptable indexes (see engine/map_objects.asm)
|
||||
const_def
|
||||
const STEP_TYPE_00
|
||||
const STEP_TYPE_SLEEP
|
||||
@@ -294,6 +295,7 @@ MAX_OUTDOOR_SPRITES EQU 23
|
||||
const STEP_TYPE_18
|
||||
const STEP_TYPE_SKYFALL_TOP
|
||||
|
||||
; PersonActionPairPointers indexes (see engine/map_object_action.asm)
|
||||
const_def
|
||||
const PERSON_ACTION_00
|
||||
const PERSON_ACTION_STAND
|
||||
@@ -313,6 +315,7 @@ MAX_OUTDOOR_SPRITES EQU 23
|
||||
const PERSON_ACTION_GRASS_SHAKE
|
||||
const PERSON_ACTION_SKYFALL
|
||||
|
||||
; Facings indexes (see engine/facings.asm)
|
||||
const_def
|
||||
const FACING_STEP_DOWN_0
|
||||
const FACING_STEP_DOWN_1
|
||||
@@ -347,6 +350,7 @@ MAX_OUTDOOR_SPRITES EQU 23
|
||||
const FACING_GRASS_1
|
||||
const FACING_GRASS_2
|
||||
|
||||
; sprite_anim_struct members (see macros/wram.asm)
|
||||
const_def
|
||||
const SPRITEANIMSTRUCT_INDEX ; 0
|
||||
const SPRITEANIMSTRUCT_FRAMESET_ID ; 1
|
||||
@@ -365,6 +369,7 @@ MAX_OUTDOOR_SPRITES EQU 23
|
||||
const SPRITEANIMSTRUCT_0E ; e
|
||||
const SPRITEANIMSTRUCT_0F ; f
|
||||
|
||||
; SpriteAnimFrameData indexes (see data/sprite_engine.asm)
|
||||
const_def
|
||||
const SPRITE_ANIM_FRAMESET_00
|
||||
const SPRITE_ANIM_FRAMESET_PARTY_MON
|
||||
@@ -377,13 +382,13 @@ MAX_OUTDOOR_SPRITES EQU 23
|
||||
const SPRITE_ANIM_FRAMESET_TEXT_ENTRY_CURSOR
|
||||
const SPRITE_ANIM_FRAMESET_09 ; unused?
|
||||
const SPRITE_ANIM_FRAMESET_GAMEFREAK_LOGO
|
||||
const SPRITE_ANIM_FRAMESET_0B
|
||||
const SPRITE_ANIM_FRAMESET_0C
|
||||
const SPRITE_ANIM_FRAMESET_GS_INTRO_STAR
|
||||
const SPRITE_ANIM_FRAMESET_GS_INTRO_SPARKLE
|
||||
const SPRITE_ANIM_FRAMESET_SLOTS_GOLEM
|
||||
const SPRITE_ANIM_FRAMESET_SLOTS_CHANSEY
|
||||
const SPRITE_ANIM_FRAMESET_SLOTS_CHANSEY_2
|
||||
const SPRITE_ANIM_FRAMESET_SLOTS_EGG
|
||||
const SPRITE_ANIM_FRAMESET_WALK_CYCLE
|
||||
const SPRITE_ANIM_FRAMESET_RED_WALK
|
||||
const SPRITE_ANIM_FRAMESET_STILL_CURSOR
|
||||
const SPRITE_ANIM_FRAMESET_TRADE_POKE_BALL
|
||||
const SPRITE_ANIM_FRAMESET_TRADE_POKE_BALL_0
|
||||
@@ -433,29 +438,30 @@ MAX_OUTDOOR_SPRITES EQU 23
|
||||
const SPRITE_ANIM_FRAMESET_CELEBI_LEFT
|
||||
const SPRITE_ANIM_FRAMESET_CELEBI_RIGHT
|
||||
|
||||
; DoAnimFrame.Jumptable indexes (see engine/sprite_anims.asm)
|
||||
const_def
|
||||
const SPRITE_ANIM_SEQ_NULL
|
||||
const SPRITE_ANIM_SEQ_01
|
||||
const SPRITE_ANIM_SEQ_02
|
||||
const SPRITE_ANIM_SEQ_03
|
||||
const SPRITE_ANIM_SEQ_PARTY_MON
|
||||
const SPRITE_ANIM_SEQ_PARTY_MON_SWITCH
|
||||
const SPRITE_ANIM_SEQ_PARTY_MON_SELECTED
|
||||
const SPRITE_ANIM_SEQ_04
|
||||
const SPRITE_ANIM_SEQ_05
|
||||
const SPRITE_ANIM_SEQ_NAMING_SCREEN_CURSOR
|
||||
const SPRITE_ANIM_SEQ_GAMEFREAK_LOGO
|
||||
const SPRITE_ANIM_SEQ_07
|
||||
const SPRITE_ANIM_SEQ_08
|
||||
const SPRITE_ANIM_SEQ_SLOT_GOLEM
|
||||
const SPRITE_ANIM_SEQ_GS_INTRO_STAR
|
||||
const SPRITE_ANIM_SEQ_GS_INTRO_SPARKLE
|
||||
const SPRITE_ANIM_SEQ_SLOTS_GOLEM
|
||||
const SPRITE_ANIM_SEQ_SLOTS_CHANSEY
|
||||
const SPRITE_ANIM_SEQ_SLOTS_EGG
|
||||
const SPRITE_ANIM_SEQ_0C
|
||||
const SPRITE_ANIM_SEQ_MAIL_CURSOR
|
||||
const SPRITE_ANIM_SEQ_0D
|
||||
const SPRITE_ANIM_SEQ_0E
|
||||
const SPRITE_ANIM_SEQ_0F
|
||||
const SPRITE_ANIM_SEQ_10
|
||||
const SPRITE_ANIM_SEQ_11
|
||||
const SPRITE_ANIM_SEQ_TRADE_POKE_BALL
|
||||
const SPRITE_ANIM_SEQ_TRADE_TUBE_BULGE
|
||||
const SPRITE_ANIM_SEQ_TRADEMON_IN_TUBE
|
||||
const SPRITE_ANIM_SEQ_13
|
||||
const SPRITE_ANIM_SEQ_14
|
||||
const SPRITE_ANIM_SEQ_15
|
||||
const SPRITE_ANIM_SEQ_REVEAL_NEW_MON
|
||||
const SPRITE_ANIM_SEQ_RADIO_TUNING_KNOB
|
||||
const SPRITE_ANIM_SEQ_CUT_LEAVES
|
||||
const SPRITE_ANIM_SEQ_FLY_FROM
|
||||
const SPRITE_ANIM_SEQ_FLY_LEAF
|
||||
const SPRITE_ANIM_SEQ_FLY_TO
|
||||
@@ -463,62 +469,63 @@ MAX_OUTDOOR_SPRITES EQU 23
|
||||
const SPRITE_ANIM_SEQ_1A
|
||||
const SPRITE_ANIM_SEQ_1B
|
||||
const SPRITE_ANIM_SEQ_1C
|
||||
const SPRITE_ANIM_SEQ_1D
|
||||
const SPRITE_ANIM_SEQ_1E
|
||||
const SPRITE_ANIM_SEQ_1F
|
||||
const SPRITE_ANIM_SEQ_20
|
||||
const SPRITE_ANIM_SEQ_21
|
||||
const SPRITE_ANIM_SEQ_22
|
||||
const SPRITE_ANIM_SEQ_INTRO_SUICUNE
|
||||
const SPRITE_ANIM_SEQ_INTRO_PICHU_WOOPER
|
||||
const SPRITE_ANIM_SEQ_CELEBI
|
||||
const SPRITE_ANIM_SEQ_INTRO_UNOWN
|
||||
const SPRITE_ANIM_SEQ_INTRO_UNOWN_F
|
||||
const SPRITE_ANIM_SEQ_INTRO_SUICUNE_AWAY
|
||||
|
||||
; SpriteAnimSeqData indexes (see engine/sprites.asm)
|
||||
const_def
|
||||
const SPRITE_ANIM_INDEX_00
|
||||
const SPRITE_ANIM_INDEX_PARTY_MON
|
||||
const SPRITE_ANIM_INDEX_01
|
||||
const SPRITE_ANIM_INDEX_02
|
||||
const SPRITE_ANIM_INDEX_GAMEFREAK_LOGO
|
||||
const SPRITE_ANIM_INDEX_04
|
||||
const SPRITE_ANIM_INDEX_NAMING_SCREEN_CURSOR
|
||||
const SPRITE_ANIM_INDEX_SLOT_GOLEM
|
||||
const SPRITE_ANIM_INDEX_GAMEFREAK_LOGO
|
||||
const SPRITE_ANIM_INDEX_GS_INTRO_STAR
|
||||
const SPRITE_ANIM_INDEX_GS_INTRO_SPARKLE
|
||||
const SPRITE_ANIM_INDEX_SLOTS_GOLEM
|
||||
const SPRITE_ANIM_INDEX_SLOTS_CHANSEY
|
||||
const SPRITE_ANIM_INDEX_SLOTS_EGG
|
||||
const SPRITE_ANIM_INDEX_09
|
||||
const SPRITE_ANIM_INDEX_COMPOSE_MAIL_CURSOR
|
||||
const SPRITE_ANIM_INDEX_RED_WALK
|
||||
const SPRITE_ANIM_INDEX_0B
|
||||
const SPRITE_ANIM_INDEX_COMPOSE_MAIL_CURSOR
|
||||
const SPRITE_ANIM_INDEX_DUMMY_GAME
|
||||
const SPRITE_ANIM_INDEX_0D
|
||||
const SPRITE_ANIM_INDEX_0E
|
||||
const SPRITE_ANIM_INDEX_0F
|
||||
const SPRITE_ANIM_INDEX_10
|
||||
const SPRITE_ANIM_INDEX_TRADE_POKE_BALL
|
||||
const SPRITE_ANIM_INDEX_TRADE_POOF
|
||||
const SPRITE_ANIM_INDEX_TRADE_TUBE_BULGE
|
||||
const SPRITE_ANIM_INDEX_TRADEMON_ICON
|
||||
const SPRITE_ANIM_INDEX_TRADEMON_BUBBLE
|
||||
const SPRITE_ANIM_INDEX_13
|
||||
const SPRITE_ANIM_INDEX_14
|
||||
const SPRITE_ANIM_INDEX_15
|
||||
const SPRITE_ANIM_INDEX_EVOLUTION_BALL_OF_LIGHT
|
||||
const SPRITE_ANIM_INDEX_RADIO_TUNING_KNOB
|
||||
const SPRITE_ANIM_INDEX_MAGNET_TRAIN_RED
|
||||
const SPRITE_ANIM_INDEX_LEAF
|
||||
const SPRITE_ANIM_INDEX_CUT_TREE
|
||||
const SPRITE_ANIM_INDEX_FLY_LEAF
|
||||
const SPRITE_ANIM_INDEX_19
|
||||
const SPRITE_ANIM_INDEX_EGG_CRACK
|
||||
const SPRITE_ANIM_INDEX_1A
|
||||
const SPRITE_ANIM_INDEX_1B
|
||||
const SPRITE_ANIM_INDEX_1C
|
||||
const SPRITE_ANIM_INDEX_HEADBUTT
|
||||
const SPRITE_ANIM_INDEX_EGG_HATCH
|
||||
const SPRITE_ANIM_INDEX_1D
|
||||
const SPRITE_ANIM_INDEX_BLUE_WALK
|
||||
const SPRITE_ANIM_INDEX_1F
|
||||
const SPRITE_ANIM_INDEX_MAGNET_TRAIN_BLUE
|
||||
const SPRITE_ANIM_INDEX_20
|
||||
const SPRITE_ANIM_INDEX_21
|
||||
const SPRITE_ANIM_INDEX_22
|
||||
const SPRITE_ANIM_INDEX_23
|
||||
const SPRITE_ANIM_INDEX_24
|
||||
const SPRITE_ANIM_INDEX_25
|
||||
const SPRITE_ANIM_INDEX_26
|
||||
const SPRITE_ANIM_INDEX_27
|
||||
const SPRITE_ANIM_INDEX_28
|
||||
const SPRITE_ANIM_INDEX_29
|
||||
const SPRITE_ANIM_INDEX_2A
|
||||
const SPRITE_ANIM_INDEX_2B
|
||||
const SPRITE_ANIM_INDEX_2C
|
||||
const SPRITE_ANIM_INDEX_INTRO_SUICUNE
|
||||
const SPRITE_ANIM_INDEX_INTRO_PICHU
|
||||
const SPRITE_ANIM_INDEX_INTRO_WOOPER
|
||||
const SPRITE_ANIM_INDEX_INTRO_UNOWN
|
||||
const SPRITE_ANIM_INDEX_INTRO_UNOWN_F
|
||||
const SPRITE_ANIM_INDEX_INTRO_SUICUNE_AWAY
|
||||
const SPRITE_ANIM_INDEX_CELEBI
|
||||
|
||||
; SpriteAnimOAMData indexes (see data/sprite_engine.asm)
|
||||
const_def
|
||||
|
||||
const SPRITE_ANIM_FRAME_IDX_00
|
||||
const SPRITE_ANIM_FRAME_IDX_01
|
||||
const SPRITE_ANIM_FRAME_IDX_02
|
||||
|
||||
Reference in New Issue
Block a user