AddictHelp - User contributions [en]

VARIABLES

2008-11-20T11:01:05Z

Kahlan:

Variables appear as a name surrounded by '%'s, such as

%actor%

Before a command is processed, the line is scanned and any variables are
replaced. First the list of local variables are checked to see if it is
there. If not, the global variables are checked. If a match is still not
found, a list of 'built in' variables (ones not declared by the script) are
checked. If no match is found, the variable is replaced with an empty
string (the variable is removed from the line, and nothing added in its
place).

Two '%'s in a row will be interpreted as a single '%'.

There are two types of variables, local and global. All local variables
are deleted when a script finishes executing, and can only be used by the
script. Global variables remain until removed with unset, or the script is
removed.

A field of a variable can also retrieved, based on their type. To get a
field, a notation of %variable.field% is used. The valid fields for each
type of game object are listed below.

Variables are case insensitive.

See also: [[CHARACTER VARIABLES]], [[ROOM VARIABLES]], [[OBJECT VARIABLES]],
[[SPECIAL VARIABLES]]

[[CATEGORY:Scripts]]

VARIABLES

2008-11-20T11:00:30Z

Kahlan: New page: Variables appear as a name surrounded by '%'s, such as %actor% Before a command is processed, the line is scanned and any variables are replaced. First the list o...

Variables appear as a name surrounded by '%'s, such as

%actor%

Before a command is processed, the line is scanned and any variables are
replaced. First the list of local variables are checked to see if it is
there. If not, the global variables are checked. If a match is still not
found, a list of 'built in' variables (ones not declared by the script) are
checked. If no match is found, the variable is replaced with an empty
string (the variable is removed from the line, and nothing added in its
place).

Two '%'s in a row will be interpreted as a single '%'.

There are two types of variables, local and global. All local variables
are deleted when a script finishes executing, and can only be used by the
script. Global variables remain until removed with unset, or the script is
removed.

A field of a variable can also retrieved, based on their type. To get a
field, a notation of %variable.field% is used. The valid fields for each
type of game object are listed below.

Variables are case insensitive.

See also: CHARACTER VARIABLES, ROOM VARIABLES, OBJECT VARIABLES,
SPECIAL VARIABLES

SPELLFLAGS

2008-11-20T10:59:42Z

Kahlan:

Spell scripts do not use flags. Flags typically determine when/how a
script is triggered. Since spell scripts only have one way to be
triggered, it behaves pretty simply.

Description: This script is called when the spell it is attached
to is cast.

NArg: unused.

Return value: If the return value is 0, the spell casting is continued
by the mud's code. If the return value is 1, only the script is
executed.

Variables:
%caster% will be set to the person casting the spell.
%victim% is set to the victim of the spell (if there is one).
%object% is set to the the object the spell is cast on (if there is one).
%spellnum% is the internal number of the spell.
%spellname% is the name of the spell.
%learned% is how well the spell has been practiced.

[[CATEGORY:Scripts]]

SPELLFLAGS

2008-11-20T10:59:27Z

Kahlan:

SPELLFLAGS

2008-11-20T10:58:51Z

Kahlan: New page: Spell scripts do not use flags. Flags typically determine when/how a script is triggered. Since spell scripts only have one way to be triggered, it behaves pretty simply. Description: ...

Spell scripts do not use flags. Flags typically determine when/how a
script is triggered. Since spell scripts only have one way to be
triggered, it behaves pretty simply.

Description: This script is called when the spell it is attached
to is cast.
NArg: unused.
Return value: If the return value is 0, the spell casting is continued
by the mud's code. If the return value is 1, only the script is
executed.
Variables:
%caster% will be set to the person casting the spell.
%victim% is set to the victim of the spell (if there is one).
%object% is set to the the object the spell is cast on (if there is one).
%spellnum% is the internal number of the spell.
%spellname% is the name of the spell.
%learned% is how well the spell has been practiced.

SPELLCMDS

2008-11-20T10:58:12Z

Kahlan:

Object Commands

Spellscripts alone can use the following commands.

secho <message>
Oecho sends the message to everyone awake in the same room as the
object. If the object is equiped or carried by someone or in
something, the message is sent to the room the person or object is
in.

sechoaround <victim> <message>
This sends the message to everyone in the room, except for the victim
and the mob.

sasound <victim> <message>
This command sends a message to every room connected to the room
<victim> is in.

scmd <victim> <command>
The object forces the victim to perform the command.
Immortals are affected by this command. No message is set to the
character, except what is caused by the command performed.

ssend <victim> <message>
The victim of osend gets the message.

steleport <victim> <target>
Steleport moves the victim to the target. The victim does not need
to be in the same room as the object. If the victim is 'all', all
the characters in the room will be teleported to the target room.
No messages are generated by this command.

sgoto <target>
Sgoto sends the CASTER to the specified location, as if the caster
had typed the immortal GOTO command.

sdamage <victim> <amount>
Causes the <amount> of damage to be done to the <victim>. The only
time a message is displayed is if the victim receives a LOT of
damage, or they are BLEEDING or about do die.

szecho <message>
Szecho causes the spell to echo something to the entire zone.

SEE ALSO: [[SCRIPT_COMMANDS]], [[VARIABLES]]

[[CATEGORY:Scripts]]

SPELLCMDS

2008-11-20T10:57:59Z

Kahlan:

Object Commands
------------------
Spellscripts alone can use the following commands.

secho <message>
Oecho sends the message to everyone awake in the same room as the
object. If the object is equiped or carried by someone or in
something, the message is sent to the room the person or object is
in.

sechoaround <victim> <message>
This sends the message to everyone in the room, except for the victim
and the mob.

sasound <victim> <message>
This command sends a message to every room connected to the room
<victim> is in.

scmd <victim> <command>
The object forces the victim to perform the command.
Immortals are affected by this command. No message is set to the
character, except what is caused by the command performed.

ssend <victim> <message>
The victim of osend gets the message.

steleport <victim> <target>
Steleport moves the victim to the target. The victim does not need
to be in the same room as the object. If the victim is 'all', all
the characters in the room will be teleported to the target room.
No messages are generated by this command.

sgoto <target>
Sgoto sends the CASTER to the specified location, as if the caster
had typed the immortal GOTO command.

sdamage <victim> <amount>
Causes the <amount> of damage to be done to the <victim>. The only
time a message is displayed is if the victim receives a LOT of
damage, or they are BLEEDING or about do die.

szecho <message>
Szecho causes the spell to echo something to the entire zone.

SEE ALSO: [[SCRIPT_COMMANDS]], [[VARIABLES]]

[[CATEGORY:Scripts]]

SPELLCMDS

2008-11-20T10:57:44Z

Kahlan: New page: Object Commands ------------------ Spellscripts alone can use the following commands. secho <message> Oecho sends the message to everyone awake in the same room as the ...

SPECIAL VARIABLES

2008-11-20T10:56:29Z

Kahlan:

For details on how to use variables, please see the schelp for VARIABLES.

Special variables are as follows:
=================================
self - the mob, item, or room running the script. Normal fields may also
be used.
random - This variable returns a number between 1 and the field value.
For example, %random.10% would be a value between 1 and 10.
Also, for random, there is an option for %random.char% that will
return a random character in the room the script is being run in.
people - this variable returns a random person in a room vnum that you
specify. i.e. %people.3001% will return a random person sitting
in room 3001.

Special Notes on any variable that is a string (not a number). They have 6
special abilities to allow you to efficiently handle strings.

1. First, you can retrieve the length of a string by using:
%somestring.strlen%

2. You can see if a string contains another string by doing:
%somestring.contains(searchstring)%

3. If you want to make sure there are no blank spaces at the front or end
of the string, you can remove them by doing:
set newstring %somestring.trim%

4. If you want to know if a string is the abbreviation of another string
you can check by doing:
if (%somestring.isabbrev(north)%)
...
end

5. If you need just the first word in a sentence, you can retrieve it by
doing:
set oneword %somestring.car%

6. And finally, to get a string, without the first word, you would do:
set setstring %somestring.cdr%

[[CATEGORY:Scripts]]

SPECIAL VARIABLES

2008-11-20T10:56:08Z

Kahlan:

SPECIAL VARIABLES

2008-11-20T10:55:42Z

Kahlan: New page: For details on how to use variables, please see the schelp for VARIABLES. Special variables are as follows: ================================= self - the mob, item, or room running the scr...

SETTING

2008-11-20T10:54:46Z

Kahlan:

To set a script on a mob/obj/room, you must edit that mob/obj or script with
the appropriate olc command (medit, redit, oedit), then use the "?set"
command to assign the script (mset, rset, oset).

i.e. "oset script 1200"

will assign script vnum 1200 to the object currently being edited if it has
not already been assigned. If the script specified has been assigned, this
will remove it, and you will get a message indicating what it's doing.

You can assign more then one script to a mob/obj/room, and using 'global'
variables, they can effectivly interact.

[[CATEGORY:Scripts]]

SETTING

2008-11-20T10:54:29Z

Kahlan: New page: To set a script on a mob/obj/room, you must edit that mob/obj or script with the appropriate olc command (medit, redit, oedit), then use the "?set" command to assign the script (mset, rset...

SCSTAT

2008-11-20T10:53:49Z

Kahlan: New page: SCSTAT basically 'stats' the script you are in the process of editing. It shows you the type, the flags, narg, arglist, and the actual 'code'. SEE ALSO: SCSET, SCEDIT [[CATEGOR...

SCSTAT basically 'stats' the script you are in the process of editing. It
shows you the type, the flags, narg, arglist, and the actual 'code'.

SEE ALSO: [[SCSET]], [[SCEDIT]]

[[CATEGORY:Scripts]]

SCSET

2008-11-20T10:52:49Z

Kahlan:

SCSET is the command that actually manipulates all the details of a script.
You must first start editing a script with SCEDIT before SCSET will do you
any good. The things you can/need to change are partly dependant on the
SCRIPT_TYPE, as well as the flags.

SCSET without any arguments will show you a list of usage.

scset name <name of script> (sets the name of the script. This may
eventually be used if a "vnum script" is
coded)
scset arglist <arglist> (dependant on the script type/flags)
scset narg <value> (dependant on the script type/flags)
scset type <mob|obj|room> (what will this script be assigned to)
scset flags <flags> (toggles flags on/off)
scset code (edit the actual script)

SEE ALSO: [[SCSTAT]], [[SCEDIT]], [[MOBFLAGS]], [[OBJFLAGS]], [[ROOMFLAGS]], [[ROOMCMDS]], [[MOBCMDS]],
[[OBJCMDS]], [[SCRIPT COMMANDS]], [[EXPRESSIONS]], [[VARIABLES]], [[SCRIPT TYPES]]

[[CATEGORY:Scripts]]

SCSET

2008-11-20T10:51:57Z

Kahlan: New page: SCSET is the command that actually manipulates all the details of a script. You must first start editing a script with SCEDIT before SCSET will do you any good. The things you can/need to...

SCSET is the command that actually manipulates all the details of a script.
You must first start editing a script with SCEDIT before SCSET will do you
any good. The things you can/need to change are partly dependant on the
SCRIPT_TYPE, as well as the flags.

SCSET without any arguments will show you a list of usage.

scset name <name of script> (sets the name of the script. This may
eventually be used if a "vnum script" is
coded)
scset arglist <arglist> (dependant on the script type/flags)
scset narg <value> (dependant on the script type/flags)
scset type <mob|obj|room> (what will this script be assigned to)
scset flags <flags> (toggles flags on/off)
scset code (edit the actual script)

SEE ALSO: SCSTAT, SCEDIT, MOBFLAGS, OBJFLAGS, ROOMFLAGS, ROOMCMDS, MOBCMDS,
OBJCMDS, SCRIPT COMMANDS, EXPRESSIONS, VARIABLES, SCRIPT TYPES

SCRIPT TYPES

2008-11-20T10:51:13Z

Kahlan: New page: script types are basically what type of script it is. It referres to wether the script is a mob, room, or object script. Use the command "scset type <type>" to set what type of scri...

script types are basically what type of script it is. It referres to
wether the script is a mob, room, or object script.

Use the command

"scset type <type>" to set what type of script it is.

When this is set, the flags are all removed.

[[CATEGORY:Scripts]]

SCRIPT FLAGS

2008-11-20T10:50:23Z

Kahlan: New page: SEE: MOBFLAGS, ROOMFLAGS, OBJFLAGS CATEGORY:Scripts

SEE: [[MOBFLAGS]], [[ROOMFLAGS]], [[OBJFLAGS]]

[[CATEGORY:Scripts]]

SCRIPT COMMANDS

2008-11-20T10:49:23Z

Kahlan:

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]]

[[CATEGORY:Scripts]]

SCRIPT COMMANDS

2008-11-20T10:48:43Z

Kahlan:

SCRIPT COMMANDS

2008-11-20T10:47:57Z

Kahlan:

SCRIPT COMMANDS

2008-11-20T10:47:30Z

Kahlan:

SCRIPT COMMANDS

2008-11-20T10:43:57Z

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 ---------- * <text> A...

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

SCEDIT

2008-11-20T10:43:11Z

Kahlan:

SCEDIT is the basic 'begining' command to start editing a script. You can
create new scripts, as well as edit existing scripts (providing you have
access to the zone the script is in).

The arguments are:

scedit save (saves the script you are currently working on)
scedit <vnum> (edit script number <vnum>)
scedit create (create a new script that belongs to the zone you are
standing in)
scedit done (stop editing the script you are working on)

SEE ALSO: [[SCSET]], [[SCSTAT]]

[[CATEGORY:Scripts]]

SCEDIT

2008-11-20T10:42:40Z

Kahlan: New page: SCEDIT is the basic 'begining' command to start editing a script. You can create new scripts, as well as edit existing scripts (providing you have access to the zone the script is in). T...

SCEDIT is the basic 'begining' command to start editing a script. You can
create new scripts, as well as edit existing scripts (providing you have
access to the zone the script is in). The arguments are:

scedit save (saves the script you are currently working on)
scedit <vnum> (edit script number <vnum>)
scedit create (create a new script that belongs to the zone you are
standing in)
scedit done (stop editing the script you are working on)

SEE ALSO: SCSET, SCSTAT

ROOMFLAGS

2008-11-20T10:41:34Z

Kahlan:

Flags determine how/when the script is called/triggered.
NOTE: All scripts have a %self% variable, that represent that ROOM that the
script is assigned to.

Global
Description: This is not a script by itself, but is used with another
script type. A script which is Global is checked even if there are
no PCs in the zone.

Random
Description: This script is checked periodically (currrently every 13
seconds, but may be changed). The script is not checked if there is
no PC in the same zone as the room, unless the Global flag is set
(see above).
NArg: The chance this script will run when it is checked.

Command
Description: This script is checked whenever a character types an
invalid command, or a command which usually results in a 'Sorry, but
you cannot do that here!' message, in the room with this script. If
the command typed is a substring of the argument, the script is
called.
Argument: The command name.
Return value: If 0 is returned by the script, the character will
receive the same message as if the script did not exist.
Variables:
%actor% is set to the character typing the command.
%arg% is set to the argument of the command.
%cmd% is the command that the actor typed.

Speech
Description: This script is checked whenever someone says something in
the room. If NArg is 0, the script checks to see if Argument is a
substring of what was said. If NArg is 1, the script checks to see
if any word in Argument matches a word of what was said to see if the
script should be called.
Argument: The phrase or word list to be matched
NArg: If this is 0, Argument is a phrase. If it is 1, Argument is a
word list.

Variables:
%actor% is set to the character speaking.

Enter
Description: This script is checked whenever someone enters the room.
This script is checked just before the character enters the room, so
if you want the action to occur in the room the character is
entering, you must use a wait, or teleport the character. (See
Script Commands for more information on wait and teleport.)
NArg: This is the percent chance that the script will be run when
checked.
Return value: If the return value is 0, the character will not enter
the the room. For any other return value, the character will enter
the room normally.
Variables:
%actor% is set to the character that entered the room.

Drop
Description: This script is checked with a character attempts to drop
something in the room. This script is checked just before the
character actually drops the item.
NArg: This is the percent chance that the script will be run when it
is checked.
Return value: If 0 is returned, the item will not be dropped.
Otherwise, the item is dropped as normal.
Variables:
%actor% is set to the character dropping the item.
%object% is set to the item being dropped.

SEE ALSO: [[VARIABLES]]

[[CATEGORY:Scripts]]

ROOMFLAGS

2008-11-20T10:40:59Z

Kahlan:

ROOMFLAGS

2008-11-20T10:40:28Z

Kahlan: New page: Flags determine how/when the script is called/triggered. NOTE: All scripts have a %self% variable, that represent that ROOM that the script is assigned to. Global Description: This...

Flags determine how/when the script is called/triggered.
NOTE: All scripts have a %self% variable, that represent that ROOM that the
script is assigned to.

Global
Description: This is not a script by itself, but is used with another
script type. A script which is Global is checked even if there are
no PCs in the zone.

Random
Description: This script is checked periodically (currrently every 13
seconds, but may be changed). The script is not checked if there is
no PC in the same zone as the room, unless the Global flag is set
(see above).
NArg: The chance this script will run when it is checked.

Command
Description: This script is checked whenever a character types an
invalid command, or a command which usually results in a 'Sorry, but
you cannot do that here!' message, in the room with this script. If
the command typed is a substring of the argument, the script is
called.
Argument: The command name.
Return value: If 0 is returned by the script, the character will
receive the same message as if the script did not exist.
Variables:
%actor% is set to the character typing the command.
%arg% is set to the argument of the command.
%cmd% is the command that the actor typed.

Speech
Description: This script is checked whenever someone says something in
the room. If NArg is 0, the script checks to see if Argument is a
substring of what was said. If NArg is 1, the script checks to see
if any word in Argument matches a word of what was said to see if the
script should be called.
Argument: The phrase or word list to be matched
NArg: If this is 0, Argument is a phrase. If it is 1, Argument is a
word
list.
Variables:
%actor% is set to the character speaking.

Enter
Description: This script is checked whenever someone enters the room.
This script is checked just before the character enters the room, so
if you want the action to occur in the room the character is
entering, you must use a wait, or teleport the character. (See
Script Commands for more information on wait and teleport.)
NArg: This is the percent chance that the script will be run when
checked.
Return value: If the return value is 0, the character will not enter
the the room. For any other return value, the character will enter
the room normally.
Variables:
%actor% is set to the character that entered the room.

Drop
Description: This script is checked with a character attempts to drop
something in the room. This script is checked just before the
character actually drops the item.
NArg: This is the percent chance that the script will be run when it
is checked.
Return value: If 0 is returned, the item will not be dropped.
Otherwise, the item is dropped as normal.
Variables:
%actor% is set to the character dropping the item.
%object% is set to the item being dropped.

SEE ALSO: [[VARIABLES]]

[[CATEGORY:Scripts]]

ROOMCMDS

2008-11-20T10:38:30Z

Kahlan:

Room scripts alone can use the following commands.

wasound <message>
Wasound echos the message to all the rooms adjacent to the room
wasounding.

wecho <message>
Wecho sends the message to everyone awake in the room.

wechoaround <victim> <message>
This sends the message to everyone in the room except for the victim.

wexp <victim> <amount>
Oexp changes the victim's experience points by amount. The amount
may be 100,000 exp and less, including negative values.

wforce <victim> <command>
The room forces the victim to perform the command. If the victim is
'all', all the characters in the room are forced to perform the
command. Immortals are not affected by this command. No message is
sent to the character, except what is caused by the command
performed.

wload <obj|mob> <vnum> [timer]
This command loads a mob or object into the game, in the room
performing the command. The object or mob's vnum must be specified;
the name will not work. No message is given. If timer is specified,
(this works for objects only), the loaded object will disappear with
a message when the timer expires (like a key would after it's been
used). [timer] is measured in seconds.

wpurge [<target>]
Wpurge removes objects or mobs from the game. If no argument is
given, the all objects and mobs in the room will be removed. If
there is an argument, only that mob or object will be urged. PCs
can not be purged with this command. There is no message generated
by this command.

wsend <victim> <message>
The victim of msend gets the message.

wteleport <victim> <target>
Wteleport moves the victim to the target. The victim does not need
to be in the room. If the victim is 'all', all the characters in
the room will be teleported to the target room. No messages are
generated by this command.

wdoor <room> <direction> <field>
Wdoor allows you to manipulate exits in a room. The <room> argument
is the vnum of the room you are manipulating. <direction> is the
direction you want to modify. <field> is how you are modifying the
room.

<field> can be the following:
purge This completly removes the exit.
description This will change the exit description.
flags Set room flags. They have to be added together the
same way ITEM_CONTAINER flags are set.
1 ISDOOR (exit has a door)
2 CLOSED (door is closed)
4 LOCKED (exit is locked)
8 PICKPROOF (exit can not be picked)
16 NOSAVE (if the zone is saved in olc, exits
with this flag will not be saved)

key set what key vnum is needed to unlock the door.
name Set the keyword list of the room.
room the vnum of the room you want the exit to lead to.

For examples of the wdoor command, stat script 1200 and 1201.

wzecho <message>
This command sends an echo to the entire zone.

wdamage <victim> <amount>
Causes the <amount> of damage to be done to the <victim>. The only
time a message is displayed is if the victim receives a LOT of
damage, or they are BLEEDING or about do die.

wat <location> <command to do there>
This allows a room to perform a script command as if it is in a
different room. It works much like the immortal AT command.

waward <victim> <amount>
This allows a room to award the victim the <amount> of quest points.
Use of this command MUST MUST be cleared with Silvara.

wsavevars
This saves all global script variables so they are loaded after a
reboot. If you want a rooms global variables to be saved through a
reboot, you must call this command in your script.

wportal <target room> <timer>
Creates a portal from the room the script is on to the target room
that last the number of seconds specificed as the timer.

SEE ALSO: [[SCRIPT_COMMANDS]], [[VARIABLES]]

[[CATEGORY:Scripts]]

ROOMCMDS

2008-11-20T10:37:09Z

Kahlan:

ROOMCMDS

2008-11-20T10:35:31Z

Kahlan:

Room scripts alone can use the following commands.

wasound <message>
Wasound echos the message to all the rooms adjacent to the room
wasounding.

wecho <message>
Wecho sends the message to everyone awake in the room.

wechoaround <victim> <message>
This sends the message to everyone in the room except for the victim.

wexp <victim> <amount>
Oexp changes the victim's experience points by amount. The amount
may be 100,000 exp and less, including negative values.

wforce <victim> <command>
The room forces the victim to perform the command. If the victim is
'all', all the characters in the room are forced to perform the
command. Immortals are not affected by this command. No message is
sent to the character, except what is caused by the command
performed.

wload <obj|mob> <vnum> [timer]
This command loads a mob or object into the game, in the room
performing the command. The object or mob's vnum must be specified;
the name will not work. No message is given. If timer is specified,
(this works for objects only), the loaded object will disappear with
a message when the timer expires (like a key would after it's been
used). [timer] is measured in seconds.

wpurge [<target>]
Wpurge removes objects or mobs from the game. If no argument is
given, the all objects and mobs in the room will be removed. If
there is an argument, only that mob or object will be urged. PCs
can not be purged with this command. There is no message generated
by this command.

wsend <victim> <message>
The victim of msend gets the message.

wteleport <victim> <target>
Wteleport moves the victim to the target. The victim does not need
to be in the room. If the victim is 'all', all the characters in
the room will be teleported to the target room. No messages are
generated by this command.

wdoor <room> <direction> <field>
Wdoor allows you to manipulate exits in a room. The <room> argument
is the vnum of the room you are manipulating. <direction> is the
direction you want to modify. <field> is how you are modifying the
room.
<field> can be the following:
purge This completly removes the exit.
description This will change the exit description.
flags Set room flags. They have to be added together the
same way ITEM_CONTAINER flags are set.
1 ISDOOR (exit has a door)
2 CLOSED (door is closed)
4 LOCKED (exit is locked)
8 PICKPROOF (exit can not be picked)
16 NOSAVE (if the zone is saved in olc, exits
with this flag will not be saved)

key set what key vnum is needed to unlock the door.
name Set the keyword list of the room.
room the vnum of the room you want the exit to lead to.

For examples of the wdoor command, stat script 1200 and 1201.

wzecho <message>
This command sends an echo to the entire zone.

wdamage <victim> <amount>
Causes the <amount> of damage to be done to the <victim>. The only
time a message is displayed is if the victim receives a LOT of
damage, or they are BLEEDING or about do die.

wat <location> <command to do there>
This allows a room to perform a script command as if it is in a
different room. It works much like the immortal AT command.

waward <victim> <amount>
This allows a room to award the victim the <amount> of quest points.
Use of this command MUST MUST be cleared with Silvara.

wsavevars
This saves all global script variables so they are loaded after a
reboot. If you want a rooms global variables to be saved through a
reboot, you must call this command in your script.

wportal <target room> <timer>
Creates a portal from the room the script is on to the target room
that last the number of seconds specificed as the timer.

SEE ALSO: [[SCRIPT_COMMANDS]], [[VARIABLES]]

[[CATEGORY:Scripts]]

ROOMCMDS

2008-11-20T10:34:46Z

Kahlan: New page: Room scripts alone can use the following commands. wasound <message> Wasound echos the message to all the rooms adjacent to the room wasounding. wecho <message> ...

Room scripts alone can use the following commands.

wasound <message>
Wasound echos the message to all the rooms adjacent to the room
wasounding.

wecho <message>
Wecho sends the message to everyone awake in the room.

wechoaround <victim> <message>
This sends the message to everyone in the room except for the victim.

wexp <victim> <amount>
Oexp changes the victim's experience points by amount. The amount
may be 100,000 exp and less, including negative values.

wforce <victim> <command>
The room forces the victim to perform the command. If the victim is
'all', all the characters in the room are forced to perform the
command. Immortals are not affected by this command. No message is
sent to the character, except what is caused by the command
performed.

wload <obj|mob> <vnum> [timer]
This command loads a mob or object into the game, in the room
performing the command. The object or mob's vnum must be specified;
the name will not work. No message is given. If timer is specified,
(this works for objects only), the loaded object will disappear with
a message when the timer expires (like a key would after it's been
used). [timer] is measured in seconds.

wpurge [<target>]
Wpurge removes objects or mobs from the game. If no argument is
given, the all objects and mobs in the room will be removed. If
there is an argument, only that mob or object will be urged. PCs
can not be purged with this command. There is no message generated
by this command.

wsend <victim> <message>
The victim of msend gets the message.

wteleport <victim> <target>
Wteleport moves the victim to the target. The victim does not need
to be in the room. If the victim is 'all', all the characters in
the room will be teleported to the target room. No messages are
generated by this command.

wdoor <room> <direction> <field>
Wdoor allows you to manipulate exits in a room. The <room> argument
is the vnum of the room you are manipulating. <direction> is the
direction you want to modify. <field> is how you are modifying the
room.
<field> can be the following:
purge This completly removes the exit.
description This will change the exit description.
flags Set room flags. They have to be added together the
same way ITEM_CONTAINER flags are set.
1 ISDOOR (exit has a door)
2 CLOSED (door is closed)
4 LOCKED (exit is locked)
8 PICKPROOF (exit can not be picked)
16 NOSAVE (if the zone is saved in olc, exits
with this flag will not be saved)

key set what key vnum is needed to unlock the door.
name Set the keyword list of the room.
room the vnum of the room you want the exit to lead to.

For examples of the wdoor command, stat script 1200 and 1201.

wzecho <message>
This command sends an echo to the entire zone.

wdamage <victim> <amount>
Causes the <amount> of damage to be done to the <victim>. The only
time a message is displayed is if the victim receives a LOT of
damage, or they are BLEEDING or about do die.

wat <location> <command to do there>
This allows a room to perform a script command as if it is in a
different room. It works much like the immortal AT command.

waward <victim> <amount>
This allows a room to award the victim the <amount> of quest points.
Use of this command MUST MUST be cleared with Silvara.

wsavevars
This saves all global script variables so they are loaded after a
reboot. If you want a rooms global variables to be saved through a
reboot, you must call this command in your script.

wportal <target room> <timer>
Creates a portal from the room the script is on to the target room
that last the number of seconds specificed as the timer.

SEE ALSO: [[SCRIPT_COMMANDS]], [[VARIABLES]]

[[CATEGORY:Scripts]]

ROOM VARIABLES

2008-11-20T10:33:57Z

Kahlan: New page: For details on how to use variables, please see the schelp for VARIABLES. Room variables are as follows: ============================== name The rooms name vnum The v...

For details on how to use variables, please see the schelp for VARIABLES.

Room variables are as follows:
==============================

name The rooms name
vnum The vnum of the room
godrooom The room has a godroom flag (1/0)
dark The room has a dark flag (1/0)
death The room has a death flag (1/0)
nomob The room has a nomob flag (1/0)
indoors The room has a indoors flag (1/0)
peaceful The room has a peaceful flag (1/0)
soundproof The room has a soundproof flag (1/0)
notrack The room has a notrack flag (1/0)
nomagic The room has a nomagic flag (1/0)
house The room has a house flag (1/0)
norecall The room has a recall flag (1/0)
nosummon The room has a nosummon flag (1/0)
crimeok The room has a crimeok flag (1/0)
store The room has a store flag (1/0)

See also: [[VARIABLES]], [[CHARACTER VARIABLES]], [[OBJECT VARIABLES]],
[[SPECIAL VARIABLES]]

[[CATEGORY:Scripts]]

OBJFLAGS

2008-11-20T10:33:09Z

Kahlan:

Flags determine how/when the script is called/triggered.
NOTE: All scripts have a %self% variable, that represent that OBJECT that the
script is assigned to.

Global
Description: This is not a script by itself, but is to be used with
the random script. A script which is global is checked even if there
are no PCs in the same zone as the object.

Random
Description: This script is checked periodically (currently every 13
seconds)
NArg: The chance this script will be run when it is checked.

Command
Description: This script is checked whenever a character types an
invalid command, or a command which usually results in a 'Sorry, but
you cannot do that here!' message, around the object with this
script. If the command typed is a substring of the argument, the
script is called.
Argument: The command name.
NArg: This determines where the item must be for the script to be run.
A 1 means the item must be in the character's equipment for it to be
used. A 2 means the item must be in the character's inventory. A 4
means the item must be in the same room as the character. These can
be added together so the item can be in more than one place. For
example, if NArg was 3, the script would work if the item was in the
character's inventory or equipment. A 7 would mean the script would
work in the character's inventory, equipment, or in the room.
Return value: If 0 is returned by the script, the character will
receive the same message as if the script did not exist.
Variables:
%actor% is set to the character typing the command.
%arg% is set to the argument of the command.

Get
Description: This script is checked whenever the item is picked up.
NArg: This is the percent chance that the script will be run when
checked.
Return value: If 0 is returned, the object is not picked up. For any
other value, the object will go to the character's inventory as normal.
Variables:
%actor% is set to the mob that picks up the object.

Drop
Description: This script is checked when a character attemps to drop
an object with a Drop script.
NArg: This is the percent chance that the script will be run when
checked.
Return value: If 0 is returned, the object is not dropped. For any
other value, the object will go to the room as normal.
Variables:
%actor% is set to the character attempting to drop the item.

Give
Description: This script is checked whenever someone attemps to give
away the object.
NArg: This is the percent chance that the script will be run when
checked.
Return value: If the return value is 0, the object will not be given
to the victim. For any other return value, the give will occur
normally.
Variables:
%actor% is the character giving the object.
%victim% is the character receiving the object.

Wear
Description: This script is checked whenever a mob attemps to wear the
item.
Return value: If 0 is returned, the item is not worn.
Variables:
%actor% is set to the mob that is attempting to wear the object.

SEE ALSO: [[VARIABLES]]

[[CATEGORY:Scripts]]

OBJFLAGS

2008-11-20T10:32:43Z

Kahlan: New page: Flags determine how/when the script is called/triggered. NOTE: All scripts have a %self% variable, that represent that OBJECT that the script is assigned to. Global Description: Th...

OBJECT VARIABLES

2008-11-20T10:31:32Z

Kahlan:

For details on how to use variables, please see the schelp for VARIABLES.

Object variables are as follows:
================================

name The object's keyword list
shortdesc The object's short description
vnum The object's vnum (-1 if it doesn't have one)
type The object's type (see ohelp item_types)
val0 The object's values (see ohelp item_types)
val1 "" "" "" ""
val2 "" "" "" ""
val3 "" "" "" ""
min_level The object's min level
timer If the obj has a timer, it will return the number of
seconds until the timer expires, otherwise it returns 0

