Difference between revisions of "Myst scripts"

Revision as of 20:31, 12 October 2008 (view source) TitoDalCanton (Talk | contribs) (→‎Command 39) ← Older edit		Revision as of 20:40, 12 October 2008 (view source) TitoDalCanton (Talk | contribs) (→‎Command 28) Newer edit →
Line 169:		Line 169:
	*'''Arguments:''' (<''l t r b''>|''FFFF'')		*'''Arguments:''' (<''l t r b''>|''FFFF'')
−	<''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources.	+	Often used after command 29. <''l t r b''> often corresponds with the intended location of one of the sub-images in the VIEW resources. Guess: update screen rectangle? See Mechanical card 6009.
−		+
−	Guess: update screen rectangle? See Mechanical card 6009.	+
	===Command 29: copy picture over the hotspot===		===Command 29: copy picture over the hotspot===

---

Revision as of 20:40, 12 October 2008

Myst
Mohawk		Overview
CLRC	EXIT	HINT	INIT
MJMP	MSND	PICT	RLST
VIEW	WDIB	HELP	RSFL
Scripts		Variables

This page describes Myst scripts, command lists used in record types 5, 6, 7, 8, 10, 11, and 12. Scripts always start with an unsigned short representing the command count. Each command has this structure:

unsigned short	opcode
unsigned short	var
unsigned short	arg_count
short	args[arg_count]

When a variable is not given, var is set to 0. So when the key below says that the variable is optional, that means that it has been found both with and without a variable being passed in. In some cases, the syntax of the arguments depends on whether a variable was passed in. In this case, the variable/arguments header is repeated for each form of the command.

Commands 0-99

These are suspected to be general-purpose commands.

Command 0

• Variable: Optional
• Arguments: None

Seems to toggle a variable between 0 and 1. For example, see the marker switches on MYST island.

Command 1

• Variable: Optional
• Arguments: u0

Could mean "set variable to u0". u0 takes on any number between 0 and 7 (maybe a bit field?)

Command 2: alternative destination

• Variable: Yes
• Arguments: dest

This command goes to dest instead of the regular destination if var is a certain (unknown) value. (Only used for SELEN 1240 and CHANNEL 3359)

Command 3: change cursor

• Variable: Yes
• Arguments: clrc_id

• clrc_id is always 800, 801, or 802. (Only 5 different cases). These are the "animated" cursors of dropping the white, red, and blue pages, respectively.

This command seems to change cursor to clrc_id if var is a certain (unknown) value.

Command 4

• Variable: Optional
• Arguments: None

Command 6

• Variable: Optional
• Arguments: None

Command 7

• Variable: Optional
• Arguments: None

Command 8

• Variable: Optional
• Arguments: None

Command 9

• Variable: No
• Arguments: [u0]

• u0 is always either FFFF or omitted.

Command 12

• Variable: Optional
• Arguments: u0

Related to command 13.

• u0 appears to be a nearby card.

This may have similar function to command 2.

Command 13

• Variable: Optional
• Arguments: u0

Related to command 12.

• u0 appears to be a nearby card.

This may have similar function to command 2.

Command 14

• Variable: Optional
• Arguments: u0

• u0 is always 0, 1, or 2.

Command 15

• Variable: Yes
• Arguments: [u0]

• u0 is always 0 or omitted.

Command 16

• Variable: No
• Arguments: u0 u1

• u0 appears to be a nearby card.
• u1 is always 0.

Command 17

• Variable: No
• Arguments: u0 u1

• u0 appears to be a nearby card.
• u1 is always 4, 5, or 6.

Command 18

• Variable: No
• Arguments: u0

• u0 is always 4, 5, or 6.

Command 19: enable hotspots

• Variable: No
• Arguments: count indexes[count]

This seems to enable a list of hotspots, specified by indexes.

Command 20: disable hotspots

• Variable: No
• Arguments: count indexes[count]

This seems to disable a list of hotspots, specified by indexes. These, unlike command 19, can also be -1, which seems to disable the invoking hotspot.

Command 21

• Variable: No
• Arguments: u0 u1 u2 u3 u4 u5

There are this command is used 6 times.

