pokecrystal/macros/scripts/maps.asm

map_id: MACRO
;\1: map id
	db GROUP_\1, MAP_\1
ENDM

scene_script: MACRO
;\1: script pointer
	dw \1
	dw 0 ; filler
ENDM

callback: MACRO
;\1: type: a MAPCALLBACK_* constant
;\2: script pointer
	dbw \1, \2
ENDM

warp_event: MACRO
;\1: x: left to right, starts at 0
;\2: y: top to bottom, starts at 0
;\3: map id: from constants/map_constants.asm
;\4: warp destination: starts at 1
	db \2, \1, \4
	map_id \3
ENDM

coord_event: MACRO
;\1: x: left to right, starts at 0
;\2: y: top to bottom, starts at 0
;\3: scene id: a SCENE_* constant; controlled by setscene/setmapscene
;\4: script pointer
	db \3, \2, \1
	db 0 ; filler
	dw \4
	db 0, 0 ; filler
ENDM

bg_event: MACRO
;\1: x: left to right, starts at 0
;\2: y: top to bottom, starts at 0
;\3: function: a BGEVENT_* constant
;\4: script pointer
	db \2, \1, \3
	dw \4
ENDM

object_event: MACRO
;\1: x: left to right, starts at 0
;\2: y: top to bottom, starts at 0
;\3: sprite: a SPRITE_* constant
;\4: movement function: a SPRITEMOVEDATA_* constant
;\5, \6: movement radius: x, y
;\7, \8: hour limits: h1, h2 (0-23)
;  * if h1 < h2, the object_event will only appear from h1 to h2
;  * if h1 > h2, the object_event will not appear from h2 to h1
;  * if h1 == h2, the object_event will always appear
;  * if h1 == -1, h2 is treated as a time-of-day value:
;    a combo of MORN, DAY, and/or NITE, or -1 to always appear
;\9: color: a PAL_NPC_* constant, or 0 for sprite default
;\10: function: a OBJECTTYPE_* constant
;\11: sight range: applies to OBJECTTYPE_TRAINER
;\12: script pointer
;\13: event flag: an EVENT_* constant, or -1 to always appear
	db \3, \2 + 4, \1 + 4, \4
	dn \6, \5
	db \7, \8
	shift
	dn \8, \9
	shift
	db \9
	shift
	dw \9
	shift
	dw \9
ENDM

trainer: MACRO
;\1: trainer group
;\2: trainer id
;\3: flag: an EVENT_BEAT_* constant
;\4: seen text
;\5: win text
;\6: loss text
;\7: after-battle text
	dw \3
	db \1, \2
	dw \4, \5, \6, \7
ENDM

itemball: MACRO
;\1: item: from constants/item_constants.asm
;\2: quantity: default 1
if _NARG == 1
	itemball \1, 1
else
	db \1, \2
endc
ENDM

hiddenitem: MACRO
;\1: item: from constants/item_constants.asm
;\2: flag: an EVENT_* constant
	dwb \2, \1
ENDM

elevfloor: MACRO
;\1: floor: a FLOOR_* constant
;\2: warp destination: starts at 1
;\3: map id
	db \1, \2
	map_id \3
ENDM

conditional_event: MACRO
;\1: flag: an EVENT_* constant
;\2: script pointer
	dw \1, \2
ENDM

cmdqueue: MACRO
;\1: type: a CMDQUEUE_* constant
;\2: data pointer
	dbw \1, \2
	dw 0 ; filler
ENDM

stonetable: MACRO
;\1: warp id
;\2: object_event id
;\3: script pointer
	dbbw \1, \2, \3
ENDM
map → map_id; map_def → map; map_data → map_attributes 2018-02-03 21:58:49 +00:00			`map_id: MACRO`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\1: map id`
			`db GROUP_\1, MAP_\1`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Reorganize macros 2017-12-14 05:36:24 +00:00
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`scene_script: MACRO`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\1: script pointer`
More comments and macros 2018-02-01 20:19:27 +00:00			`dw \1`
			`dw 0 ; filler`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Reorganize macros 2017-12-14 05:36:24 +00:00
Introduce callback, hiddenitem, conditional_event, and cmdqueue macros for map scripts 2018-01-13 05:47:38 +00:00			`callback: MACRO`
			`;\1: type: a MAPCALLBACK_* constant`
			`;\2: script pointer`
			`dbw \1, \2`
			`ENDM`

