diff options
author | Remy Oukaour <remy.oukaour@gmail.com> | 2017-12-11 22:02:20 -0500 |
---|---|---|
committer | Remy Oukaour <remy.oukaour@gmail.com> | 2017-12-11 22:02:20 -0500 |
commit | fe9cb90049ab0ab3a2fbb988539ed46afb0b6433 (patch) | |
tree | f10d0cb64246abb7e90e49a21c6eb38903be7aed | |
parent | 19a3d1b6e456e416fd57eb1fd28333174aecbef4 (diff) |
Fix map script documentation formatting
-rw-r--r-- | docs/map_scripts.md | 115 |
1 files changed, 101 insertions, 14 deletions
diff --git a/docs/map_scripts.md b/docs/map_scripts.md index 722faa37a..72d8561b6 100644 --- a/docs/map_scripts.md +++ b/docs/map_scripts.md @@ -1,31 +1,118 @@ # Map Scripts + ## `const_value set 2` -## *`MapName`*`_MapScriptHeader:` +### `const <MAPNAME>_<PERSONNAME>` + + +## `MapName_MapScriptHeader:` + + +## `.MapTriggers: db <N>` + +### `maptrigger <script>` + + +## `.MapCallbacks: db <N>` + +### `dbw <type>, <script>` + + +## Scripts + + +## Text + +- **`text`** +- **`line`** +- **`cont`** +- **`para`** +- **`done`** + + +## `MapName_MapEventHeader:` + + ; filler + db 0, 0 + + +## `.Warps: db <N>` + +### `warp_def <y>, <x>, <id>, <map>` + + +## `.XYTriggers: db <N>` + +### `xy_trigger <id>, <y>, <x>, $0, <script>, $0, $0` + + +## `.Signposts: db <N>` + +### `signpost <y>, <x>, <type>, <script>` + +#### Signpost types: + +- **`SIGNPOST_READ`** + +- **`SIGNPOST_UP/DOWN/LEFT/RIGHT`** + +- **`SIGNPOST_IFSET/IFNOTSET`** + + `dw <event_flag>, <script>` + +- **`SIGNPOST_ITEM`** + + `dwb <event_flag>, <item_id>` + +- **`SIGNPOST_COPY`** + +## `.PersonEvents: db <N>` + +### `person_event <sprite>, <y>, <x>, <movement>, <ry>, <rx>, <hour>, <day>, <palette>, <type>, <range>, <script>, <flag>` + +#### Movement types: + +- **`SPRITEMOVEDATA_ITEM_TREE`** + +- **`SPRITEMOVEDATA_WANDER`** + +- **`SPRITEMOVEDATA_SPINRANDOM_SLOW`** + +- **`SPRITEMOVEDATA_WALK_UP_DOWN`** + +- **`SPRITEMOVEDATA_WALK_LEFT_RIGHT`** + +- **`SPRITEMOVEDATA_STANDING_UP/DOWN/LEFT/RIGHT`** + +- **`SPRITEMOVEDATA_SPINRANDOM_FAST`** + +- **`SPRITEMOVEDATA_SNORLAX`** + +- **`SPRITEMOVEDATA_POKEMON`** -## `.MapTriggers:` +- **`SPRITEMOVEDATA_SUDOWOODO`** -### `maptrigger `*`script`* +- **`SPRITEMOVEDATA_SMASHABLE_ROCK`** -## `.MapCallbacks:` +- **`SPRITEMOVEDATA_STRENGTH_BOULDER`** -### `dbw `*`type`*`, `*`script`* +- **`SPRITEMOVEDATA_SPINCOUNTERCLOCKWISE`** -## *`MapName`*`_MapScriptHeader:` +- **`SPRITEMOVEDATA_SPINCLOCKWISE`** -## `.Warps:` +- **`SPRITEMOVEDATA_BIGDOLL`** -### `warp_def `*`y`*`, `*`x`*`, `*`id`*`, `*`map`* +- **`SPRITEMOVEDATA_LAPRAS`** -## `.XYTriggers:` +#### Person types: -### `xy_trigger `*`id`*`, `*`y`*`, `*`x`*`, $0, `*`script`*`, $0, $0` +- **`PERSONTYPE_SCRIPT`** -## `.Signposts:` +- **`PERSONTYPE_ITEMBALL`** -### `signpost `*`y`*`, `*`x`*`, `*`type`*`, `*`script`* + **`itemball <item_id>`** -## `.PersonEvents:` +- **`PERSONTYPE_TRAINER`** -### `person_event `*`sprite`*`, `*`y`*`, `*`x`*`, `*`movement`*`, `*`ry`*`, `*`rx`*`, `*`hour`*`, `*`day`*`, `*`palette`*`, `*`type`*`, `*`range`*`, `*`script`*`, `*`flag`* + **`trainer <event_flag>, <group_id>, <trainer_id>, <seen_text>, <beaten_text>, <loss_text>, <script>`** |