• u0 is always 0, 74, 76, 117, or 198.
• u1 is always 0, 48, 213, or 226.
• u2 is always 327, 406, 429, 459, or 544.
• u3 is always 257, 332, or 333.
• u4 is always 0, 1, 5, 6, or 11.
• u5 is always 5 or 25.

Command 22

• Variable: No
• Arguments: None

Command 23

• Variable: No
• Arguments: count u0[count]

• The u0 numbers are all 0, 4, or 5.

Command 24: play sound

• Variable: No
• Arguments: sound_id

Play sound with ID sound_id.

Command 26

• Variable: No
• Arguments: None

Command 27

• Variable: No
• Arguments: u0

• u0 appears to be a sound ID.

Command 28

• Variable: No
• Arguments: (<l t r b>|FFFF)

Often used after command 29. <l t r b> often corresponds with the intended location of one of the sub-images in the VIEW resources. Guess: update screen rectangle? See Mechanical card 6009.

Command 29: copy picture over the hotspot

• Variable: No
• Arguments: pict_id <l t r b> u0 u1

• pict_id appears to be a picture ID.
• <l t r b> often corresponds with the intended location of one of the sub-images in the VIEW resources.
• u0 appears to be a variable number (it is sometimes 0).
• u1 may also be a variable number (it is sometimes 0, 1, or -1).

This command seems to copy picture pict_id over the hotspot, using <l t r b> as the source rect. Additional data is unknown.

Command 30: start background sounds

• Variable: No
• Arguments: variable

This seems to start a background sound combination. The arg list seems to follow the philosophy of the sounds section in VIEW resources. In most cases there are just 2 args, a positive msnd_id (background sound ID to play) and flags. However, there is a single exception with 8 args (RLST ID 3225 in Channelwood) which can be correctly interpreted simply as a more complex sounds section.

Command 31

• Variable: Yes (only ever 30)
• Arguments: u0 u1

• u0 is always 0.
• u1 looks like a card ID.

Command 32

• Variable: No
• Arguments: None

Command 33: draw picture

• Variable: No
• Arguments: id <sl st sr sb> <dl dt>

Draw a picture, given the ID and source rect, at position <dl,dt>.

Command 34

• Variable: No
• Arguments: u0 u1

• u0 looks like a card ID.
• u1 is always 0, 1, 4, 5, 6, 9, 10, or 11.

Command 35

• Variable: No
• Arguments: u0 u1 u2

• u0 looks like a card ID.
• u1 looks like a card ID.
• u2 is always 0, 6, or 10.

Command 36

• Variable: No
• Arguments: u0

This command is only used twice.

• u0 is 900 or 903.

Command 37

• Variable: No
• Arguments: None

Seems to form pairs with command 38, where it opens the script and command 38 ends it.

Command 38

• Variable: No
• Arguments: None

Seems to form pairs with command 37, where it closes the script while command 37 opens it.

Command 39

• Variable: No
• Arguments: u0

u0 is 100, 200, 400, 500, 1000, or 1100. Guess: pause execution for u0 milliseconds?

Command 40: travel to destination age

• Variable: No
• Arguments: dst_age_id src_msnd_id dst_msnd_id

• dst_age_id is one of 0 (selen), 1 (stone), 2 (myst), 3 (mechan), 4 (channel) or 6 (dunny).
• src_msnd_id is a sound ID to play in source age.
• dst_msnd_id is a sound ID to play in destination age.

Command 41

• Variable: No
• Arguments: u0 u1 u2 count u3[count]

• u0 looks like a card ID.
• u1 looks like a sound ID.
• u2 is always 5 or 10.
• count is only ever 6 or 12.
• u3 may be divided into groups of sixes.

Command 42

• Variable: No
• Arguments: u0 u1 count u2[count]

• u0 looks like a sound ID.
• u1 is always 5, 10, 15, or 20.
• count is only ever 6 or 12.
• u2 may be divided into groups of sixes.

Command 43

• Variable: No
• Arguments: None

Command 44

• Variable: No
• Arguments: None

Command 46

• Variable: No
• Arguments: None

Commands 100-199

