Riven external commands - Revision history

Clone2727: found an "xtatboundary" external command in the demo

2008-09-03T02:03:00Z

found an "xtatboundary" external command in the demo

Clone2727: found another demo-only external command

2008-08-21T20:18:18Z

found another demo-only external command

Clone2727: adding demo and DVD specific external commands

2008-07-14T17:06:46Z

adding demo and DVD specific external commands

TitoDalCanton: intro things

2008-04-05T10:04:50Z

intro things

TitoDalCanton: /* beetle things */

2008-04-04T21:21:21Z

‎beetle things

TitoDalCanton: /* o_Data */

2008-03-28T16:13:43Z

‎o_Data

TitoDalCanton: /* xjplaybeetle_550() */

2008-03-27T23:37:47Z

‎xjplaybeetle_550()

TitoDalCanton: /* xjtunnel105_pictfix(), xjtunnel106_pictfix(), xjtunnel104_pictfix() */

2008-03-27T23:29:55Z

‎xjtunnel105_pictfix(), xjtunnel106_pictfix(), xjtunnel104_pictfix()

TitoDalCanton: /* xjtunnel_pictfix /

2008-03-27T23:27:50Z

‎xjtunnel*_pictfix

TitoDalCanton: /* xicon*/

2008-03-27T23:25:42Z

‎xicon

← Older revision		Revision as of 02:03, 3 September 2008
Line 236:		Line 236:
	====xtisland5056_slidermd(), xtisland5056_slidermw()====		====xtisland5056_slidermd(), xtisland5056_slidermw()====
	Both called by an hotspot laid over the whole dome slider, in its mouse down and mouse within handlers respectively (card 386). They must track mouse movements, play the ticking sound, set the slider value accordingly and enable/disable the two hotspots laid over the dome button if the combo is correct or incorrect.		Both called by an hotspot laid over the whole dome slider, in its mouse down and mouse within handlers respectively (card 386). They must track mouse movements, play the ticking sound, set the slider value accordingly and enable/disable the two hotspots laid over the dome button if the combo is correct or incorrect.
		+	====xtatboundary()====
		+	''Demo Only:'' Called when reaching the end of the demo.

@@ Line 25: / Line 25: @@
 ====xadisablemenureturn(), xaenablemenureturn()====
 ''Demo Only:'' Called to allow you to return to the main menu from the game.
 ==b_Data==

@@ Line 21: / Line 21: @@
 ====xtrapbookback(), xatrapbookclose(), xatrapbookopen()====
 Called when clicking hotspots in the trap book card.
 ==b_Data==
@@ Line 149: / Line 153: @@
 ====xschool280_playwhark()====
 Called when using the whark toy in the school (card 769). It must take care of playing the correct movies and all. Apparently it uses the [[Riven_variables#jwharkpos|jwharkpos]] variable to know the toy position.
 ==o_Data==

@@ Line 2: / Line 2: @@
 Riven scripts make use of "external commands" to perform complex actions. External commands are code blocks living outside Mohawk files (hence "external"); probably they are part of the engine executable itself. Many complex devices in the game are implemented with external commands (for example the domes and the fire marbles puzzle); this is bad news because no reverse-engineering can be done on them easily. An alternative engine would have to implement custom code for those devices.
-This is the first step in understanding the role of each external command. This list has been put together by looking into NAME 3 resources, which store external command names used within each stack. Arguments have been found or guessed by reading scripts.
+This page tries to clarify the role of each external command. It was put initially together by looking into NAME 3 resources, which store external command names used within each stack. Arguments and role of each external command were found or guessed by reading scripts.
 Each command is reported in a way similar to C functions: command_name(argument1, argument2...). Names without trailing '()' have not yet been investigated.

@@ Line 95: / Line 95: @@
 ====xflies(u0, u1)====
 See [[#xflies.28u0.2C_u1.29|g_Data]].
-;xjplaybeetle_600
-;xjplaybeetle_950
+====xjplaybeetle_600(), xjplaybeetle_950()====
-;xjtunnel103_pictfix
+Called in the load handler for card 66 and 82 respectively. Seems to just set jplaybeetle to 1 when the card beetle movie is to be played.
 ====xreseticons()====
@@ Line 108: / Line 108: @@
 Called by hotspots in cards belonging to the rebel puzzle icons (e.g. 217, 220, 221, 222...). Maybe ''a'' is an icon ID.
-====xjtunnel105_pictfix(), xjtunnel106_pictfix(), xjtunnel104_pictfix()====
+====xjtunnel103_pictfix(), xjtunnel105_pictfix(), xjtunnel106_pictfix(), xjtunnel104_pictfix()====
-Called by display update handlers for cards 216, 219 and 229 respectively. Probably they "fix" the picture by drawing the pressed icons.
+Called by display update handlers for cards 215, 216, 219 and 229 respectively. Probably they "fix" the picture by drawing the pressed icons.
 ====xvga1300_carriage()====
@@ Line 135: / Line 135: @@
 Apparently, the algorithm is triggered by a single mouse movement, directed towards the top.
-====xjplaybeetle_1450()====
+====xjplaybeetle_1450(), xjplaybeetle_1050(), xjplaybeetle_550()====
-Called in the load handler for card 372.
+Called in the load handler for card 372, 408 and 68 respectively. Seem to just set jplaybeetle to 1 when the associated card beetle movie is to be played.
-−
-====xjplaybeetle_1050()====
 Called in the load handler for card 408.
-−
-====xjplaybeetle_550()====
-Called in the load handler for card 68.
 ====xjlagoon700_alert()====

@@ Line 157: / Line 157: @@
 ==o_Data==
-;xorollcredittime()
+====xorollcredittime()====
-;xooffice30_closebook()
+Called in the open handler for card 9. Probably it handles the final scrolling credits.
-;xbookclick(movie_sref, start_time, end_time, u0)
-;xobedroom5_closedrawer()
+====xooffice30_closebook()====
-;xogehnopenbook()
+Triggered by hotspots in card 35. It must play the closing book movie. Why an external for this?
-;xogehnbookprevpage()
-;xogehnbooknextpage()
+====xbookclick(movie_sref, start_time, end_time, u0)====
-;xgwatch()
+Used in the open handler for card 2, with different parameters depending on the value of variables agehn and atrapbook. Maybe it handles clicks in the trap book while Gehn is holding it. ''start_time'' and ''end_time'' are large numbers, which I believe are milliseconds indicating when to listen for clicks. ''u0'' may indicate one of the card hotspots.
 ==p_Data==

@@ Line 102: / Line 102: @@
 Called by an hotspot in card 191. Probably it resets the rebel puzzle icons.
-;xicon
+====xicon(''a'')====
 ====xcheckicons(), xtoggleicon(''a'')====