See also: [[VARIABLES]], [[ROOM VARIABLES]], [[CHARACTER VARIABLES]],
[[SPECIAL VARIABLES]]

[[CATEGORY:Scripts]]

OBJECT VARIABLES

2008-11-20T10:31:05Z

Kahlan: New page: For details on how to use variables, please see the schelp for VARIABLES. Object variables are as follows: ================================ name The object's keyword list sh...

For details on how to use variables, please see the schelp for VARIABLES.

Object variables are as follows:
================================

name The object's keyword list
shortdesc The object's short description
vnum The object's vnum (-1 if it doesn't have one)
type The object's type (see ohelp item_types)
val0 The object's values (see ohelp item_types)
val1 "" "" "" ""
val2 "" "" "" ""
val3 "" "" "" ""
min_level The object's min level
timer If the obj has a timer, it will return the number of
seconds until the timer expires, otherwise it returns 0

See also: VARIABLES, ROOM VARIABLES, CHARACTER VARIABLES,
SPECIAL VARIABLES

OBJCMDS

2008-11-20T10:30:27Z

Kahlan:

Object Commands
------------------
Items alone can use the following commands.

oecho <message>
Oecho sends the message to everyone awake in the same room as the
object. If the object is equiped or carried by someone or in
something, the message is sent to the room the person or object is
in.

oechoaround <victim> <message>
This sends the message to everyone in the room, except for the victim
and the mob.

oexp <victim> <amount>
Oexp changes the victim's experience points by amount. The amount
may be 100,000 exp and less, including negative values.

oforce <victim> <command>
The object forces the victim to perform the command. If the victim
is 'all', all the characters in the room are forced to perform the
command. Immortals are not affected by this command. No message is
set to the character, except what is caused by the command performed.

opurge [<target>]
Opurge removes objects or mobs from the game. If no argument is
given, then all objects and mobs in the room will be removed. If
there is an argument, only that mob or object will be purged. PCs
can not be purged with this command. There is no message when this
command is used.

osend <victim> <message>
The victim of osend gets the message.

oload <obj|mob> <vnum> [timer]
This command loads a mob or object into the game. They are both
loaded in the same room as the object using the command. The object
or mobs vnum must be specified, the name will not work. No message
is given. If timer is specified, (this works for objects only), the
loaded object will disappear with a message when the timer expires
(like a key would after it's been used). [timer] is specified as
number of seconds.

oteleport <victim> <target>
Oteleport moves the victim to the target. The victim does not need
to be in the same room as the object. If the victim is 'all', all
the characters in the room will be teleported to the target room.
No messages are generated by this command.

odamage <victim> <amount>
Causes the <amount> of damage to be done to the <victim>. The only
time a message is displayed is if the victim receives a LOT of
damage, or they are BLEEDING or about do die.

ozecho <message>
Ozecho causes the object to echo something to the entire zone.

oportal <target room> <timer>
Creates a portal from the current room the object is in to the
target room that last the number of seconds specificed as the timer.

otimer <timer> [1|0]
Put's a timer on the object in terms of seconds. The optional last
argument will cause the item to disappear without any messages if it
is 1. No value or any other value will cause it to display the
disappear messages as normal.

SEE ALSO: [[SCRIPT COMMANDS]], [[VARIABLES]]

[[CATEGORY:Scripts]]

OBJCMDS

2008-11-20T10:29:59Z

Kahlan: New page: Object Commands ------------------ Items alone can use the following commands. oecho <message> Oecho sends the message to everyone awake in the same room as the objec...

MOBFLAGS

2008-11-20T10:28:50Z

Kahlan:

Flags determine how/when the script is called/triggered.

NOTE: All scripts have a %self% variable, that represent that MOBILE that the script is assigned to.

Global
Description: This is not a script by itself, but is used with another
script type. A script which is global is checked even if there are no
PCs in the same zone as the mob.

Random
Description: This script is checked periodically (currently every 13
seconds). The script is not checked if there is no PC in the same
zone as the mob, unless the Global flag is set (see above).
NArg: The chance this script will be run when it is checked.

Command
Description: This script is checked whenever a character types an
invalid command, or a command real command, in the same room as the
mob with this script. If the command typed is a substring of the
argument, the script is called.
Argument: The command name.
Return value: If 0 is returned by the script, the character will
receive the same message as if the script did not exist.
Variables:
%actor% is set to the character typing the command.
%arg% is set to the argument of the command.

Speech
Description: This script is checked whenever someone says something
around a mob with this script. If NArg is 0, the script checks to see
if Argument is a substring of what was said. If NArg is 1, the script
checks to see if any word in Argument matches a word of what was said
to see if the script should be called.
Argument: The phrase or word list to be matched
NArg: If this is 0, Argument is a phrase. If it is 1, Argument is a word
list.
Variables:
%actor% is set to the character speaking.
Act - &r**This currently does not work***&n
Description: This script is runs when Argument is a substring of a
string of text that a mob sees. The text can come only come from certain
output (those generated by the act() function of the game). This
includes most messages, such as socials, damage messages, and skill
messages. Text from players, such as echo, emote, say, and tell, are
not checked. If you have a specific question whether a message is
checked, ask an implementor. The variables will be set to the right
character or object, even if 'someone' or 'something' is used instead of
the name.
Argument: The phrase or word list to be matched
NArg: If this is 0, Argument is a phrase. If it is 1, Argument is a word
list.
Variables: Not all the variables will be set. Which ones are set and
to what depends on the message. If you have trouble, ask an implementor.
%actor% is set to the primary character in the text.
%victim% is set to the secondary character in the text.
%object% is set to the primary object of the text.
%target% is set to the secondary object of the text.
%arg% is set to the variable string portion of the text, such as a door
name.

Death
Description: This script is checked when a mobile dies.
NArg: This is the percent chance that the script will be run when
checked.
Return value: If the return value is 0, the mob's death cry (such as
'Your blood freezes as you hear the beastly fido's death cry.') will not
be heard. For any other value, the normal death cry will be heard.
Variables:
%actor% will be set to the killer, if there is one.

Greet
Description: This script is checked when someone enters the room, and
the mob with the script can see the person entering.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is set to be the character entering the room.

GreetAll
Description: This script is the same as the Greet script, except that
it is checked even if the mob can not see the actor.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is set to be the character entering the room.

Entry
Description: This script is checked every time the mobile enters a room.
NArg: This is the percent chance that the script will be run when
checked.

Receive
Description: This script is checked when an object is given to the mob.
NArg: This is the percent chance that the script will be run when
checked.
Return value: If 0 is returned, the object will not be transfered to the
mob. For any other number, the normal result will occur.
Variables:
%actor% is set to the character giving the mob the object.
%object% is set to the object being given.

Fight
Description: This script is checked every round the mob is fighting,
after all mob has had its attacks.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is the character the mob is fighting.

Hitprcnt
Description: This script is checked during combat when the mob's hit
points drop below the percentage specified by NArg.
NArg: This is the percentage of hit points a mob must drop below for the
script to be checked.
Variables:
%actor% is set the the character fighting the mob.

Bribe
Description: This script is checked when coins are given to a mob.
NArg: This is the minimum number of coins that must be given to the mob
for the script to be run.
Variables:
%actor% is set to be the character giving the mob the coins.
%amount% is the number of coins given to the mob.

Oncast
Description: This type of script is checked when someone casts a spell
in the room.
Narg: percent changes the script is to be run.
Return: 1 allows spell to be cast.
0 prevents cast from finishing.
Variables:
%caster% - Person casting spell
%actor% - "" "" ""
%victim% - Victim of spell (if any)
%object% - Object spell is being cast at (if any)
%spellname% - Name of spell being cast
%spellnum% - Idnum of spell being cast
%violent% - 0 or 1, wether or not spell is "violent"
%learned% - Percent the caster has learned the spell

SEE ALSO: [[VARIABLES]]
[[CATEGORY:Scripts]]

MOBFLAGS

2008-11-20T10:28:34Z

Kahlan:

Flags determine how/when the script is called/triggered.

NOTE: All scripts have a %self% variable, that represent that MOBILE that the
script is assigned to.

Global
Description: This is not a script by itself, but is used with another
script type. A script which is global is checked even if there are no
PCs in the same zone as the mob.

Random
Description: This script is checked periodically (currently every 13
seconds). The script is not checked if there is no PC in the same
zone as the mob, unless the Global flag is set (see above).
NArg: The chance this script will be run when it is checked.

Command
Description: This script is checked whenever a character types an
invalid command, or a command real command, in the same room as the
mob with this script. If the command typed is a substring of the
argument, the script is called.
Argument: The command name.
Return value: If 0 is returned by the script, the character will
receive the same message as if the script did not exist.
Variables:
%actor% is set to the character typing the command.
%arg% is set to the argument of the command.

Speech
Description: This script is checked whenever someone says something
around a mob with this script. If NArg is 0, the script checks to see
if Argument is a substring of what was said. If NArg is 1, the script
checks to see if any word in Argument matches a word of what was said
to see if the script should be called.
Argument: The phrase or word list to be matched
NArg: If this is 0, Argument is a phrase. If it is 1, Argument is a word
list.
Variables:
%actor% is set to the character speaking.
Act - &r**This currently does not work***&n
Description: This script is runs when Argument is a substring of a
string of text that a mob sees. The text can come only come from certain
output (those generated by the act() function of the game). This
includes most messages, such as socials, damage messages, and skill
messages. Text from players, such as echo, emote, say, and tell, are
not checked. If you have a specific question whether a message is
checked, ask an implementor. The variables will be set to the right
character or object, even if 'someone' or 'something' is used instead of
the name.
Argument: The phrase or word list to be matched
NArg: If this is 0, Argument is a phrase. If it is 1, Argument is a word
list.
Variables: Not all the variables will be set. Which ones are set and
to what depends on the message. If you have trouble, ask an implementor.
%actor% is set to the primary character in the text.
%victim% is set to the secondary character in the text.
%object% is set to the primary object of the text.
%target% is set to the secondary object of the text.
%arg% is set to the variable string portion of the text, such as a door
name.

Death
Description: This script is checked when a mobile dies.
NArg: This is the percent chance that the script will be run when
checked.
Return value: If the return value is 0, the mob's death cry (such as
'Your blood freezes as you hear the beastly fido's death cry.') will not
be heard. For any other value, the normal death cry will be heard.
Variables:
%actor% will be set to the killer, if there is one.

Greet
Description: This script is checked when someone enters the room, and
the mob with the script can see the person entering.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is set to be the character entering the room.

GreetAll
Description: This script is the same as the Greet script, except that
it is checked even if the mob can not see the actor.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is set to be the character entering the room.

Entry
Description: This script is checked every time the mobile enters a room.
NArg: This is the percent chance that the script will be run when
checked.

Receive
Description: This script is checked when an object is given to the mob.
NArg: This is the percent chance that the script will be run when
checked.
Return value: If 0 is returned, the object will not be transfered to the
mob. For any other number, the normal result will occur.
Variables:
%actor% is set to the character giving the mob the object.
%object% is set to the object being given.

Fight
Description: This script is checked every round the mob is fighting,
after all mob has had its attacks.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is the character the mob is fighting.

Hitprcnt
Description: This script is checked during combat when the mob's hit
points drop below the percentage specified by NArg.
NArg: This is the percentage of hit points a mob must drop below for the
script to be checked.
Variables:
%actor% is set the the character fighting the mob.

Bribe
Description: This script is checked when coins are given to a mob.
NArg: This is the minimum number of coins that must be given to the mob
for the script to be run.
Variables:
%actor% is set to be the character giving the mob the coins.
%amount% is the number of coins given to the mob.

Oncast
Description: This type of script is checked when someone casts a spell
in the room.
Narg: percent changes the script is to be run.
Return: 1 allows spell to be cast.
0 prevents cast from finishing.
Variables:
%caster% - Person casting spell
%actor% - "" "" ""
%victim% - Victim of spell (if any)
%object% - Object spell is being cast at (if any)
%spellname% - Name of spell being cast
%spellnum% - Idnum of spell being cast
%violent% - 0 or 1, wether or not spell is "violent"
%learned% - Percent the caster has learned the spell

SEE ALSO: [[VARIABLES]]
[[CATEGORY:Scripts]]

MOBFLAGS

2008-11-20T10:28:25Z

Kahlan:

Flags determine how/when the script is called/triggered.

NOTE: All scripts have a %self% variable, that represent that MOBILE that the
script is assigned to.

Global
Description: This is not a script by itself, but is used with another
script type. A script which is global is checked even if there are no
PCs in the same zone as the mob.

Random
Description: This script is checked periodically (currently every 13
seconds). The script is not checked if there is no PC in the same
zone as the mob, unless the Global flag is set (see above).
NArg: The chance this script will be run when it is checked.

Command
Description: This script is checked whenever a character types an
invalid command, or a command real command, in the same room as the
mob with this script. If the command typed is a substring of the
argument, the script is called.
Argument: The command name.
Return value: If 0 is returned by the script, the character will
receive the same message as if the script did not exist.
Variables:
%actor% is set to the character typing the command.
%arg% is set to the argument of the command.

Speech
Description: This script is checked whenever someone says something
around a mob with this script. If NArg is 0, the script checks to see
if Argument is a substring of what was said. If NArg is 1, the script
checks to see if any word in Argument matches a word of what was said
to see if the script should be called.
Argument: The phrase or word list to be matched
NArg: If this is 0, Argument is a phrase. If it is 1, Argument is a word
list.
Variables:
%actor% is set to the character speaking.
Act - &r**This currently does not work***&n
Description: This script is runs when Argument is a substring of a
string of text that a mob sees. The text can come only come from certain
output (those generated by the act() function of the game). This
includes most messages, such as socials, damage messages, and skill
messages. Text from players, such as echo, emote, say, and tell, are
not checked. If you have a specific question whether a message is
checked, ask an implementor. The variables will be set to the right
character or object, even if 'someone' or 'something' is used instead of
the name.
Argument: The phrase or word list to be matched
NArg: If this is 0, Argument is a phrase. If it is 1, Argument is a word
list.
Variables: Not all the variables will be set. Which ones are set and
to what depends on the message. If you have trouble, ask an implementor.
%actor% is set to the primary character in the text.
%victim% is set to the secondary character in the text.
%object% is set to the primary object of the text.
%target% is set to the secondary object of the text.
%arg% is set to the variable string portion of the text, such as a door
name.

Death
Description: This script is checked when a mobile dies.
NArg: This is the percent chance that the script will be run when
checked.
Return value: If the return value is 0, the mob's death cry (such as
'Your blood freezes as you hear the beastly fido's death cry.') will not
be heard. For any other value, the normal death cry will be heard.
Variables:
%actor% will be set to the killer, if there is one.

Greet
Description: This script is checked when someone enters the room, and
the mob with the script can see the person entering.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is set to be the character entering the room.

GreetAll
Description: This script is the same as the Greet script, except that
it is checked even if the mob can not see the actor.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is set to be the character entering the room.

Entry
Description: This script is checked every time the mobile enters a room.
NArg: This is the percent chance that the script will be run when
checked.

Receive
Description: This script is checked when an object is given to the mob.
NArg: This is the percent chance that the script will be run when
checked.
Return value: If 0 is returned, the object will not be transfered to the
mob. For any other number, the normal result will occur.
Variables:
%actor% is set to the character giving the mob the object.
%object% is set to the object being given.

Fight
Description: This script is checked every round the mob is fighting,
after all mob has had its attacks.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is the character the mob is fighting.

Hitprcnt
Description: This script is checked during combat when the mob's hit
points drop below the percentage specified by NArg.
NArg: This is the percentage of hit points a mob must drop below for the
script to be checked.
Variables:
%actor% is set the the character fighting the mob.

Bribe
Description: This script is checked when coins are given to a mob.
NArg: This is the minimum number of coins that must be given to the mob
for the script to be run.
Variables:
%actor% is set to be the character giving the mob the coins.
%amount% is the number of coins given to the mob.

Oncast
Description: This type of script is checked when someone casts a spell
in the room.
Narg: percent changes the script is to be run.
Return: 1 allows spell to be cast.
0 prevents cast from finishing.
Variables:
%caster% - Person casting spell
%actor% - "" "" ""
%victim% - Victim of spell (if any)
%object% - Object spell is being cast at (if any)
%spellname% - Name of spell being cast
%spellnum% - Idnum of spell being cast
%violent% - 0 or 1, wether or not spell is "violent"
%learned% - Percent the caster has learned the spell

SEE ALSO: [[VARIABLES]]
[[CATEGORY:Scripts]]

MOBFLAGS

2008-11-20T10:28:17Z

Kahlan:

Flags determine how/when the script is called/triggered.

NOTE: All scripts have a %self% variable, that represent that MOBILE that the
script is assigned to.

Global
Description: This is not a script by itself, but is used with another
script type. A script which is global is checked even if there are no
PCs in the same zone as the mob.

Random
Description: This script is checked periodically (currently every 13
seconds). The script is not checked if there is no PC in the same
zone as the mob, unless the Global flag is set (see above).
NArg: The chance this script will be run when it is checked.

Command
Description: This script is checked whenever a character types an
invalid command, or a command real command, in the same room as the
mob with this script. If the command typed is a substring of the
argument, the script is called.
Argument: The command name.
Return value: If 0 is returned by the script, the character will
receive the same message as if the script did not exist.
Variables:
%actor% is set to the character typing the command.
%arg% is set to the argument of the command.

Speech
Description: This script is checked whenever someone says something
around a mob with this script. If NArg is 0, the script checks to see
if Argument is a substring of what was said. If NArg is 1, the script
checks to see if any word in Argument matches a word of what was said
to see if the script should be called.
Argument: The phrase or word list to be matched
NArg: If this is 0, Argument is a phrase. If it is 1, Argument is a word
list.
Variables:
%actor% is set to the character speaking.
Act - &r**This currently does not work***&n
Description: This script is runs when Argument is a substring of a
string of text that a mob sees. The text can come only come from certain
output (those generated by the act() function of the game). This
includes most messages, such as socials, damage messages, and skill
messages. Text from players, such as echo, emote, say, and tell, are
not checked. If you have a specific question whether a message is
checked, ask an implementor. The variables will be set to the right
character or object, even if 'someone' or 'something' is used instead of
the name.
Argument: The phrase or word list to be matched
NArg: If this is 0, Argument is a phrase. If it is 1, Argument is a word
list.
Variables: Not all the variables will be set. Which ones are set and
to what depends on the message. If you have trouble, ask an implementor.
%actor% is set to the primary character in the text.
%victim% is set to the secondary character in the text.
%object% is set to the primary object of the text.
%target% is set to the secondary object of the text.
%arg% is set to the variable string portion of the text, such as a door
name.

Death
Description: This script is checked when a mobile dies.
NArg: This is the percent chance that the script will be run when
checked.
Return value: If the return value is 0, the mob's death cry (such as
'Your blood freezes as you hear the beastly fido's death cry.') will not
be heard. For any other value, the normal death cry will be heard.
Variables:
%actor% will be set to the killer, if there is one.

Greet
Description: This script is checked when someone enters the room, and
the mob with the script can see the person entering.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is set to be the character entering the room.

GreetAll
Description: This script is the same as the Greet script, except that
it is checked even if the mob can not see the actor.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is set to be the character entering the room.

Entry
Description: This script is checked every time the mobile enters a room.
NArg: This is the percent chance that the script will be run when
checked.

Receive
Description: This script is checked when an object is given to the mob.
NArg: This is the percent chance that the script will be run when
checked.
Return value: If 0 is returned, the object will not be transfered to the
mob. For any other number, the normal result will occur.
Variables:
%actor% is set to the character giving the mob the object.
%object% is set to the object being given.

Fight
Description: This script is checked every round the mob is fighting,
after all mob has had its attacks.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is the character the mob is fighting.

Hitprcnt
Description: This script is checked during combat when the mob's hit
points drop below the percentage specified by NArg.
NArg: This is the percentage of hit points a mob must drop below for the
script to be checked.
Variables:
%actor% is set the the character fighting the mob.

Bribe
Description: This script is checked when coins are given to a mob.
NArg: This is the minimum number of coins that must be given to the mob
for the script to be run.
Variables:
%actor% is set to be the character giving the mob the coins.
%amount% is the number of coins given to the mob.

Oncast
Description: This type of script is checked when someone casts a spell
in the room.
Narg: percent changes the script is to be run.
Return: 1 allows spell to be cast.
0 prevents cast from finishing.
Variables:
%caster% - Person casting spell
%actor% - "" "" ""
%victim% - Victim of spell (if any)
%object% - Object spell is being cast at (if any)
%spellname% - Name of spell being cast
%spellnum% - Idnum of spell being cast
%violent% - 0 or 1, wether or not spell is "violent"
%learned% - Percent the caster has learned the spell

SEE ALSO: [[VARIABLES]]
[[CATEGORY:Scripts]]

MOBFLAGS

2008-11-20T10:27:34Z

Kahlan: New page: Flags determine how/when the script is called/triggered. NOTE: All scripts have a %self% variable, that represent that MOBILE that the script is assigned to. Global Description: Th...

Flags determine how/when the script is called/triggered.
NOTE: All scripts have a %self% variable, that represent that MOBILE that the
script is assigned to.

Global
Description: This is not a script by itself, but is used with another
script type. A script which is global is checked even if there are no
PCs in the same zone as the mob.

Random
Description: This script is checked periodically (currently every 13
seconds). The script is not checked if there is no PC in the same
zone as the mob, unless the Global flag is set (see above).
NArg: The chance this script will be run when it is checked.

Command
Description: This script is checked whenever a character types an
invalid command, or a command real command, in the same room as the
mob with this script. If the command typed is a substring of the
argument, the script is called.
Argument: The command name.
Return value: If 0 is returned by the script, the character will
receive the same message as if the script did not exist.
Variables:
%actor% is set to the character typing the command.
%arg% is set to the argument of the command.

Speech
Description: This script is checked whenever someone says something
around a mob with this script. If NArg is 0, the script checks to see
if Argument is a substring of what was said. If NArg is 1, the script
checks to see if any word in Argument matches a word of what was said
to see if the script should be called.
Argument: The phrase or word list to be matched
NArg: If this is 0, Argument is a phrase. If it is 1, Argument is a word
list.
Variables:
%actor% is set to the character speaking.
Act - &r**This currently does not work***&n
Description: This script is runs when Argument is a substring of a
string of text that a mob sees. The text can come only come from certain
output (those generated by the act() function of the game). This
includes most messages, such as socials, damage messages, and skill
messages. Text from players, such as echo, emote, say, and tell, are
not checked. If you have a specific question whether a message is
checked, ask an implementor. The variables will be set to the right
character or object, even if 'someone' or 'something' is used instead of
the name.
Argument: The phrase or word list to be matched
NArg: If this is 0, Argument is a phrase. If it is 1, Argument is a word
list.
Variables: Not all the variables will be set. Which ones are set and
to what depends on the message. If you have trouble, ask an implementor.
%actor% is set to the primary character in the text.
%victim% is set to the secondary character in the text.
%object% is set to the primary object of the text.
%target% is set to the secondary object of the text.
%arg% is set to the variable string portion of the text, such as a door
name.

Death
Description: This script is checked when a mobile dies.
NArg: This is the percent chance that the script will be run when
checked.
Return value: If the return value is 0, the mob's death cry (such as
'Your blood freezes as you hear the beastly fido's death cry.') will not
be heard. For any other value, the normal death cry will be heard.
Variables:
%actor% will be set to the killer, if there is one.

Greet
Description: This script is checked when someone enters the room, and
the mob with the script can see the person entering.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is set to be the character entering the room.

GreetAll
Description: This script is the same as the Greet script, except that
it is checked even if the mob can not see the actor.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is set to be the character entering the room.

Entry
Description: This script is checked every time the mobile enters a room.
NArg: This is the percent chance that the script will be run when
checked.

Receive
Description: This script is checked when an object is given to the mob.
NArg: This is the percent chance that the script will be run when
checked.
Return value: If 0 is returned, the object will not be transfered to the
mob. For any other number, the normal result will occur.
Variables:
%actor% is set to the character giving the mob the object.
%object% is set to the object being given.

Fight
Description: This script is checked every round the mob is fighting,
after all mob has had its attacks.
NArg: This is the percent chance that the script will be run when
checked.
Variables:
%actor% is the character the mob is fighting.

Hitprcnt
Description: This script is checked during combat when the mob's hit
points drop below the percentage specified by NArg.
NArg: This is the percentage of hit points a mob must drop below for the
script to be checked.
Variables:
%actor% is set the the character fighting the mob.

Bribe
Description: This script is checked when coins are given to a mob.
NArg: This is the minimum number of coins that must be given to the mob
for the script to be run.
Variables:
%actor% is set to be the character giving the mob the coins.
%amount% is the number of coins given to the mob.

Oncast
Description: This type of script is checked when someone casts a spell
in the room.
Narg: percent changes the script is to be run.
Return: 1 allows spell to be cast.
0 prevents cast from finishing.
Variables:
%caster% - Person casting spell
%actor% - "" "" ""
%victim% - Victim of spell (if any)
%object% - Object spell is being cast at (if any)
%spellname% - Name of spell being cast
%spellnum% - Idnum of spell being cast
%violent% - 0 or 1, wether or not spell is "violent"
%learned% - Percent the caster has learned the spell

SEE ALSO: VARIABLES

MOBCMDS

2008-11-20T10:26:42Z

Kahlan:

Mobs can use any game command available to a mortal player character of the
same class and level as the mob. In addition, they can use the following
special commands.

huntmove <target>
Huntmove will move one room in the direction of the victim.

masound <message>
Masound echos the message to the all the rooms the exits of the mob's
room lead to.

mat <target> <command>
The command is performed by the mob at the specified target. The target
may be a room number, character name, or object name. The target room
can not be a private or god room. Valid commands are any commands usable
by a mob.

mecho <message>
Mecho sends the message to everyone awake in the same room as the mob.

mechoaround <victim> <message>
This sends the message to everyone in the room except for the victim and
the mob.

mexp <victim> <amount>
Mexp changes the victim's experience points by amount. The amount may
be 100,000 exp and less, including negative values.

mforce <victim> <command>
The mob forces the victim to perform the command. If the victim is
'all', all the characters in the room are forced to perform the command.
Immortals are not affected by this command. No message is sent to the
character, except what is caused by the command performed.

mgoto <target>
This command moves the mob to the given target. The target may be an
object, room, or character, as long as it is not in a private occupied
with two or more characters, or god room. No message is given.

mjunk <object>
The object in the mob's inventory which is specified is removed from the
game. 'mjunk all' removes all of the objects in the mob's inventory. No
message is sent by this command.

mkill <victim>
Mkill causes the mob to hit the victim. It is the same as kill, except
mkill works for low level mobs attacking PCs, where kill does not.

mload <obj|mob> <vnum> [timer]
This command loads a mob or object into the game. Mobs are loaded in the
same room as the mob using the command. Notake objects are loaded into
the mob's room, and all other objects are loaded into the mob's
inventory. The object or mob's vnum must be specified; the name will not
work. No message is given. If timer is specified, (this works for
objects only), the loaded object will disappear with a message when
the timer expires (like a key would after it's been used).

mobcast 'spell' [<target>]
Mobcast allows a mob to cast a spell like a player can. The target
argument is optional depending on the spell that is being cast. Ex:
mobcast 'word of death' Puff

mobhunt <victim>
Mobhunt causes the mob to enter hunter-mode and track down the victim.
The victim may be a mob, player, or room number.

mpurge [<target>]
Mpurge removes objects or mobs from the game. If no argument is given,
then all objects and mobs in the room will be removed. If there is an
argument, only that mob or object will be purged. PCs can not be purged
with this command. There is no message when this command is used.

msend <victim> <message>
The victim of msend gets the message.

mteleport <victim> <target>
Mteleport moves the victim to the target. The victim does not need to
be in the same room as the mob. If the victim is 'all', all the
characters in the room will be teleported to the target room. No
messages are generated by this command.

mgold <victim> <amount>
Mgold gives (and should subtract) the <amount> to the <victim>.

mzecho <message>
Mzecho causes the mob to echo something to the entire zone.

mportal <target room> <timer>
Creates a portal from the current room the mob is in to the target room
that last the number of seconds specificed as the timer.

SEE ALSO: [[SCRIPT_COMMANDS]], [[VARIABLES]]

[[CATEGORY:Scripts]]

MOBCMDS

2008-11-20T10:26:29Z

Kahlan:

MOBCMDS

2008-11-20T10:26:10Z

Kahlan: New page: Mobs can use any game command available to a mortal player character of the same class and level as the mob. In addition, they can use the following special commands. huntmove ...

CHARACTER VARIABLES

2008-11-20T10:24:48Z

Kahlan:

For details on how to use variables, please see the schelp for VARIABLES.

Character variables are as follows:
===================================

name The character's name.
inventory The first object in the characters inventory
alias A mob's alias list, returns nothing if PC
casting 1/0 (true/false if the character is casting a spell)
idnum Database idnum of character
level The character's current level.
gold The amount of gold on hand.
align The characters alignmen.
clan The characters clan, returns as "no_clan" if not a clan
member.
clanrank Numeric value of the characters clan rank.
clanrankname Name of the characters clan rank.
remorts Number of times character has remorted.
next_in_room Detailed in OHELP RECALL DEVICES
sex The character's sex, as a string (MALE, FEMALE, or NEUTRAL).
himher returns "him" if actor is male, or "her" if actor is female.
hisher returns "his" if actor is male, or "her" if actor is female.
heshe returns "he" if actor is male, or "she" if actor is female.
canbeseen In mob scripts only, returns 1 if the mob can see the actor,
returns 0 if it cannot.
class The character's class, as a string.
race The character's race, as a string.
vnum The character's virtual number. -1 for PCs.
sound The character has MSP sound turned on.
str The character's strength
stradd The character's "stradd".
dex The character's dexterity.
con The character's constitution.
int The character's intelligence.
wis The character's wisdom.
cha The character's charisma.
hp The character's current hit points
maxhp The character's max hit points
move The character's current moves
maxmove The character's max moves
mana The character's current mana
maxmana The character's max mana
psp The character's current PSP's
maxpsp The character's max PSP's
room The vnum of the room the character is in.
master The person the character is following, or 0.
hometown Name of the character's hometown.
pos The position the character is in:
Dead
Mortally wounded
Incapacitated
Stunned
Sleeping
Resting
Sitting
Fighting
Standing
inroom This returns a pointer to the room the character is in.
The intended use for this variable is to assign it to
another variable and reference the new variable.

For example:

set myroom %actor.inroom%
if (%myroom.dark%)
...
end

eq(position) This is a new concept as well as inroom. If you want
to see if someone is wearing armor, you would do
something like this:
set armor %actor.eq(body)%
if (%armor%)
echo %actor.name% is wearing %body.shortdesc%.
else
echo %actor.name% is nekked.
end
Valid positions are: finger, neck, body, head, face,
ear, legs, feet, hands, arms, shield, about, waist,
wrist.
To access the second finger position or wield and hold
you must use the number that represents that wear
position. The chart is as follows:

Position Number
====================
LIGHT 0
FINGER_R 1
FINGER_L 2
NECK_1 3
NECK_2 4
BODY 5
HEAD 6
FACE 7
EAR_R 8
EAR_L 9
LEGS 10
FEET 11
HANDS 12
ARMS 13
SHIELD 14
ABOUT 15
WAIST 16
WRIST_R 17
WRIST_L 18
WIELD 19
HOLD 20

fighting Returns a pointer to who the character is fighting, so
you can then treat it as another character.

Example:
set victim %actor.fighting%
if (%victim%)
pthb %victim%
end

Some variables are used to CHANGE the value of a character, for example
a line in a script that simply has:
%actor.set.mana(10)%
will modify that characters mana to be 10. Valid variables are:
set.hp
set.mana
set.psp
set.move
set.align
set.pos
set.align
(negative numbers can be used for these to subtract)
add.mana
add.psp
add.move
add.align
add.drunk
add.thirsty
add.full
add.quest_points

These are going to be phased out.
room.name The name of the room the character is in.
room.godrooom The room has a godroom flag
room.dark The room has a dark flag
room.death The room has a death flag
room.nomob The room has a nomob flag
room.indoors The room has a indoors flag
room.peaceful The room has a peaceful flag
room.soundproof The room has a soundproof flag
room.notrack The room has a notrack flag
room.nomagic The room has a nomagic flag
room.house The room has a house flag
room.norecall The room has a recall flag
room.nosummon The room has a nosummon flag
room.crimeok The room has a crimeok flag
room.store The room has a store flag

See also: [[VARIABLES]], [[ROOM VARIABLES]], [[OBJECT VARIABLES]], [[SPECIAL VARIABLES]]

[[CATEGORY:Scripts]]

EXPRESSIONS

2008-11-20T10:24:19Z

Kahlan:

A false expression is any expression that evaluates to 0, or an empty string.
A true expression is any expression that evaluates to anything other than a
false expression. The following list are the recognized operators. The
higher the operator is on the list, the higher the precidence. The expression
is evaluated from left to right. Parenthesises can be used to group.

Operators Name Examples
--------- ---- --------
&& logical and 1 && 0 = 0; 5 && 3 = 1
|| logical or 0 || ( ) = 0; 5 || 0 = 1
== eqivalence 5 == 3 = 0; dog == DoG = 1
!= inequality 0 != Z = 0; dog != d = 1
- subtraction 15 - 10 = 5
+ addition 10 + 15 = 25
* multiplication
/ division
! negation !() = 1; !0 = 1; !dog = 0;

[[CATEGORY:Scripts]]

EXPRESSIONS

2008-11-20T10:23:46Z

Kahlan: