The Players Corner Archive

TIP #001 Glossary of Script Commands

Command {Syntax} Description
Key: # - number
$ = string (numbers and letters)
x = variable {%c, %s,%1,%user0, etc..)


command line variable {.script $,$,..}
variables defined on the command line. denoted by %# were # is 0-9{like %1) ; 0 being the entire command line.
Used With: Goto, Match, Waitfor, Echo, Save

counter variable {%c}
A numerical variable.
Multiple uses, used mainly for going through a sequence of rooms in hunting scripts.
Used With: Goto, Match, Waitfor, Echo, Save
see also: Counter Set, Counter Add

counter add {counter add}
Increases the value of the counter by 1

counter set {counter set #}
Replaces the current counter value with #.

echo {echo $}
"Echo"'s a string back to the text window.
Used for debuging, credits, or selection menu's.

exit {exit}
Terminates the script.
May have multiple exits in a program.

goto {goto $}
Goes to a line label
see also: Line Label, labelerror:

if_ {if_# goto $}
Checks for the presence of a command line variable (%1-%9). If it is present, the action is done, if not, then the line is ignored. Note: 0% is the entire command line.
see also: Command Line Variable

labelerror: {goto $[invalid]}
when you issue a goto $, and $: does not exist the script engine will run a check for this line label and goto it. a nice catch all for errors. can be used constructively also.

quote:

Example

start:
Goto room%c

labelerror:
counter set 1
goto start


linelabel {$:}
A marker for the script engine.

match {match linelabel $)
If $ is "found" in wizard text, this command goes to linelabel. 32 possible matches availible to use before a matchwait must be issued.
Used With: Matchwait
see also: Matchwait

matchwait {matchwait}
Forces the script engine to wait for a match to be found. The staple to all "smart" hunting scripts, and along with match, the most powerful tool for scripting.

quote:

Example
match khouse You see kelood's house
match run You see a stinky insomniac
match fight You see Chivalrous
matchwait

khouse:
put go door
exit
run:
put n
exit
fight:
put at chiv
exit


move {move [direction]}
moves in the stated direction and waits for the room description before proceding. A combination of put and nextroom.

nextroom {nextroom}
waits for a room description. nearly useless with the implementation of the move command, but its availible to you, so its worth mentioning. if you can find a use for it, let me know

pause {pause #}
pauses for # seconds, will take decimals, though they seem not to matter below .5, it might have to do with your connection speed.

put {put $ }
sends $ to the game. if $ happens to be a command , your in luck.

save {save $}
replaces the contents of the save variable with $
NOTE: if $ is a space {typing save then presing the space bar twice}, it will cuase the wizard front end to do an illegal operation. Have fun logging back in...
Nice trick to pull on your buddy, "hey kranar, try this new script i made"
Used With: Same as Counter
see also: Save variable

save variable {%s}
A string variable. Be careful with this one, the fact that it can be both a string or a mumeric variable can get you into trouble.

shift {shift}
"shifts" the command line variables over 1. %1 becomes %2, %2 becomes %3, etc. Used for going through all the command line variables with fewer code.

wait {wait}
waits for the command prompt. Used after a command so that you will not get a type ahead line error. if the command prompt is already issued to you, someone moving into the room, or pressing enter will trigger it. you can also get this effect by placing 2 waits in a row after a command. this could prove useful in certain circumstances.

waitfor {waitfor $}
a combination of match and wait. it acts like a wait, though only goes on if it matches $. more reliable then wait, especially when actions do not give up the command prompt.

wizard variables {%user#,%sheath,..}
variables found in the wizard menu.
configuration-options-variables.


hopefully that covers it, though im sure insomniac will point out at least one omission.

If something is unclear/typo, post or give me an email and i will try to correct it.


[there should be an underscore between if and # in that command, but it will not pick it up]

------------------
'lood


[This message has been edited by kelood (edited 01-29-2001).] reg

Very nice indeed Kelood. I am indeed impressed.

Only command that came to mind straight away was AddToHighlightStrings... But it very rarely gets used.

I've just today uploaded my own Scripting site, would it be alright if I used this 'glossary' on there? Of course, full credit will be given to you

-=Insomniac=-

[This message has been edited by Insomniac (edited 01-29-2001).] reg

don't mind at all.

------------------
'lood reg

That glossary rocks! Shows all the script commands that the Wizard FE doesn't.

Good stuff man...

- Lord Kranar, human Archwizard reg

I hate you! I used both move and nextroom commands...duh! I am not even going to tell you what I thought the difference was....

But, my scripts run really well though!

edge
reg

Show me the post!!! reg
I dunno how it knows or works but... Nextroom and move have one MAJOR differance I got a script from icemule to landing and landing to icemule just like everyone else but before I had the fancy one I made one my self with nextroom the cool thing about it was if you somehow fell behind in the script say it tried to go again for who knows why while you fell you could just do a look to make it think you moved worked really well to catch up with the script on the trip tell me whatcha think...

Mano reg