SCRIPT COMMANDS - Revision history

Brazil: /* Wait */

2011-09-23T13:24:49Z

Wait

← Older revision		Revision as of 13:24, 23 September 2011
Line 74:		Line 74:
	wait <number of ticks>t		wait <number of ticks>t

	This causes the script to pause for 75 seconds per number of ticks. (This does not cause it to trigger exactly when a tick happens. This is a throwback to before ticks were exactly counted with the event system).		This causes the script to pause for 75 seconds per number of ticks. (This does not cause it to trigger exactly when a tick happens. This is a throwback to before ticks were exactly counted with the event system and is now little more than abbreviation for x*75).

	==log==		==log==

Brazil: /* while */

2011-09-23T13:23:45Z

while

← Older revision		Revision as of 13:23, 23 September 2011
Line 109:		Line 109:
	==while==		==while==

	A while loop cannot exist in another while loop. It will just cause		A while loop cannot exist in another while loop (nested loops). It will just cause
	problems, and generally break the script.		problems, and generally break the script.

Brazil at 01:51, 7 December 2009

2009-12-07T01:51:01Z

← Older revision		Revision as of 01:51, 7 December 2009
Line 1:		Line 1:
	Built-in script commands are commands that are not called the way normal player commds are called. The commands below are valid in all types of scripts:		Built-in script commands are commands that are not called the way normal player commds are called. The commands below are valid in all types of scripts:

	A. Comment		==Comment==
	~~----------~~
	An '*' at the beginning of a line is a comment. The rest of the line is ignored.		An '*' at the beginning of a line is a comment. The rest of the line is ignored.

	* <text>		* <text>

	B. Global		==Global==
	~~---------~~
	Global changes a local variable into a global variable.		Global changes a local variable into a global variable.

	global <variable>		global <variable>

	C. Eval		==Eval==
	~~-------~~

	Eval evaluates the value and sets variable to result. See section 7 for details on how expression evaluation works.		Eval evaluates the value and sets variable to result. See section 7 for details on how expression evaluation works.
Line 25:		Line 23:
	sets the variable foobar to the value 10		sets the variable foobar to the value 10

			==If/elseif/else/end==

	~~D. If/elseif/else/end~~
	~~---------------------~~
	An 'if' must occur before the other three. If the expression evaluates to true (see section 7 for expression evaluation), the statements between the if statement and the next elseif, else, or end are executed. If it stopped at a elseif or else, it scans for the next end, and continues execution at that point. If the expression evaluated to false, it searches for the next elseif, else, or end. If it finds an elseif, it checks that expression. If it is true, it executes the statements between the elseif and the next elseif, else, or end, and then finds the end of the block. If it is false, it continues searching in the same pattern, until a true elseif is found, an else is found, or an end is found.		An 'if' must occur before the other three. If the expression evaluates to true (see section 7 for expression evaluation), the statements between the if statement and the next elseif, else, or end are executed. If it stopped at a elseif or else, it scans for the next end, and continues execution at that point. If the expression evaluated to false, it searches for the next elseif, else, or end. If it finds an elseif, it checks that expression. If it is true, it executes the statements between the elseif and the next elseif, else, or end, and then finds the end of the block. If it is false, it continues searching in the same pattern, until a true elseif is found, an else is found, or an end is found.

Line 38:		Line 35:
	end		end

			==Halt==

	~~E. Halt~~
	~~-------~~
	Halt ends the script execution.		Halt ends the script execution.

	halt		halt

			==Return==

	~~F. Return~~
	~~---------~~
	Return sets the return value of the script. Normally, a script will return 1, unless another return value is specified with the return command. Unlike most computer languages, the return command does not end the script's execution. The value is returned after all the commands have been executed, or a wait or halt command is called.		Return sets the return value of the script. Normally, a script will return 1, unless another return value is specified with the return command. Unlike most computer languages, the return command does not end the script's execution. The value is returned after all the commands have been executed, or a wait or halt command is called.

	return <value>		return <value>

			==Set==

	~~G. Set~~
	~~------~~
	Set sets the variable to value, without evaluating it.		Set sets the variable to value, without evaluating it.

Line 64:		Line 58:
	sets the varable foobar to the string "15 - 5"		sets the varable foobar to the string "15 - 5"

			==Unset==

	~~H. Unset~~
	~~--------~~
	Unset elimiates the specified variable if it exists.		Unset elimiates the specified variable if it exists.

	unset <variable>		unset <variable>

			== Wait==

	~~I. Wait~~
	~~-------~~
	A 'wait' command causes the script to pause for a certain length of time. A numerical argument causes the script to pause the given number of seconds.		A 'wait' command causes the script to pause for a certain length of time. A numerical argument causes the script to pause the given number of seconds.

