Start documentation for map scripts

This commit is contained in:
Remy Oukaour
2017-12-11 21:40:21 -05:00
parent 11b9bcb9e5
commit 20f98e1403
3 changed files with 250 additions and 219 deletions

31
docs/map_scripts.md Normal file
View File

@@ -0,0 +1,31 @@
# Map Scripts
## `const_value set 2`
## *`MapName`*`_MapScriptHeader:`
## `.MapTriggers:`
**`maptrigger `**___`script`___
## `.MapCallbacks:`
**`dbw `**___`type`___**`, `**___`script`___
## *`MapName`*`_MapScriptHeader:`
## `.Warps:`
**`warp_def `**___`y`___**`, `**___`x`___**`, `**___`id`___**`, `**___`map`___
## `.XYTriggers:`
**`xy_trigger `**___`id`___**`, `**___`y`___**`, `**___`x`___**`, $0, `**___`script`___**`, $0, $0`**
## `.Signposts:`
**`signpost `**___`y`___**`, `**___`x`___**`, `**___`type`___**`, `**___`script``___
## `.PersonEvents:`
**`person_event `**___`sprite`___**`, `**___`y`___**`, `**___`x`___**`, `**___`movement`___**`, `**___`ry`___**`, `**___`rx`___**`, `**___`hour`___**`, `**___`day`___**`, `**___`palette`___**`, `**___`type`___**`, `**___`range`___**`, `**___`script`___**`, `**___`flag`___

View File

@@ -1,93 +1,93 @@
# Music Commands # Music Commands
## **`musicheader`** *n*, *index*, *address* ## `musicheader` *n*, *index*, *address*
## **`cry_header`** *n*, *index*, *address* ## `cry_header` *n*, *index*, *address*
## **`note`** *pitch*, *octave* ## `note` *pitch*, *octave*
## **`sound`** *pitch*, *octave*, *intensity*, *frequency* ## `sound` *pitch*, *octave*, *intensity*, *frequency*
## **`noise`** *pitch*, *duration*, *intensity*, *frequency* ## `noise` *pitch*, *duration*, *intensity*, *frequency*
## `$D0``$D7`: **`octave`** *n* ## `$D0``$D7`: `octave` *n*
## `$D8`: **`notetype`** *length*[, *intensity*] ## `$D8`: `notetype` *length*[, *intensity*]
## `$D9`: **`pitchoffset`** *octave*, *key* ## `$D9`: `pitchoffset` *octave*, *key*
## `$DA`: **`tempo`** *tempo* ## `$DA`: `tempo` *tempo*
## `$DB`: **`dutycycle`** *duty_cycle* ## `$DB`: `dutycycle` *duty_cycle*
## `$DC`: **`intensity`** *intensity* ## `$DC`: `intensity` *intensity*
## `$DD`: **`soundinput`** *input* ## `$DD`: `soundinput` *input*
## `$DE`: **`sound_duty`** *a*, *b*, *c*, *d* ## `$DE`: `sound_duty` *a*, *b*, *c*, *d*
## `$DF`: **`togglesfx`** ## `$DF`: `togglesfx`
## `$E0`: **`slidepitchto`** *duration*, *octave*, *pitch* ## `$E0`: `slidepitchto` *duration*, *octave*, *pitch*
## `$E1`: **`vibrato`** *delay*, *extent* ## `$E1`: `vibrato` *delay*, *extent*
## `$E2`: **`unknownmusic0xe2`** *unknown* ## `$E2`: `unknownmusic0xe2` *unknown*
## `$E3`: **`togglenoise`** *id* ## `$E3`: `togglenoise` *id*
## `$E4`: **`panning`** *tracks* ## `$E4`: `panning` *tracks*
## `$E5`: **`volume`** *volume* ## `$E5`: `volume` *volume*
## `$E6`: **`tone`** *tone* ## `$E6`: `tone` *tone*
## `$E7`: **`unknownmusic0xe7`** *unknown* ## `$E7`: `unknownmusic0xe7` *unknown*
## `$E8`: **`unknownmusic0xe8`** *unknown* ## `$E8`: `unknownmusic0xe8` *unknown*
## `$E9`: **`tempo_relative`** *value* ## `$E9`: `tempo_relative` *value*
## `$EA`: **`restartchannel`** *address* ## `$EA`: `restartchannel` *address*
## `$EB`: **`newsong`** *id* ## `$EB`: `newsong` *id*
## `$EC`: **`sfxpriorityon`** ## `$EC`: `sfxpriorityon`
## `$ED`: **`sfxpriorityoff`** ## `$ED`: `sfxpriorityoff`
## `$EE`: **`unknownmusic0xee`** *address* ## `$EE`: `unknownmusic0xee` *address*
## `$EF`: **`stereopanning`** *tracks* ## `$EF`: `stereopanning` *tracks*
## `$F0`: **`sfxtogglenoise`** *id* ## `$F0`: `sfxtogglenoise` *id*
## `$F1`: **`music0xf1`** ## `$F1`: `music0xf1`
## `$F2`: **`music0xf2`** ## `$F2`: `music0xf2`
## `$F3`: **`music0xf3`** ## `$F3`: `music0xf3`
## `$F4`: **`music0xf4`** ## `$F4`: `music0xf4`
## `$F5`: **`music0xf5`** ## `$F5`: `music0xf5`
## `$F6`: **`music0xf6`** ## `$F6`: `music0xf6`
## `$F7`: **`music0xf7`** ## `$F7`: `music0xf7`
## `$F8`: **`music0xf8`** ## `$F8`: `music0xf8`
## `$F9`: **`unknownmusic0xf9`** ## `$F9`: `unknownmusic0xf9`
## `$FA`: **`setcondition`** *condition* ## `$FA`: `setcondition` *condition*
## `$FB`: **`jumpif`** *condition*, *address* ## `$FB`: `jumpif` *condition*, *address*
## `$FC`: **`jumpchannel`** *address* ## `$FC`: `jumpchannel` *address*
## `$FD`: **`loopchannel`** *count*, *address* ## `$FD`: `loopchannel` *count*, *address*
## `$FE`: **`callchannel`** *address* ## `$FE`: `callchannel` *address*
## `$FF`: **`endchannel`** ## `$FF`: `endchannel`

File diff suppressed because it is too large Load Diff