Riven scripts - Revision history

Tahg: /* Command 18: transition */

2009-05-23T17:19:00Z

‎Command 18: transition

BahamutZERO: fixed a typo

2009-05-23T03:05:56Z

fixed a typo

Tahg: updated mouse events

2009-05-18T14:55:09Z

updated mouse events

TitoDalCanton: /* Command 1: draw tBMP resource */

2008-05-07T08:24:58Z

‎Command 1: draw tBMP resource

TitoDalCanton: /* Command 19: reload card */

2008-05-07T08:23:50Z

‎Command 19: reload card

BahamutZERO: /* Command 19: reload card */

2008-05-05T18:45:34Z

‎Command 19: reload card

TitoDalCanton: event names and fix for event 5

2008-03-16T14:04:26Z

event names and fix for event 5

BahamutZERO: /* Command 4: play local tWAV resource */

2008-02-23T16:18:34Z

‎Command 4: play local tWAV resource

BahamutZERO: /* Command 40: activate SLST record */

2008-02-23T16:17:03Z

‎Command 40: activate SLST record

BahamutZERO: /* Command 40: activate SLST record */

2008-02-23T16:15:24Z

‎Command 40: activate SLST record

@@ Line 199: / Line 199: @@
 {| border=1 cellpadding=4 cellspacing=0 style="border:1px #000 solid;border-collapse:collapse;"
 |- style="background:#CCC"
-! code !! Effect
+! !!width="19%"|Left!!width="19%"|Right!!width="19%"|Up!!width="19%"|Down
 |-
-|style="font-family:monospace"|0...15
+!style="background:#CCC"|Wipe||0||1||2||3
-|Scroll. Bits 0 and 1 control the direction (0=left, 1=right, 2=top, 3=bottom); bit 2 tells if the new image should move (1) or stay fixed (0); bit 3 tells if the old image should move or stay fixed.
 |-
-|style="font-family:monospace"|16||Dissolve.
+!style="background:#CCC"|Scroll||4||5||6||7
 |-
-|style="font-family:monospace"|17||Seems to behave like 16, rare (t_Data, CARD 155).
+!style="background:#CCC"|Scroll Away||8||9||10||11
 |}
-Note that Riven uses only transitions from 12 to 17; other effects were discovered by hacking scripts. Maybe there are more.
+Notes:
 ==Command 19: reload card==

@@ Line 36: / Line 36: @@
 |2||Mouse up||Mouse button released inside the hotspot rect
 |-
-|3||Mose enter||Mouse entered the hotspot rect (never seen in the game)
+|3||Mouse enter||Mouse entered the hotspot rect (never seen in the game)
 |-
 |4||Mouse within||Mouse held inside the hotspot rect (the event is sent repeatedly)

@@ Line 32: / Line 32: @@
 |0||Mouse down||Mouse button pressed inside the hotspot rect
 |-
-|1||||Mouse button pressed inside the hotspot rect (never seen in the game)
+|1||Mouse still down||Mouse button down, sent to last pressed hotspot (never seen in the game)
 |-
 |2||Mouse up||Mouse button released inside the hotspot rect
 |-
-|3||||Mouse moved, pressed or released inside the hotspot rect (never seen in the game)
+|3||Mose enter||Mouse entered the hotspot rect (never seen in the game)
 |-
 |4||Mouse within||Mouse held inside the hotspot rect (the event is sent repeatedly)
 |-
-|5||Mouse leave||Mouse leaved the hotspot rect (not sure)
+|5||Mouse leave||Mouse left the hotspot rect
 |-
 |6||Load card||Card "loaded". This is the first event sent to a card. Usually cards enable things here. Screen updates are disabled during the execution of this handler, and the display is updated at the end.
@@ Line 62: / Line 62: @@
 The following subsections explain what has been discovered about each command. Unlisted opcodes have never been observed in Riven.
 ==Command 1: draw tBMP resource==
 *'''Argument count:''' 9

← Older revision		Revision as of 08:24, 7 May 2008
Line 69:		Line 69:

	The command will automatically update the display unless [[#Command 20: disable screen update\|command 20]] was used before.		The command will automatically update the display unless [[#Command 20: disable screen update\|command 20]] was used before.
		+
		+	Despite its power, command 1 is used on a few scripts only.

	==Command 2: go to card==		==Command 2: go to card==

@@ Line 211: / Line 211: @@
 *'''Argument count:''' 0
-It's something like "refresh card": it acts like a "go to this card" command. Often used to update the card display after an hotspot script has altered a variable. Based on observations made in Riven X, specifically card jspit 389, the "card load" and "card open" programs should both be re-run by this command. It has not been determined if the "card close" program should be executed as well (e.g. a full card switch sequence).
+Refreshes the card, behaving like a "go to <current card>" command. The full handler sequence is executed (see command 2). Often used to update the card display after an hotspot script has altered a variable.
 ==Command 20: disable screen update==

@@ Line 28: / Line 28: @@
 {| border=1 cellpadding=4 cellspacing=0 style="border:1px #000 solid;border-collapse:collapse;"
 |- style="background:#CCC"
-! event_type !! What happened
+! event_type !! Event name !! What happened
 |-
-|0||Mouse button pressed inside the hotspot rect
+|0||Mouse down||Mouse button pressed inside the hotspot rect
 |-
-|1||Mouse button pressed inside the hotspot rect (never seen in the game)
+|1||||Mouse button pressed inside the hotspot rect (never seen in the game)
 |-
-|2||Mouse button released inside the hotspot rect
+|2||Mouse up||Mouse button released inside the hotspot rect
 |-
-|3||Mouse moved, pressed or released inside the hotspot rect (never seen in the game)
+|3||||Mouse moved, pressed or released inside the hotspot rect (never seen in the game)
 |-
-|4||Mouse held inside the hotspot rect (the event is sent repeatedly)
+|4||Mouse within||Mouse held inside the hotspot rect (the event is sent repeatedly)
 |-
-|5||Mouse moved inside the hotspot rect (not sure)
+|5||Mouse leave||Mouse leaved the hotspot rect (not sure)
 |-
-|6||Card "loaded". This is the first event sent to a card. Usually cards enable things here. Screen updates are disabled during the execution of this handler, and the display is updated at the end.
+|6||Load card||Card "loaded". This is the first event sent to a card. Usually cards enable things here. Screen updates are disabled during the execution of this handler, and the display is updated at the end.
 |-
-|7||Leaving card.
+|7||Close card||Leaving card.
 |-
-|9||Card opened. This is sent at the end, when the card has been loaded and the display has been updated. Usually cards start movies and ambient sounds here.
+|9||Open card||Card opened. This is sent at the end, when the card has been loaded and the display has been updated. Usually cards start movies and ambient sounds here.
 |-
-|10||Display being updated; for example this event is triggered when the handler for event 6 completes, or by [[#Command 21: enable screen update|command 21]]. The handler is executed before actually updating the display.
+|10||Display update||Display being updated; for example this event is triggered when the handler for event 6 completes, or by [[#Command 21: enable screen update|command 21]]. The handler is executed before actually updating the display.
 |}

@@ Line 93: / Line 93: @@
 *'''Arguments:''' ''id volume u1''
-Play tWAV resource ''id'' from the Mohawk archive containing the script. ''volume'' seems always 256, ''u1'' always 0. Ambient sounds are not touched; the sound is mixed over them.
+Play tWAV resource ''id'' from the Mohawk archive containing the script. ''volume'' seems always 256, ''u1'' always 0. This command has no effect on the active ambient sound group; the sound is mixed with the ambient sounds.
 ==Command 7: set variable value==

@@ Line 305: / Line 305: @@
 *'''Arguments:''' ''record''
-Activate the specified [[Riven SLST resources|SLST]] record. A SLST record describes an ambient sound group. The Riven engine can only have one active sound group at any given time (henceforth the "active ambient sound group"). This command sets the active ambient sound group to the specified SLST record. Appropriate fading in and fading out actions are taken based on the new SLST record's fade flags. Activating the active ambient sound group has no effect.
+Activate the specified [[Riven SLST resources|SLST]] record. A SLST record describes an ambient sound group. The Riven engine can only have one active sound group at any given time (henceforth the "active ambient sound group"). This command sets the active ambient sound group to the specified SLST record. Appropriate fading in and fading out actions are taken based on the SLST record's fade flags. Activating the active ambient sound group has no effect.
 ==Command 41==