grep -rl warp_def . \| xargs sed -i s/warp_def/warp_event/g 2018-01-28 18:20:04 +00:00			`warp_event: MACRO`
Consistent (x, y) coordinate formatting in map scripts 2017-12-28 19:31:25 +00:00			`;\1: x: left to right, starts at 0`
			`;\2: y: top to bottom, starts at 0`
warp_event x, y, map, warp_id 2018-02-02 02:54:00 +00:00			`;\3: map id: from constants/map_constants.asm`
			`;\4: warp destination: starts at 1`
			`db \2, \1, \4`
map → map_id; map_def → map; map_data → map_attributes 2018-02-03 21:58:49 +00:00			`map_id \3`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Reorganize macros 2017-12-14 05:36:24 +00:00
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`coord_event: MACRO`
Consistent (x, y) coordinate formatting in map scripts 2017-12-28 19:31:25 +00:00			`;\1: x: left to right, starts at 0`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\2: y: top to bottom, starts at 0`
More comments and macros 2018-02-01 20:19:27 +00:00			`;\3: scene id: a SCENE_* constant; controlled by setscene/setmapscene`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\4: script pointer`
Introduce callback, hiddenitem, conditional_event, and cmdqueue macros for map scripts 2018-01-13 05:47:38 +00:00			`db \3, \2, \1`
			`db 0 ; filler`
Reorganize macros 2017-12-14 05:36:24 +00:00			`dw \4`
Introduce callback, hiddenitem, conditional_event, and cmdqueue macros for map scripts 2018-01-13 05:47:38 +00:00			`db 0, 0 ; filler`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Reorganize macros 2017-12-14 05:36:24 +00:00
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`bg_event: MACRO`
Consistent (x, y) coordinate formatting in map scripts 2017-12-28 19:31:25 +00:00			`;\1: x: left to right, starts at 0`
			`;\2: y: top to bottom, starts at 0`
Renaming: (fix #412) - MapTriggers / maptrigger → SceneScripts / scene_script - XYTriggers / xy_trigger → CoordEvents / coord_event - Signposts / signpost → BGEvents / bg_event - PersonEvents / person_event → ObjectEvents / object_event 2017-12-24 18:46:34 +00:00			`;\3: function: a BGEVENT_* constant`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\4: script pointer`
Consistent (x, y) coordinate formatting in map scripts 2017-12-28 19:31:25 +00:00			`db \2, \1, \3`
Reorganize macros 2017-12-14 05:36:24 +00:00			`dw \4`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Reorganize macros 2017-12-14 05:36:24 +00:00
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`object_event: MACRO`
Consistent (x, y) coordinate formatting in map scripts 2017-12-28 19:31:25 +00:00			`;\1: x: left to right, starts at 0`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\2: y: top to bottom, starts at 0`
Consistent (x, y) coordinate formatting in map scripts 2017-12-28 19:31:25 +00:00			`;\3: sprite: a SPRITE_* constant`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\4: movement function: a SPRITEMOVEDATA_* constant`
Consistent (x, y) coordinate formatting in map scripts 2017-12-28 19:31:25 +00:00			`;\5, \6: movement radius: x, y`
s/number/scene/, and correct some documentation 2017-12-24 22:35:33 +00:00			`;\7, \8: hour limits: h1, h2 (0-23)`
			`; * if h1 < h2, the object_event will only appear from h1 to h2`
			`; * if h1 > h2, the object_event will not appear from h2 to h1`
			`; * if h1 == h2, the object_event will always appear`
			`; * if h1 == -1, h2 is treated as a time-of-day value:`
Document the meaning of hour and daytime values for person_events 2017-12-23 06:19:34 +00:00			`; a combo of MORN, DAY, and/or NITE, or -1 to always appear`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\9: color: a PAL_NPC_* constant, or 0 for sprite default`
Renaming: (fix #412) - MapTriggers / maptrigger → SceneScripts / scene_script - XYTriggers / xy_trigger → CoordEvents / coord_event - Signposts / signpost → BGEvents / bg_event - PersonEvents / person_event → ObjectEvents / object_event 2017-12-24 18:46:34 +00:00			`;\10: function: a OBJECTTYPE_* constant`
			`;\11: sight range: applies to OBJECTTYPE_TRAINER`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\12: script pointer`
s/number/scene/, and correct some documentation 2017-12-24 22:35:33 +00:00			`;\13: event flag: an EVENT_* constant, or -1 to always appear`
Consistent (x, y) coordinate formatting in map scripts 2017-12-28 19:31:25 +00:00			`db \3, \2 + 4, \1 + 4, \4`
			`dn \6, \5`
Reorganize macros 2017-12-14 05:36:24 +00:00			`db \7, \8`
			`shift`
			`dn \8, \9`
			`shift`
			`db \9`
			`shift`
			`dw \9`
			`shift`
			`dw \9`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Reorganize macros 2017-12-14 05:36:24 +00:00
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`trainer: MACRO`
trainers put the class and id first: `trainer YOUNGSTER, JOEY1, ...` 2018-01-23 18:08:48 +00:00			`;\1: trainer group`
			`;\2: trainer id`
			`;\3: flag: an EVENT_BEAT_* constant`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\4: seen text`
			`;\5: win text`
			`;\6: loss text`
			`;\7: after-battle text`
trainers put the class and id first: `trainer YOUNGSTER, JOEY1, ...` 2018-01-23 18:08:48 +00:00			`dw \3`
			`db \1, \2`
Reorganize macros 2017-12-14 05:36:24 +00:00			`dw \4, \5, \6, \7`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Reorganize macros 2017-12-14 05:36:24 +00:00
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`itemball: MACRO`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\1: item: from constants/item_constants.asm`
			`;\2: quantity: default 1`
Default macro parameters use recursion; avoids repeating internal structure 2018-02-26 01:12:58 +00:00			`if _NARG == 1`
			`itemball \1, 1`
Reorganize macros 2017-12-14 05:36:24 +00:00			`else`
Default macro parameters use recursion; avoids repeating internal structure 2018-02-26 01:12:58 +00:00			`db \1, \2`
Reorganize macros 2017-12-14 05:36:24 +00:00			`endc`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Reorganize macros 2017-12-14 05:36:24 +00:00
Introduce callback, hiddenitem, conditional_event, and cmdqueue macros for map scripts 2018-01-13 05:47:38 +00:00			`hiddenitem: MACRO`
hiddenitem, like itemball and object_event, puts the item first and the event last 2018-01-23 17:59:21 +00:00			`;\1: item: from constants/item_constants.asm`
			`;\2: flag: an EVENT_* constant`
			`dwb \2, \1`
Introduce callback, hiddenitem, conditional_event, and cmdqueue macros for map scripts 2018-01-13 05:47:38 +00:00			`ENDM`

Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`elevfloor: MACRO`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\1: floor: a FLOOR_* constant`
			`;\2: warp destination: starts at 1`
			`;\3: map id`
			`db \1, \2`
map → map_id; map_def → map; map_data → map_attributes 2018-02-03 21:58:49 +00:00			`map_id \3`
Reorganize macros 2017-12-14 05:36:24 +00:00			`ENDM`

Introduce callback, hiddenitem, conditional_event, and cmdqueue macros for map scripts 2018-01-13 05:47:38 +00:00			`conditional_event: MACRO`
			`;\1: flag: an EVENT_* constant`
			`;\2: script pointer`
			`dw \1, \2`
			`ENDM`

			`cmdqueue: MACRO`
			`;\1: type: a CMDQUEUE_* constant`
			`;\2: data pointer`
			`dbw \1, \2`
			`dw 0 ; filler`
			`ENDM`

Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`stonetable: MACRO`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\1: warp id`
Renaming: (fix #412) - MapTriggers / maptrigger → SceneScripts / scene_script - XYTriggers / xy_trigger → CoordEvents / coord_event - Signposts / signpost → BGEvents / bg_event - PersonEvents / person_event → ObjectEvents / object_event 2017-12-24 18:46:34 +00:00			`;\2: object_event id`
Reorganize macros 2017-12-14 05:36:24 +00:00			`;\3: script pointer`
Introduce callback, hiddenitem, conditional_event, and cmdqueue macros for map scripts 2018-01-13 05:47:38 +00:00			`dbbw \1, \2, \3`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`