[EFUM-commit] efum scripters reference.txt,1.11,1.12

[Daniel R. <dtr...@us...>]

Update of /cvsroot/efum/efum
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2064

Modified Files:
	scripters reference.txt 
Log Message:
add eatsucceeded/drinksucceeded doc

Index: scripters reference.txt
===================================================================
RCS file: /cvsroot/efum/efum/scripters reference.txt,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** scripters reference.txt	24 Jul 2004 15:06:31 -0000	1.11
--- scripters reference.txt	24 Jul 2004 18:13:18 -0000	1.12
***************
*** 14,17 ****
--- 14,19 ----
  CHAR->VictoryScript
  
+ For more details, read the Writer's References for each of the objects.
+ 
  All user commands are supported in these scripts, e.g. "drop", "go", etc.  For more information on these commands, see help.txt.
  
***************
*** 35,37 ****
  SAVEKEY - three parameters. records in a per-game INI file a particular value.  parameters are section, key and value; none may have spaces.  To clear a value, set it to %dne
  IFKEYIS - four parameters. retrieves from INI file a particular value, and executes another command if it matches.  parameters are section, key, value to compare, and command to execute (command may have spaces).  most flexible usage is like "ifkeyis 9 17 soup opened 1 exec soup_eat.escr"; comparing a saved value (opened, in the [soup] section) to a predetermined value (1), and running (exec) another script file (soup_eat.escr) if it matches.  If a value does not exist, %dne will be returned.
! IFHAS - two parameters. executes command (second parameter) if item named in first parameter is in the player's inventory.  e.g. "ifhas 9 17 c201floppy exec givepassword.escr" will give the password if the player has the floppy disk
\ No newline at end of file
--- 37,45 ----
  SAVEKEY - three parameters. records in a per-game INI file a particular value.  parameters are section, key and value; none may have spaces.  To clear a value, set it to %dne
  IFKEYIS - four parameters. retrieves from INI file a particular value, and executes another command if it matches.  parameters are section, key, value to compare, and command to execute (command may have spaces).  most flexible usage is like "ifkeyis 9 17 soup opened 1 exec soup_eat.escr"; comparing a saved value (opened, in the [soup] section) to a predetermined value (1), and running (exec) another script file (soup_eat.escr) if it matches.  If a value does not exist, %dne will be returned.
! IFHAS - two parameters. executes command (second parameter) if item named in first parameter is in the player's inventory.  e.g. "ifhas 9 17 c201floppy exec givepassword.escr" will give the password if the player has the floppy disk
! 
! Eat and drink scripts need to save a specific key in order to inform the EFUM engine that it's OK to remove the item eaten/drunk from the world.  Naturally, if you don't want the item to be removed, you don't need to save the item.  Normally the only situation in which the item should not be removed is if the player failed to eat or drink the item, e.g. they needed another item (canopener, straw...) to eat or drink it.
! For Eat Scripts:
! savekey 9 17 Flags EatSucceeded 1
! For Drink Scripts:
! savekey 9 17 Flags DrinkSucceeded 1
\ No newline at end of file