Line 84:		Line 76:
	This causes the script to pause for 75 seconds per number of ticks. (This does not cause it to trigger exactly when a tick happens. This is a throwback to before ticks were exactly counted with the event system).		This causes the script to pause for 75 seconds per number of ticks. (This does not cause it to trigger exactly when a tick happens. This is a throwback to before ticks were exactly counted with the event system).

			==log==

	~~H. log~~
	~~--------~~
	Sends the string to syslog. The log saves to file, is logged under		Sends the string to syslog. The log saves to file, is logged under
	"syslog normal" at level AVATAR.		"syslog normal" at level AVATAR.
Line 98:		Line 89:
	That will syslog "The characters name is John."		That will syslog "The characters name is John."

			==switch==

	~~I. switch~~
	~~---------~~
	A switch/case block is a fairly well known method of programming.		A switch/case block is a fairly well known method of programming.

Line 117:		Line 107:
	done		done

			==while==

	~~J. while~~
	~~--------~~
	A while loop cannot exist in another while loop. It will just cause		A while loop cannot exist in another while loop. It will just cause
	problems, and generally break the script.		problems, and generally break the script.

Brazil at 01:47, 7 December 2009

2009-12-07T01:47:38Z

Show changes

Brazil at 01:43, 7 December 2009

2009-12-07T01:43:49Z

← Older revision		Revision as of 01:43, 7 December 2009
Line 1:		Line 1:
	Built-in script commands are commands that are not called the way normal		Built-in script commands are commands that are not called the way normal player commds are called. The commands below are valid in all types of scripts:
	player commds are called. The commands below are valid in all types of
	scripts:

	A. Comment		A. Comment
	----------		----------
	* <text>		* <text>
	An '*' at the begining of a line is a comment. The rest of the line is
	ignored.		An '*' at the begining of a line is a comment. The rest of the line is ignored.


Line 13:		Line 11:
	---------		---------
	global <variable>		global <variable>
	Global changes a local variable into a global variable.
			Global changes a local variable into a global variable.


Line 19:		Line 18:
	-------		-------
	eval <variable> <value>		eval <variable> <value>
	Eval evaluates the value and sets variable to result. See section 7 for
	details on how expression evaluation works.		Eval evaluates the value and sets variable to result. See section 7 for details on how expression evaluation works.

	Example: eval foobar 15 - 5		Example: eval foobar 15 - 5
	sets the varable foobar to the value 10		sets the varable foobar to the value 10
Line 34:		Line 34:
	...		...
	end		end
	An 'if' must occur before the other three. If the expression evaluates to
	true (see section 7 for expression evaluation), the statments between the		An 'if' must occur before the other three. If the expression evaluates to true (see section 7 for expression evaluation), the statments between the if statement and the next elseif, else, or end are executed. If it stopped at a elseif or else, it scans for the next end, and continues execution at that point. If the expression evaluated to false, it searches for the next elseif, else, or end. If it finds an elseif, it checks that expression. If it is true, it executes the statements between the elseif and the next elseif, else, or end, and then finds the end of the block. If it is false, it continues searching in the same pattern, until a true elseif is found, an else is found, or an end is found.
	if statement and the next elseif, else, or end are executed. If it
	stopped at a elseif or else, it scans for the next end, and continues
	execution at that point. If the expression evaluated to false, it
	searches for the next elseif, else, or end. If it finds an elseif, it
	checks that expression. If it is true, it executes the statements between
	the elseif and the next elseif, else, or end, and then finds the end of
	the block. If it is false, it continues searching in the same pattern,
	until a true elseif is found, an else is found, or an end is found.


Line 49:		Line 41:
	-------		-------
	halt		halt
	Halt ends the script execution.
			Halt ends the script execution.


Line 55:		Line 48:
	---------		---------
	return <value>		return <value>
	Return sets the return value of the script. Normally, a script will return
	1, unless another return value is specified with the return command.		Return sets the return value of the script. Normally, a script will return 1, unless another return value is specified with the return command. Unlike most computer langauges, the return command does not end the script's execution. The value is returned after all the commands have been executed, or a wait or halt command is called.
	Unlike most computer langauges, the return command does not end the
	script's execution. The value is returned after all the commands have
	been executed, or a wait or halt command is called.


Line 65:		Line 55:
	------		------
	set <variable> <value>		set <variable> <value>
	Set sets the variable to value, without evaluating it.
			Set sets the variable to value, without evaluating it.

	Example: set foobar 15 - 5		Example: set foobar 15 - 5
	sets the varable foobar to the string "15 - 5"		sets the varable foobar to the string "15 - 5"
Line 73:		Line 65:
	--------		--------
	unset <variable>		unset <variable>
	Unset elimiates the specified variable if it exists.
			Unset elimiates the specified variable if it exists.


Line 80:		Line 73:
	wait <number of seconds>		wait <number of seconds>

	A 'wait' command causes the script to pause for a certain length of time.		A 'wait' command causes the script to pause for a certain length of time. A numerical argument causes the script to pause the given number of seconds.
	A numerical argument causes the script to pause the given number of
	seconds.

	wait <number of ticks>t		wait <number of ticks>t

	This causes the script to pause for 75 seconds per number of ticks.		This causes the script to pause for 75 seconds per number of ticks. (This does not cause it to trigger exactly when a tick happens. This is a throwback to before ticks were eactly counted with the event system).
	(This does not cause it to trigger exactly when a tick happens. This is a
	throwback to before ticks were eactly counted with the event system).

	H. log		H. log
Line 95:		Line 84:
	log <somestring>		log <somestring>

	Sends the string to syslog. The log saves to file, is logged under		Sends the string to syslog. The log saves to file, is logged under
	"syslog normal" at level AVATAR.		"syslog normal" at level AVATAR.

	You can log values. I.e.		You can log values. I.e.

	log The characters name is %actor.name%.		log The characters name is %actor.name%.

	That will syslog "The characters name is John."		That will syslog "The characters name is John."


Line 119:		Line 108:
	done		done

	A switch/case block is a fairly well known method of programming.		A switch/case block is a fairly well known method of programming.
	TODO: more detailed explaination to be added.
			TODO: more detailed explaination to be added.

	J. while		J. while
Line 133:		Line 123:
	done		done

	A while loop cannot exist in another while loop. It will just cause		A while loop cannot exist in another while loop. It will just cause
	problems, and generally break the script.		problems, and generally break the script.

	SEE ALSO: [[MOBCMDS]], [[OBJCMDS]], [[ROOMCMDS]], [[VARIABLES]]		SEE ALSO: [[MOBCMDS]], [[OBJCMDS]], [[ROOMCMDS]], [[VARIABLES]]

	[[CATEGORY:Scripts]]		[[CATEGORY:Scripts]]

Kahlan at 10:49, 20 November 2008

2008-11-20T10:49:23Z

← Older revision		Revision as of 10:49, 20 November 2008
Line 136:		Line 136:
	problems, and generally break the script.		problems, and generally break the script.

	SEE ALSO: MOBCMDS, OBJCMDS, ROOMCMDS, VARIABLES		SEE ALSO: [[MOBCMDS]], [[OBJCMDS]], [[ROOMCMDS]], [[VARIABLES]]

			[[CATEGORY:Scripts]]

Kahlan at 10:48, 20 November 2008

2008-11-20T10:48:43Z

Kahlan at 10:47, 20 November 2008

2008-11-20T10:47:57Z

← Older revision		Revision as of 10:47, 20 November 2008
Line 34:		Line 34:
	...		...
	end		end
	An 'if' must occur before the other three. If the expression evaluates to		An 'if' must occur before the other three. If the expression evaluates to
	true (see section 7 for expression evaluation), the statments between the		true (see section 7 for expression evaluation), the statments between the
	if statement and the next elseif, else, or end are executed. If it		if statement and the next elseif, else, or end are executed. If it

Kahlan at 10:47, 20 November 2008

2008-11-20T10:47:30Z

Show changes

Kahlan: New page: Built-in script commands are commands that are not called the way normal player commds are called. The commands below are valid in all types of scripts: A. Comment ---------- * A...

2008-11-20T10:43:57Z

New page: Built-in script commands are commands that are not called the way normal player commds are called. The commands below are valid in all types of scripts: A. Comment ---------- * <text> A...

New page

Built-in script commands are commands that are not called the way normal
player commds are called. The commands below are valid in all types of
scripts:

A. Comment
----------
* <text>

An '*' at the begining of a line is a comment. The rest of the line is
ignored.

B. Global
---------
global <variable>

Global changes a local variable into a global variable.

C. Eval
-------
eval <variable> <value>

Eval evaluates the value and sets variable to result. See section 7 for
details on how expression evaluation works.
Example: eval foobar 15 - 5
sets the varable foobar to the value 10

D. If/elseif/else/end
---------------------
if (<expression>)
...
elseif (<expression>)
...
else
...
end

An 'if' must occur before the other three. If the expression evaluates to
true (see section 7 for expression evaluation), the statments between the
if statement and the next elseif, else, or end are executed. If it
stopped at a elseif or else, it scans for the next end, and continues
execution at that point. If the expression evaluated to false, it
searches for the next elseif, else, or end. If it finds an elseif, it
checks that expression. If it is true, it executes the statements between
the elseif and the next elseif, else, or end, and then finds the end of
the block. If it is false, it continues searching in the same pattern,
until a true elseif is found, an else is found, or an end is found.

E. Halt
-------
halt

Halt ends the script execution.

F. Return
---------
return <value>

Return sets the return value of the script. Normally, a script will return
1, unless another return value is specified with the return command.
Unlike most computer langauges, the return command does not end the
script's execution. The value is returned after all the commands have
been executed, or a wait or halt command is called.

G. Set
------
set <variable> <value>

Set sets the variable to value, without evaluating it.
Example: set foobar 15 - 5
sets the varable foobar to the string "15 - 5"

H. Unset
--------
unset <variable>

Unset elimiates the specified variable if it exists.

I. Wait
-------
wait <number of seconds>

A 'wait' command causes the script to pause for a certain length of time.
A numerical argument causes the script to pause the given number of
seconds.

wait <number of ticks>t

This causes the script to pause for 75 seconds per number of ticks.
(This does not cause it to trigger exactly when a tick happens. This is a
throwback to before ticks were eactly counted with the event system).

H. log
--------
log <somestring>

Sends the string to syslog. The log saves to file, is logged under
"syslog normal" at level AVATAR.

You can log values. I.e.

log The characters name is %actor.name%.

That will syslog "The characters name is John."

I. switch
---------
switch <statement>
case <instance>
...
break
case <instance>
case <instance>
...
break
default
...
done

A switch/case block is a fairly well known method of programming.
TODO: more detailed explaination to be added.

J. while
--------
while (%x% < 5)
eval x (%x% + 1)
if (%x% == 2)
if (yet something else again)
break
end
end
done

A while loop cannot exist in another while loop. It will just cause
problems, and generally break the script.

SEE ALSO: MOBCMDS, OBJCMDS, ROOMCMDS, VARIABLES

← Older revision		Revision as of 10:48, 20 November 2008
Line 34:		Line 34:
	...		...
	end		end
	An 'if' must occur before the other three. If the expression evaluates to		An 'if' must occur before the other three. If the expression evaluates to
	true (see section 7 for expression evaluation), the statments between the		true (see section 7 for expression evaluation), the statments between the
	if statement and the next elseif, else, or end are executed. If it		if statement and the next elseif, else, or end are executed. If it
	stopped at a elseif or else, it scans for the next end, and continues		stopped at a elseif or else, it scans for the next end, and continues
	execution at that point. If the expression evaluated to false, it		execution at that point. If the expression evaluated to false, it
	searches for the next elseif, else, or end. If it finds an elseif, it		searches for the next elseif, else, or end. If it finds an elseif, it
	checks that expression. If it is true, it executes the statements between		checks that expression. If it is true, it executes the statements between
	the elseif and the next elseif, else, or end, and then finds the end of		the elseif and the next elseif, else, or end, and then finds the end of
	the block. If it is false, it continues searching in the same pattern,		the block. If it is false, it continues searching in the same pattern,
	until a true elseif is found, an else is found, or an end is found.		until a true elseif is found, an else is found, or an end is found.


Line 56:		Line 56:
	return <value>		return <value>
	Return sets the return value of the script. Normally, a script will return		Return sets the return value of the script. Normally, a script will return
	1, unless another return value is specified with the return command.		1, unless another return value is specified with the return command.
	Unlike most computer langauges, the return command does not end the		Unlike most computer langauges, the return command does not end the
	script's execution. The value is returned after all the commands have		script's execution. The value is returned after all the commands have
	been executed, or a wait or halt command is called.		been executed, or a wait or halt command is called.


Line 84:		Line 84:
	seconds.		seconds.

	wait <number of ticks>t		wait <number of ticks>t

	This causes the script to pause for 75 seconds per number of ticks.		This causes the script to pause for 75 seconds per number of ticks.
	(This does not cause it to trigger exactly when a tick happens. This is a		(This does not cause it to trigger exactly when a tick happens. This is a
	throwback to before ticks were eactly counted with the event system).		throwback to before ticks were eactly counted with the event system).

	H. log		H. log