These are suspected to be age-specific, as their syntax changes depending on the age.

Command 100

• Variable: Optional
• Arguments: [u0]

• u0 is always 4, 6, or omitted.

Command 101

• Variable: No
• Arguments: [u0|u1[6]]

• u0 is always 4225 or omitted.
• u1 is a series of 6 positive numbers.

Command 102

• Variable: No
• Arguments: [u0 u1 [u2]]

• u0 looks like a card ID (or 0).
• u1 looks like a card ID.
• u2 looks like an (optional) bit field. (only 0x64 or 0)

Command 103

• Variable: Yes
• Arguments: bit

This form of the command most likely negates bit bit of var.

• bit is a power of 2 (bit mask).

• Variable: No
• Arguments: u0 [u1]

This form of the command likely makes specified hotspot drawable.

• u0 is a number between 13 and 18. It seems to refer to a hotspot index (see stone 2197).
• u1 is either 1 or omitted.

Command 104

• Variable: No
• Arguments: [u0]

This command likely makes specified hotspot not drawable.

• u0 can be 0, 1, omitted, or 13 to 20. It seems to refer to a hotspot index (see stone 2004 and 2197).

Command 105

• Variable: Optional (set to 9 at one point, but usually not)
• Arguments: [u0]

• u0 looks like a sound ID.

Command 106

• Variable: 10
• Arguments: 2287 (looks like sound ID)

This command is only used once.

Command 107

• Variable: 11
• Arguments: 2287 (looks like sound ID)

This command is only used once.

Command 108

• Variable: 12
• Arguments: 2287 (looks like sound ID)

This command is only used once.

Command 109

• Variable: Optional
• Arguments: [u0]

• u0 is FFFF, 1, omitted, or 2287 (looks like sound ID).

Command 110

• Variable: No
• Arguments: 1180 1179 12 203 78 345 167 6 10 203 166 345 306 5 10

This command is only used once.

Command 111

• Variable: No
• Arguments: [u0]

This command likely makes specified hotspot not drawable.

• u0 is 14 to 20 or omitted. It seems to refer to a hotspot index (see stone 2004).

Command 112

• Variable: 29
• Arguments: u0 u1 u2

This command is only used twice.

• u0 is 0 or 1800.
• u1 is 400 or 2000.
• u2 is 1.

Command 113

• Variable: No
• Arguments: 5143 10 6 339 237 423 333 0 10

This command is only used once. 5143 is likely sound ID.

Command 114

• Variable: No
• Arguments: 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely sound ID.

Command 115

• Variable: Yes
• Arguments: u0[3]

• The u0 look like card ID's.

• Variable: No
• Arguments: 1139 1140 1140 10 6 204 64 343 279 6 50

This form of the command is only used once.

Command 116

• Variable: No
• Arguments: u0

• u0 is 0, 1, or 6006.

Command 117

• Variable: No
• Arguments: [u0|u1 u2]

• u0 is 0, 1, 2, 3, or omitted.
• u1 and u2 are 5698 and 6698 (only used once).

Command 118

• Variable: No
• Arguments: [4707 5707 6707 7707 4705]

This command is only used 3 times (once with values and twice omitted). Values are likely sound IDs.

Command 119

• Variable: No
• Arguments: [u0]

• u0 is 0, 1, or omitted.

Command 120

• Variable: No
• Arguments: [u0]

• u0 is 0, 1, 2, 3, or omitted.

Command 121

• Variable: Yes
• Arguments: None

• Variable: No
• Arguments: u0 u1

• u0 is 0 or a card ID.
• u1 is a card ID.

Command 122

• Variable: No
• Arguments: None

Command 123

• Variable: No
• Arguments: u0 [u1]

• u0 is 0, 1, or 960.
• u1 is 960, 1920, or omitted.

Command 124

• Variable: No
• Arguments: None

Command 125

• Variable: No
• Arguments: None

• Variable: 21
• Arguments: u0

• u0 is 13 or 14.

Command 126

• Variable: No
• Arguments: None

Command 127

• Variable: no
• Arguments: u0 u1

• u0 is 1, 2, or 3.
• u1 is 0 or 1.

Command 129

• Variable: No
• Arguments: u0

• u0 looks like a sound ID.

Command 133

• Variable: No
• Arguments: 6500

This command is only used once. Value is a sound ID.

Command 164

• Variable: No
• Arguments: None

Command 169

• Variable: No
• Arguments: None

Command 198

• Variable: No
• Arguments: 5143 10 6 339 237 423 333 1 10

This command is only used once. 5143 is likely a sound ID.

Command 199

• Variable: No
• Arguments: None

Commands 200-299

These are only seen in the INIT scripts.

Command 200

• Variable: Optional
• Arguments: None
• Seen: DUNNY, INTRO, MECHAN, SELEN, STONE

• Variable: No
• Arguments: u0 u1[3]
• Seen: MYST

• u1 appears to be three sound IDs.

Command 201

• Variable: No
• Arguments: None
• Seen: CHANNEL, INTRO, SELEN, STONE

• Variable: No
• Arguments: u0
• Seen: MYST
• u0 looks like a sound ID.

• Variable: No
• Arguments: 0 4 5
• Seen: MECHAN

Command 202

• Variable: No
• Arguments: None
• Seen: MECHAN, SELEN, STONE

• Variable: Yes
• Arguments: None
• Seen: CHANNEL

• Variable: No
• Arguments: 13
• Seen: MYST

Command 203

• Variable: No
• Arguments: None
• Seen: CHANNEL, MECHAN, MYST, SELEN

• Variable: No
• Arguments: count u0[count] u1
• Seen: STONE

• u0 look like node IDs.
• u1 looks like a sound ID.

Command 204

• Variable: No
• Arguments: None
• Seen: MYST, SELEN, STONE

• Variable: No
• Arguments: u0
• Seen: MECHAN

• u0 looks like a sound ID.

Command 205

• Variable: No
• Arguments: None
• Seen: MYST, SELEN

• Variable: No
• Arguments: count u0[count] u1
• Seen: STONE

• u0 look like node IDs.
• u1 looks like a sound ID.

• Variable: No
• Arguments: u0[4]
• Seen: MECHAN

• u0 look like sound IDs.

Command 206

• Variable: No
• Arguments: None
• Seen: MYST, SELEN, STONE

• Variable: No
• Arguments: u0[6]
• Seen: MECHAN

• u0 look like sound IDs.

Command 207

• Variable: No
• Arguments: STONE

Command 208

• Variable: Yes
• Arguments: None
• Seen: MYST

• Variable: No
• Arguments: u0[3]
• Seen: STONE

Command 209

• Variable: No
• Arguments: None
• Seen:

Command 210

• Variable: No
• Arguments: None
• Seen:

Command 211

• Variable: No
• Arguments: None
• Seen:

Command 212

• Variable: No
• Arguments: None

Command 213

• Variable: No
• Arguments: None

Command 214

• Variable: No
• Arguments: None
• Seen:

Command 215

• Variable: No
• Arguments: None
• Seen:

Command 216

• Variable: No
• Arguments: None
• Seen:

Command 217

• Variable: No
• Arguments: None

Command 218

• Variable: No
• Arguments: None
• Seen:

Command 219

• Variable: No
• Arguments: None
• Seen:

Command 220

• Variable: No
• Arguments: None
• Seen:

Command 221

• Variable: No
• Arguments: None
• Seen:

Command 222

• Variable: No
• Arguments: None
• Seen:

Commands 300-399

These are only seen in the EXIT scripts.

Command 300

• Variable: No
• Arguments: None
• Seen:

Command 301

• Variable: No
• Arguments: None
• Seen:

Command 302

• Variable: No
• Arguments: None
• Seen:

Command 303

• Variable: No
• Arguments: None
• Seen:

Command 304

• Variable: No
• Arguments: None

Command 305

• Variable: No
• Arguments: None
• Seen:

Command 306

• Variable: No
• Arguments: None
• Seen:

Command 307

• Variable: No
• Arguments: None
• Seen:

Command 308

• Variable: No
• Arguments: None
• Seen:

Command 309

• Variable: No
• Arguments: None
• Seen:

Command 312

• Variable: No
• Arguments: None
• Seen: