===========================
                       = Section 1. Introduction =
                       ===========================

  What is a Script? Before you can write one you need to understand what
they are for. As with a script for a play, a Script for an area is a set of
directives controlling the behavior and actions of the constructs of the
Game. In the realm of the Game there are three basic constructs: Objects,
Characters and Rooms. We can further break down Characters into two
distinct groups: Player Characters (PCs) and Non-Player Characters (Mobiles
or Mobs). As an area builder, you can directly influence the behavior and
actions of Objects, Mobiles and Rooms with Scripts. As for the PCs, they
are on their own.
  Scripts allow you, the area builder, to breath life into your creation.
No longer does a Mob have to stand in a room and provide a sense of action
via a description that the PCs read when they type: 'look <mob name>'. With
Scripts you can direct the Mob to greet the PC as he/she enters the room
and begin an interaction with them. No longer is a key always required for
a door. Instead, you can have an object that must be used in a certain way
in order to open the path to the next part of the area. While there are a
few things that Scripts can't do, for the most part you are only limited
by your imagination.

-Infoteq

How to Use this Guide
---------------------

Section 1:  Introduction
                You are here X.

Section 2:  Basic Structure
                This section examines the relationship between Scripts
                and triggers and provides a general idea of what the
                script file will look like.

Section 3:  Trigger Header
                This section breaks down the first section of a Script,
                known as the 'Header' and describes what information
                will be necessary for each field.

Section 4:  Trigger Types
                This section discusses the various types of Triggers
                available and what they do.

Section 5:  Script Directives
                This section discusses the body of the Trigger where the
                directives are written. It includes information about
                conditional statements as well as available functions.

Section 6:  Script Variables
                This section lists the various types of information that
                is available during the execution of a Script as well as
                how to store and manipulate information of your own.

Section 7:  Script Expressions
                In this section you will find information on the
                mathematical and comparison operators available for use
                during Script execution. 

Section 8:  Script Assignment
                From this section you will learn how to link the Scripts
                you have written to the specific Game constructs that
                you wish to have execute them.

Section 9:  Quick Reference
                For the experienced Script writer, this section provides
                a quick way to refresh your memory.

Section 10: Examples
                For the beginning Script writer, this section provides
                examples of how you might go about causing certain
                types of actions to occur.



                     ==============================
                     = Section 2. Basic Structure =
                     ==============================

Going back to our analogy of the Play, 'the Script' is a comprehensive 
listing of all the action and the dialog of the Play. In the same way, the 
term Script can be used to apply to all of the directives that you write 
for all of the Game constructs in your Area.
  Taking a step further, each actor/actress in a Play does not really need 
to worry about every piece of action and dialog in the Play, they only have 
to focus on the parts that concern them directly. Similarly, when you write 
a Script you will break up your list of directives and assign them to the 
Game constructs that need them.
  It wouldn't make very much sense for our actors to read the parts of 
another character in our play.  Therefore, we need to distinguish between 
different parts, so we can tell each character which parts they should 
read.  Therefore, we will give each part an Identifier.
  Now, each actor/actress has their parts, but they can't simply just start 
reading them whenever they feel like it. Everything has to be organized in 
such a way that the actors/actresses know when it's time for them to play 
their part. In exactly the same way the directives assigned to the Game 
constructs require a 'Trigger' so that they know when to execute their part 
of the Script.
  In order for the Game to understand what it is you want to happen, your 
Script has to be organized as a series of individual Triggers in a file.  
So, throughout the documentation we will refer to the idea of the 'Trigger' 
as the information that controls the activation and the 'Script' will be 
the set of directives that are executed when that Trigger is activated.  
In order to avoid confusion the term 'Trigger file' will be used to refer 
to what in Play terms would be 'the Script'.
   The Trigger file is read in to the Game when it starts up after a reboot 
or a crash. The Trigger files are named with the following format:  ###.trg 
Where ### is a three digit number used to identify your zone (Zone 20:  
020.trg, Zone 100: 100.trg). The leading zeroes are used only for the file 
names, everywhere else you will start with the first non-zero number.

Identifier
----------
We will give each part of our play two Identifiers.  The first Identifier 
is the VNum (Virtual Number), which must be different for each part.  VNums 
will follow the format XYY, where X is the number for your zone (X may be 
more than 1 digit), and YY is the number specific for that part.  VNums 
must always be increasing as you go down the Trigger file, but increments 
can be greater than one.  For example, if you were writing a Trigger file 
for zone 67, your first part could have the VNum 6700, and the second part 
6701, and the third 6702, and so on.
  The second Identifier we assign to our parts is the Part Name.  The Part
Name is simply a textual name by which the part may be referred by some 
special script commands.  In general, names that describe either the Trigger 
or the Script are best, but you can name it whatever you want.  In general, 
it is wise to give each part a different Part Name, but it is not required.  
Note that you also need to distinguish your parts from the parts in other 
areas, so it is often wise to have your Part Name include a reference to 
the name of the zone.
  As an example, if you were writing a part for an area called Wyverns' 
Stone, and the trigger related to answering a riddle, then the Part Name 
might be "wyverns stone riddle answer".

Trigger
-------
Triggers for a part are covered in Sections 3 and 4.

Script
------
What you can do within a Script is discussed in sections 5 through 7.


File Format
-----------
When writing a part, the Trigger file has the following format:

            #<VNum>
            <Part Name>~
            Trigger Line 2
            Trigger Line 3
            Script Line 1
            Script Line 2
            Script Line 3
            ...
            Script Line n
            ~
            ...
            ...
            $~

The first line of a part must be a # followed by the VNum.  The second 
line must be the Part Name, followed by a ~.  The Identifier of each part 
has to always appear at the top, so it is easy to recognize where one part 
end and the next one begins.  The third and fourth lines of the part are 
the Trigger lines.  There will always be two lines for the Trigger, and 
they must always be the third and fourth lines of the part, right after 
the Identifier.  They have to come before the Script, since the Trigger has to 
occur before the Script can be read.  The Script itself follows the Trigger, 
with as many commands as are necessary.  At the end of the Script, there 
must be a ~ to separate the current part from the next one.  At the end 
of a Trigger file, $~ should be placed on the last line.



                           ======================
                           = Section 3. Trigger =
                           ======================

The Trigger for each part contains the information that describe what needs 
to occur before the Script can be enacted.  Triggers are always two lines, 
after the two lines of the Identifier.  There are five components to each 
Trigger: Trigger Type, Number, PercAct, Options, and Argument.

Trigger Format
--------------
The Trigger has the following format:

            <Trigger Type> <Number> <PercAct> <Options>
            <Argument>~

The first line is the Trigger Type, Number, PercAct, and Options, each 
separated by a single space.  The second line of the Trigger is the Argument, 
followed by a ~.

Type
----
The Trigger Type sets the actions which must occur for a trigger to 
activate.  Since the Trigger Type is a bitvector, it is possible to have 
one Trigger activate under many different conditions.  However, some 
Trigger Types place restrictions on what can go into the Number, Options, 
or Argument fields, so care should be used when doing this.  A list of 
Trigger Types and their explanations are in section 4.  An explanation of 
bitvectors can be found at the end of this section.

Number
------
The Number field for a Trigger is an integer value which is used by some 
Trigger Types to determine whether the script executes.  The exact usage 
of the Number field is specific to each Trigger Type, and detailed further 
in section 4.  Even if the Trigger Type does not use the Number field, some 
value must still be placed in this field (though it will have no effect 
on the Trigger).  The default null value is to use 0 as the Number field.

PercAct
-------
The Percent Activation (PercAct) field is the percent chance that a Trigger 
will activate given that all of the other conditions set by the Trigger 
Type are met.  This field must be an integer between 0 and 100, inclusive, 
where a value of 0 means the Trigger will never activate, and 100 means it 
will always activate.

Options
-------
The Options field for a Trigger declares Class-specific conditions for a 
Trigger's activation.  There are three Classes of Triggers based on the 
game constructs the Trigger will be attached to: Mob Triggers, Object 
Triggers, and World (or Room) Triggers.
  Currently, the Options field is only used for object constructs.  This 
field is a bitvector which determines where the object must be in order 
for the trigger to run.  If the trigger will work when the object is 
equipped, 'a' must be set.  For the inventory, 'b' must be set.  For 
being on the ground in the same room, 'c' must be set.  Like all bitvectors, 
combinations are allowed, so ab means the trigger will work if the object 
is in inventory, or equipped.  An explanation of bitvectors can be found at 
the end of this section.
  For triggers on mob and room constructs, a value of 0 should be placed in 
the Options field.

Argument
--------
The Argument of a script is a value whose use is dependent on what the 
Trigger Type is.  The Argument can be a number, or a word, or anything 
else that fits on one line.  Spaces are acceptable for multiple words.  
The use of the Argument is covered in Section 4.


3.1. Bitvectors
---------------
Bitvectors are simply a set of letters used to define what options are going 
to be set.  The letters work like a series of on-off switches, where the 
letters which appear in the definition determine which switches are on.  For 
example, a bitvector might look like 'acdhi'.  In this case, switches a, c, 
d, h, and i are all "on", while the switches for all letters not listed are 
off.

If no switches are on, the bitvector will be 0.  A value of 0 should be 
placed in the definition to show the absence of other values.



                       ============================
                       + Section 4. Trigger Types +
                       ============================

The following is a list of Trigger Types.  The name and bitvector of each 
Trigger Type is given, followed by a brief description of the Trigger Type.  
After the description, the Classes that the Trigger Type work on are given, 
where the Classes are the Game constructs which can use scripts: mobs, 
objects, and rooms.  Then, the use of the Number, PercAct, and Options fields 
and the Argument for that Trigger Type are defined.  The effects of the 
Return variable (used by the 'return' command, section 5) are given.  
Finally, if the Trigger Type sets any variables automatically, the name and 
value of the variables will be given (more information on variables appears 
in section 6).
  Only one Type of each Trigger can go off at a time on a single mob/object/
room.  For example, if a mob had two Triggers of Type 'n' (when it receives 
an object), if the first trigger goes off, the second one will never be 
checked.  Therefore, it is often wisest to avoid multiple Triggers of the 
same Type on a single mob/object/room.
  If there is some type of trigger which is not covered by the ones listed 
here, more can be added by request.


Global [a]
    In order to conserve memory, Triggers are normally only checked for 
    when I PC is in the same zone as the component with the Trigger.  
    However, there may be instances where a Trigger needs to execute even 
    when there are no PCs present.  If a Trigger is Global, then it can 
    activate even when PCs are not present.  The Global Trigger Type should 
    be used with other Trigger Types, as it will do nothing by itself.
  Class	   : All.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : Not used.
  Variables: None.

Random [b]
    This trigger is checked every 13 seconds.
  Class    : All.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : Not used.
  Variables: None.

Command [c]
    This trigger is checked whenever a character types a command in the same 
    room as the trigger.  If the command typed is a substring of the argument, 
    the trigger is called.  This trigger type could be used to create a new 
    command or override the way an existing command works.  For example, 
    there is no default 'pull' command, but a trigger of this type with an 
    Argument of 'pull' would allow a character to pull a lever.
  Class    : All.
  Number   : The minimum length of the substring that will match.  For 
               example, if the Argument was 'switch' and the Number was 
               3, then 'swi', 'swit', 'switc', and 'switch' would all work, 
               but 's' or 'sw' would not.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : The command name, one word.
  Return   : If 1, the character will execute the command as normal, in 
               addition to the trigger activating.
             If 0, the command is handled by the trigger, and the normal 
               affect of typing that command is ignored.
  Variables:
        actor     - The character typing the command.
        arg       - The full argument of the command (everything typed 
                      after the command word).
        arg1      - The first word of the argument line.
        arg2      - The second word of the argument line.

Speech [d]
    This trigger is checked whenever someone says something around this 
    trigger.  
  Class    : All.
  Number   : If 1, then words in the word list may not be substrings.
             If 0, then words in the word list may be substrings of other 
               words in the speech.
             For example, if the Argument was 'puff', and someone said 
               'puffy', then the trigger would activate if the Number was 0, 
               but not if the number was 1.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : The phrase or word list to be matched.  Phrases, if they must 
               be matched exactly, may be enclosed in double quotes.  For 
               example, if the Argument was 'puff "fractal dragon"', then 
               speech with the word 'puff', or speech with the phrase 
               'fractal dragon', would match.
  Return   : Not used.
  Variables:
        actor     - The character speaking.
        speech    - What was said.

Act [e]
    This trigger runs when Argument is a substring of a string of text that 
    a mob sees.  In other words, the mob will act the way you specify based 
    on an action that it can see.  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.
  Class    : Mob only.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : The phrase or word list to be matched.
  Return   : Not used.
  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     - The primary character in the text.
        victim    - The secondary character in the text.
        object    - The primary object of the text.
        target    - The secondary object of the text.
        arg       - The variable string portion of the text.
        arg1      - The first word of the text line.
        arg2      - The second word of the text line.

Death [f]
    This trigger is checked when a character dies.  If this Type of trigger is 
    on a mob, then only the mob's own death will activate this trigger.
  Class    : All.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : If the return value is 1, the death cry (such as 'Your blood 
             freezes as you hear the beastly fido's death cry.') will not 
             be heard.  If the return value is 0, the normal death cry will 
             be heard.
  Variables:
        victim    - The victim.
        killer    - The killer, if there is one.

Get [g]
    This trigger is checked whenever an item is picked up or removed from a 
    container.  If this Type of trigger is on an object, the trigger will 
    only work on that object.
  Class    : Object or Room only.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : If 1, the object is taken/removed from container.
             If 0, the object is not picked up/removed from container.
             If -1, the object is taken but the standard message, such as 
               'Puff gets a Rubik's Cube.' will not be shown.
  Variables:
        actor     - The mob that picks up the object.
        object    - The object being taken.

Drop [h]
    This trigger is checked when a character attempts to drop an object.  If 
    a trigger with this Type is on an object, the trigger will only work on 
    that object.
  Class    : Object and Room only.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : If 1, the object is dropped.
             If 0, the object is not dropped.
             If -1, the object is dropped but no messages, such as 'Puff 
               drop a Rubik's Cube.' are sent.
  Variables:
        actor     - The character attempting to drop the item.
        object    - The object being dropped.

Enter [i]
    This trigger is checked whenever someone enters the room.  This trigger 
    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 command, or teleport the character.  If a trigger of this Type 
    is on a mob, the mob must be able to see the person entering for the 
    trigger to activate.
    (See Script Commands for more information on wait and teleport.)
  Class    : Mob and Room only.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : 1 if the player is allowed to enter.
             0 if prevention of player's entry.
             -1 will prevent entry and disable all messages/room descs.
  Variables:
        actor     - The character entering the room.
        direction - The name of the direction the actor entered from.

Exit [j]
    This trigger is checked whenever someone exits the room.  This trigger 
    is checked just before the character exits the room, so if you want the 
    action to occur in the room the character is leaving to, you must use a 
    wait command, or teleport the character.  If a trigger of this Type is 
    on a mob, the mob must be able to see the person exiting for the 
    trigger to activate.
    (See Script Commands for more information on wait and teleport.)
  Class    : Mob and Room only.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : If 1, the player is allowed to exit.
             If 0, the player will be prevented from exiting.
             If -1, exit will be prevented and all messages/room descs will 
               be disabled.
  Variables:
        actor     - The character that exited the room.
        direction - The name of the direction the character exited to.

Greet [k]
    This trigger is checked every time the mobile enters a room.
  Class    : Mob only.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : If 1, the mobile is allowed to enter.
             If 0, the mobile is prevented from entering.
  Variables:
        direction - The name of the direction the mobile entered from.

Farewell [l]
    This trigger is checked every time the mobile exits a room.
  Class    : Mob only.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : If 1, the mobile is allowed to exit.
             If 0, the mobile is prevented from exiting.
  Variables:
        direction - The name of the direction the mobile exiting to.

Give [m]
    This trigger is checked whenever someone attempts to give away the object.
  Class    : Object only.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : If 1, the object is given.
             If 0, the object is not given.
             If -1, the object is given but no messages, such as 'Puff gives 
               Infoteq a Rubik's Cube.' are sent.
  Variables:
        actor     - the character giving the object
        victim    - the character receiving the object

Receive [n]
    This trigger is checked when an object is given.  If a trigger of this 
    Type is on a mob, the trigger will only activate when the mob receives 
    an object.  If on an object, it will only activate when that object is 
    received.
  Class    : Mob or Object only.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : If 1, the object will be received.
             If 0, the object will not be transfer.
             If -1, the object will be received, but no messages, such as 
               'Puff gives you a Rubik's Cube.' will be sent.
  Variables:
        actor     - The character giving the object.
        victim    - The character receiving the object.
        object    - The object being given.

Wear [o]
    This trigger is checked whenever someone attempts to wear the object.
  Class    : Object only.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : If 1, the object is worn.
             If 0, the object is not worn.
             If -1, the object is worn, but no messages, such as 'You wear 
               a spacesuit on your body.' are sent.
  Variables:
        actor     - The character that is attempting to wear the object.

Remove [p]
    This trigger is checked whenever a character attempts to remove the item
    from their equipment.
  Class    : Object only.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : If 1, the object is removed.
             If 0, the object is not removed.
             If -1, the object is removed, but no messages, such as 'You 
               stop using a spacesuit.' are sent.
  Variables:
        actor     - The character attempting to remove the object.

Fight [q]
    This trigger is checked every round a character is fighting, after 
    the character has had all its attacks.  If a trigger of this Type is 
    on a mob, then the mob must be involved in the combat.
  Class    : Mob or Object only.
  Number   : Not used.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : Not used.
  Variables:
        actor     - The character the mob is fighting.
        victim    - The character being fought.

Bribe [r]
    This trigger is checked when some type of currency is given to a mob.
  Class    : Mob only.
  Number   : The minimum amount of currency that must be given to the mob 
               for the trigger to be run.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Type of currency, which can be one of 
               Credits, Gold, Copper, Platinum, Yen, 
               Yuan, Silver, Opal, Bloodstone.
  Return   : Not used.
  Variables:
        actor     - The character giving the mob the coins.
        amount    - The number of coins given to the mob.
        currency  - The type of currency used.

Invoked [s]
    This trigger is used as a subroutine of another trigger type. Configuring
  a trigger as Invoked allows it to be called with the call <vnum> command.
  Class    : All.
  Number   : 0 = Retain Trigger after Execute.
             1 = Remove Trigger after Execute.
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : Not used.
  Return   : Not used.
  Variables:
        All local variables are copied from the calling trigger.

Load [t]
    This trigger is checked when an object or mob is created in the game.
  Class    : Mob or Object only.
  Number   : Not used.
  PercAct  : 0 - 100.
  Options  : See section 3.
  Argument : Not used.
  Return   : Not used.
  Variables:
        None.

Destruction [u]
    This trigger is checked when an object is destroyed with object damage.
  Class    : Any.
  Number   : Not used.
  PercAct  : 0 - 100.
  Options  : See section 3.
  Argument : Not used.
  Return   : Not used.
  Variables:
        actor     - The character who destroyed the object.
        destroyed - The object that was destroyed.

Unload [v]
    This trigger is checked when an object or mob is removed from the game.
  This is slightly different from the death and destruction trigger in that
  it activates on any reason that the object or mob is removed.
  Class    : Mob or Object only.
  Number   : Not used.
  PercAct  : 0 - 100.
  Options  : See section 3.
  Argument : Not used.
  Return   : Not used.
  Variables:
        None.

Mission [w]
    This trigger is checked whenever a mission is accepted, aborted or
    completed.
  Class    : All.
  Number   : 0 - Mission is Accepted
	     1 - Mission is Completed
	     2 - Mission is Aborted
  PercAct  : 0 - 100
  Options  : See section 3.
  Argument : <Mission VNum>
  Return   : Not used.
  Variables:
	actor     - The character actioning the mission.


                      ==============================
                      = Section 5. Script Commands =
                      ==============================

There are a number of special commands which can be used in the body of
a trigger.  Each command requires additional information which must be
supplied.  This additional information, called arguments, is represented by
words contained in <> or [].  Each argument in <> must be replaced by a
value or variable.  Each argument in [] is optional; either a value or
variable can be supplied, or nothing can be provided.  In general, unless
otherwise specified, each argument may only be one word or number long; in 
other words, spaces and tabs should not be used within one argument.  
Special arguments include :

    victim - If a command has an argument called 'victim', then the command
             expects a character (PC or mob), specified either by name or 
             UID.  If the argument is replaced by 'all', then all characters 
             in the room are affected.

    target - If a command has an argument called 'target', then the command 
             expects a room specified by vnum, or a character specified by 
             name or UID, or an object specified by name.  If a room is 
             specified, it may not be a god room, or a cross plane of 
             existence.


Mob Commands
------------
Mobs can use any game command available to a mortal player character of 
the same level as the mob, in addition to the other script commands.


Comments
--------
Comments allow you to put explanations or notes into your triggers, without 
having them actually do anything.  This may be useful as a reference to 
other people (such as the script debuggers) in explaining what a trigger is 
supposed to be doing for convoluted commands.

* <text>
  An '*' at the beginning of a line is a comment.  The rest of the line is
  ignored.  This may only be used within the body of a script.  The <text> 
  may be more than one word long.

    Example:  * This is a comment.

slog <text>
  Adds <text> to the script log.  The <text> may be more than one word long.  
  This should be used to indicate error messages in the log, or can be used 
  in debugging.

    Example:  slog This line will go into the log.


Variable Commands
-----------------
These commands allow variables to be modified in a number of ways.  For each 
of these commands, the first argument is <variable>, which should be replaced 
with the name of a variable (do not use %'s around the variable).  See 
section 6 for more information on variables.

eval <variable> <value>
  Evaluates <value>, and sets <variable> to the result.  See section 8 for 
  details on how expression evaluation works.  The <value> may be more than 
  one word long.

    Example:  eval foobar 15 - 5
              Sets the variable foobar to the value 10.

set <variable> <value>
  Sets the <variable> to <value>, without evaluating <value>.  The <value> 
  may be more than one word long.

    Example:  set foobar Dweezle
              Sets the variable foobar to the string "Dweezle".

    Example:  set foobar 15 - 5
              Sets the variable foobar to the string "15 - 5".

global <variable>
  Changes <variable> into a global variable.

zglobal <variable>
  Changes <variable> into a zone-global variable.

unset <variable>
  Eliminates the <variable> if it exists.  If there are multiple types of 
  variable with the same name (a local variable and a global variable and 
  a zone global variable), then unset will work on the zone global variable, 
  then the global variable, then the local variable.


Conditional Statements
----------------------
It may be necessary for some triggers to have commands occur only if some 
conditions are met.  For example, you may want to have a trigger only work 
if a character is carrying a specific item.  Conditional statements allow 
a number of commands to only occur if a specified condition exists.

if (<expression>)
   ...
[elseif (<expression>)]
   ...
[else]
   ...
end

  An "if" must occur before the other three.  If the <expression> evaluates 
  to true (see Section 8 for expression evaluation), the statements between 
  the "if" statement and the next "elseif", "else", or "end" are executed.  
  If it stopped at an "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.  The <expression>s may be more than one 
  word long, but they must be contained within parentheses.

    Example:  if (5 > 6)
                say 5
              elseif (5 < 6)
                say 6
              else
                say equal
              end

              In this case, since 5 is always less than 6, the command 
              "say 6" will always occur.

    Example:  if (%x% > %y%)
                say %x%
              elseif (%x% < %y%)
                say %y%
              else
                say equal
              end

              In this example, the greater variables will be said, unless 
              they are equal, in which case "equal" will be said.

while (<expression>)
   ...
[continue]
   ...
[break]
   ...
done

  A "done" must occur before a "done".  If the <expression> evaluates 
  to true (see Section 7 for expression evaluation), the statements between 
  the "while" and the next "done" are executed.  Afterwards, the process is 
  repeated, with the <expression> again being evaluated, and if true, the 
  statements in between the "while" and "done" being executed.  This repeats 
  until <expression> evaluates to false.  The statement "continue" will 
  cause none of the statements between the "continue" and the "done" to be 
  evaluated, and instead the script will go back and check the "while" 
  statement again, starting over.  A "break" statement will cause the script 
  to skip all of the commands between the "break" and "done" statements, 
  and begin executing statements after the "done" statement.  The 
  <expression> does not get checked again, if a "break" statement is 
  evaluated.  The expression may be more than one word long, but it must be 
  contained within parentheses.

switch (<expression>)
  case <val1>
     ...
  [case <val2>]
  [case <val3>]
     ...
    [break]
  [default]
     ...
done

  A "switch" must occur before a "done".  The <expression> will be 
  evaluated, and then the script will go to the first "case" statement whose 
  <val> is equal to the <expression>.  It will then begin executing 
  statements from that point onward.  If none of the "case" statement's 
  <val> match the <expression>, the script will go to the "default" 
  statement and execute the statements from that point onward.  If there is 
  no "default" statement, then the script will instead go to the "done" 
  statement, and proceed from there.  If a "break" statement occurs, the 
  script will go to the "done" statements, skipping all commands in between, 
  and begin executing from there.  The expression may be more than one word 
  long, but must be contained within parentheses.


Message and Display Commands
----------------------------
These commands allow you to display messages in a variety of ways.  With all 
of these commands, the last argument (called <message>) can be multiple words 
long.  When using any of these commands, if you want to send a message about 
a specific mob or object, you may need to use subwrite operators.  Subwrite 
operators allow you to alter the message based on whose point of view the 
message is being seen from.  For example, if you wanted to send the message 

    Dranor slays Puff with a mighty bolt of lightning!

you would want Dranor to see the message

    You slay Puff with a mighty bolt of lightning!

and Puff to see the message

    Dranor slays you with a mighty bolt of lightning!

Section 6 explains how to use these operators.

sasound <message>
  Echos <message> to the all the rooms around the room that the script 
  is run from (all the rooms that are exits from the current room).

secho <message>
  Sends the <message> to everyone awake in the same room as the script.

sechoaround <victim> <message>
  Sends the <message> to everyone in the room except for the <victim>.  If 
  called from a script on a mob, the mob will also not receive the <message>.  
  The <victim> must be in the same room as the script.

sechoaroundto <victim> <message>
  Sends the <message> to everyone in the room with <victim> except for the 
  <victim>.  The <victim> can be in a different room from the script.

ssend <victim> <message>
  Sends <message> to <victim>.  The <victim> must be in the same room as the 
  script.

ssendto <victim> <message>
  Sends <message> to <victim>.  The <victim> does not need to be in the same 
  room as the script.

szoneecho <zone> <message>
  This command will send <message> to everyone in an entire <zone>.  The 
  <zone> should be specified by zone number.


Creation and Destruction Commands
---------------------------------
These commands allow scripts to create and destroy mobs and/or objects.  These 
messages will not display any messages, so if you would a visual indication 
for the players of something happening, you will have to display it manually.

sgive <vnum> <victim>
  Loads and gives object with virtual number <vnum> to <victim>.

sdrop <object>
  This command can only be used on mob construct triggers..
  Drops the <object> in the mob's inventory, but without displaying a message 
  to the people in the room.  If <object> is 'all', all objects in the mob's 
  inventory and equipment, and all money the mob has will be dropped.  If 
  <object> is 'all.*', where '*' can be anything, all objects that match * 
  will be dropped.

sjunk <object>
  This command can only be used on mob construct triggers.
  Junks the <object> in the mob's inventory.  If <object> is 'all', all
  objects in the mob's inventory and equipment, and all money the mob has 
  will be junked.  If <object> is 'all.*', where '*' can be anything, all 
  objects that match * will be junked.

sload <type> <vnum>
  Loads a mob or object with virtual number <vnum> into the game.  <type> 
  should be one of 'obj' or 'mob'.  If called from a script on a mob, 
  notake objects are loaded into the mob's room, and all other objects are 
  loaded into the mob's inventory.  Otherwise, all mobs/objects are loaded 
  into the room from which the script is run.  The object or mob's vnum 
  must be specified; the name will not work.

spurge [<target>]
  <target> must be a mob or an object, for this command.  PCs are not affected.
  Removes <target> from the game.  If no argument is given, then all 
  objects and mobs in the room will be removed.


Action Commands
---------------
There are a number of standard actions, such as moving or casting spells, 
which can be done in advanced ways within scripts.  These commands allow 
these special actions.

scast '<spell>' <victim>
  This command can only be used on mob construct triggers.
  Casts <spell> on <victim>.  <spell> is limited by the level of the mob.  
  The mob's spheres do not affect which spells can be used.

sforce <victim> <command>
  Forces the <victim> to perform the <command>.  The <command> can be more 
  than one word long.  No message is sent to the <victim>, except what is 
  caused by the <command>.  Immortals are not affected.

sgoto <target>
  This command can only be used on mob or object construct triggers.
  Moves the mob/object to the <target>.  No message is displayed by this 
  command.

sput <object> <container>
  Puts <object> into <container>.  No message is displayed by this command.

steleport <victim> <target>
  Moves the <victim> to the <target>.  No message is displayed by this 
  command.

swalk <target> <time>
  This command can only be used on mob construct scripts.
  Forces the mobile to walk towards the <target> one step every <time> 
  seconds.  If there is no clear path to the <target> from the current 
  location on any given step, then the mob will teleport directly to the 
  target on the next step.


Value Alteration
----------------
These commands allow you to change certain values and parameters on some 
mobs, objects, and/or rooms.  Not all statistics can be changed via scripts, 
and care should be given to not set bad or conflicting states.

salter <target> <field> <value>
  Alters the <target> such that the specified <field> is now the <value>.  
  The <value> may be more than one word long.  For a more detailed description 
  of what each field means, look at the builder documentation.

      Valid <field> for mobiles:
              name              - namelist
              short             - short description
              long              - long description
              description       - (look at soandso)
              flags             - ACTIONS flags
              generic           - generic integer value. use at will.
              spells            - SPELLS flags

      for objects:  
              name              - namelist
              short             - short description
              long              - long description
              action            - action description
              flags             - XTRAS flags
              generic           - generic integer value. use at will.
              timer             - timer for object fading (in minutes, 0=off)
              spells            - SPELLS flags
              value             - value fields
              owned             - owner
              rent              - rent value (unused. use at will)

      for rooms:
               name             - room name
               description      - room description
               flags            - XTRAS flags
               sector           - Room Sector

  Flags are the special flags for that particular game element. Refer to 
  the builder docs for a complete list. The full syntax of the flags 
  command is:  salter <target> flags X Y

  To find the value of X :
    Find the Flag you want to add/remove/toggle in the builder docs.  Take 
    the line that it shows up on. 0 for the first line, 1 for the second 
    line, etc.  Multiply the number you just got by 2.  If the letter that 
    corresponds to that flag is capital, add 1 to the line number.
  To find the value of Y :
    Take the letter of the flag.  If it is uppercase, use the lowercase 
    version.

  Let's say you need ROOM_DARK.  ROOM_DARK appears on the first line, so we 
  start with a value of 0.  We multiply it by 2, getting 0.  Since ROOM_DARK
  is 'a' (lowercase), we don't add one.  Therefore, our command would be:

        malter %room% flags 0 a

  In this instance, ROOM_DARK would be toggled on the room. If you place an 
  operator of "+" in front of the "a" it would only be added. If you place a 
  "-" the "a" would only be removed. If you place a "=" then "a" would be the 
  only flag set on the room. Without an operator it is always toggled on/off.

scurrency <victim> <type> <amount>
  Adjusts <victim>'s currency of <type> by <amount>.  <type> can be any 
  valid type of currency as a string (Credits, Gold, etc).

sdoor <room> <direction> <field> <value>
  <room> is the vnum of the room.
  <direction> is the direction of the exit.  You may use the doorname here.
  <field> is one of:   purge, description, flags, key, name, room.
  <value> is whatever is appropriate for the <field>
        purge - None (Deletes the Exit in direction)
        flags - Any valid door flag as per letter defined for exits.
                If you place a minus "-" before the flag list it will remove 
                those flags.  If you place a plus "+" before the flag list, 
                it will add those flags.  If you place a equal "=", the flags 
                will be set to exactly that.  If you just place the list of 
                flags it will toggle them.
        key   - VNum of the key that unlocks the door.
        name  - Names of the door if any.
        descr - Text displayed when player types look <direction>
        room  - VNum of room exit leads too.

sexp <victim> <amount>
  Changes the <victim>'s experience by <amount>. 

smission <character> <action> <mission vnum> <objective id> <value>
    Interacts with the mission data stored on a character. Mission data may
  be associated with a defined mission or the script may use the mission
  data as a way of storing information on a character that gets saved.
    If the create option is used and there is no objective 0 and the current
  create is not for an objective 0, the system will automatically create an
  objective 0. Do not delete this objective unless all objectives are being
  deleted for the mission.
  <character> The character whose mission data is to be examined.
  <action> c - create
           u - update (value added to existing)
	   s - set (value overwrites existing)
           d - delete
  <mission vnum> The vnum of the mission.
  <objective id> The id of the objective to be examined.
  <value> For create, and set this is the value to be set. For update
  this is the value to be added to what is already on the character. For
  delete, this field is not used so leave it blank. Value is stored as
  a long integer on the character.

sprogress <character> <mission vnum> <objective id> <variable name>
    Accesses the mission data on <character> and finds the value associated
  with objective <objective id> for mission <mission vnum> and puts that
  value into a variable called <variable name>. This command is used to
  evalute the mission data stored on the character.

sset <target> <option> <value>
  Sets an <option> to a specific <value> on <target>.  The only option
  that you should set on a character is alignment.

      hit             maxhit          mana            maxmana
      move            maxmove         psyche          maxpsyche
      ob              db              damage          absorption
      numattacks      bhd (see note)  attacktype      align
      blockdir        blockkey        profession      sphere
      strength        stradd          dexterity       constitution
      intelligence    wisdom          charisma        ego
      position

      BHD requires special formatting of the command as follows:
              sset <target> bhd <x>d<y>

      Sphere and BlockDir use the same bitvectors as they are listed in the 
      builder docs.  Profession uses the same bitvectors as they are listed 
      in Section 7.  You can use a "+" to add, a "-" to remove, "=" to set 
      or no operator to toggle the bitvector.

      Position can be any of the following values, though *extreme* care 
      should be used when changing position in a script, especially for 
      the positions with a * next to them.
          *dead               stunned     sitting
          *mortally wounded   sleeping    *fighting
          *incapacitated      resting     standing


Trigger Manipulation
--------------------
These commands allow special handling of triggers.  Triggers can be added or 
removed, or caused to execute even if the preconditions for them occurring 
haven't happened.

call <script>
  Causes <script> to execute.  <script> can be specified by virtual number 
  or by name.  When <script> is called, if a copy of <script> is already 
  attached and not yet in the process of executing, the existing copy will
  begin to execute as though the conditions for it to do so had been 
  fulfilled.  Otherwise, a new copy of the trigger is attached (even if this 
  makes multiple copies of the same trigger on the same thing), and the new 
  copy begins to execute as though the conditions for its execution had 
  occurred.

halt
  Ends the trigger execution.

return <value>
  Sets the return value of the trigger.  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 trigger's execution.
    If you wish to change the return value from the default you must do so
  before you use the wait or halt commands. Once the Trigger pauses or
  stops, the return value is delivered to the system regardless of what
  happens later in the Script.

sattach <type> <vnum> <target> [<Xth>]
  Attaches a trigger with virtual number <vnum> to <target>.  <type> should 
  be one of 'm', 'o', or 'w', to specify whether <target> is a mob, object, 
  or room, respectively.  If <Xth> is specified, the trigger is attached as 
  the <Xth> trigger on the <target>.

sdetach <type> <target> <script>
  Detaches <script> from <target>.  <type> should be one of 'm', 'o', or 'w' 
  to specify whether <target> is a mob, object, or room, respectively.  
  <script> can be specified by name or vnum, and can be more than one word 
  long (in the case of multiple word script names).

wait <number> [<type>]
wait until <HH>:<MM>
  Causes the trigger to pause for a certain length of time.

  If <number> is specified but <type> is not, the trigger will wait for 
  <number> script pulses (currently 1/10 second, but subject to change).  
  <type> can be 's', which will cause the trigger to wait for <number> 
  seconds, or 't', which will cause the trigger to wait for <number> mud 
  hours (ticks).

  If 'until' is used, the trigger will wait until an exact mud time, where 
  <HH> is the hour (24hr format), and <MM> is the minutes.

  If you use a 'wait', until the trigger is fully processed it will not 
  activate on anyone else.  You should keep this in mind especially for 
  greet triggers.  If you start it off with a 'wait' you should use 'say' 
  for the text.  That way everyone in the room sees it.  If you don't use a 
  'wait' you should use 'ssend'/'sechoaround' because otherwise every person 
  will trigger the greet and get everyone else's messages.


Relocation Commands
-------------------
Commands within a script can be relocated to a different room.  For example, 
a trigger on a mob can cause the mob to drop an item in a different room than 
the mob is currently in.

sat <target> <command>
  Perform the <command> at the <target>.  The <command> can be any other 
  command allowed in a script, and thus can be more than one word long.



                         ========================
                         = Section 6. Variables =
                         ========================

A variable is a holder of information.  It refers to some other value or 
game element, like a mob or an object.  Within a trigger, it can be used in 
place of the thing it refers to.  Variables are denoted by surrounding them 
with %'s, so a variable named 'actor' would be %actor% when used within a 
script.  All variable names are case insensitive, so %actor% is the same as 
%Actor%, or %AcToR%.  All variables automatically exist, and have a default 
value of an empty string ("").  Some variables are always defined, a list 
of these special variables is provided at the end of this section.  Also, 
some variables are automatically defined based on the Type of the trigger.  
Refer to section 4 for a list of these variables.

Fields
------
Certain types of variables can have fields associated with them.  Fields 
specify a specific trait about the variable.  For example, a variable 
referring to a mob would have a field for the mob's mana, and another field 
for its race, and another for its strength.  The fields of a variable follow 
the variable, and are separated from it by a '.'.

For example, if there was a variable %actor% which referred to a mob, and 
you needed to know how much mana the mob has left, then you would use 
%actor.mana%.  A list of possible variable fields is provided at the end of 
this section.

Location
--------
A variable can exist in four possible location.  The first location is a 
local variable.  Local variables can only be used in one trigger, and will 
be reset to "" once the trigger is finished.

The second type of variable is a global variable, which can be used in 
all triggers on the same game object.  For example, if a mob has a global 
variable, all triggers on that mob will be able to use that variable, but 
triggers on a different mob, or on an item, would not be able to use that 
variable.  It does not reset to "" when a trigger finishes.

The third type of variable is a zone-global variable.  These variables can 
be used by all triggers in the same zone.  For example, if a mob trigger 
defines a zone-global variable, then all other triggers on that mob, every 
other mob in the same zone, every item in the same zone, and every room in 
the same zone, all could use that variable.  Zone global variables do not 
reset to "" when a trigger finishes.

The final type of variable are the special variables.  These variables are 
always defined, but may vary depending on which triggers they are called 
from.  See the list at the end of this section for a list and explanation 
of the special variables.  An example of a special variable would be a 
variable that creates random numbers.

It is possible for variables in different locations to have the same name.  
For example, there could be a local variable %name% and a global variable 
%name% and a zone-global variable %name%.  If something like this ever 
occurs, when the variable %name% is used in a script, it will first check 
for a local variable, then it will check for a global variable, then it will 
check for a zone-global variable, and finally it will check for a special 
variable.


Mob/Character Variable Fields
-----------------------------
The following is a list of fields which can be used with mob or character 
variables.

    name            The character's name.
    id              The characters unique ID.
    idnum           The characters idnum.
    alias           Mobile's name list.
    vnum            The character's virtual number.  -2 for PCs.
    room            Virtual Number of Room character is in.
    zone            The zone the character is in.
    clan            Character's clannumber.
  !!flags.X         The ACT flags set on a mobile.  0 for PCs.  See the 
                      builder docs for a list of flags.
  !!affected.X      The spells affecting a character.  See the builder docs 
                      for a list of flags.
    immune.X        The immunity to different attack types.  X is one of:
                      Heal, Fire, Water, Earth, Air, Energy, 
                      Corrupt, Blunt, Slash, Pierce
    cyber           Bitvector of cyber implants on a player.  0 if none.
                      See table at the end of this section for bit values.
    profession      Bitvector of the character's profession(s).  0 if none.
                      See table at the end of this section for bit values.
    fighting        Person the Character is fighting, if any.
    master          Person the Character is following, if any.
    level           The character's current level.
    pc              1 if the Character is a PC.  0 otherwise.
    npc             1 if the Character is a Mobile.  0 otherwise.
    currency.X      Amount of type of currency they have.  X is one of:
                      Credits, Gold, Copper, Platinum, Yen,
                      Yuan, Silver, Opal, Bloodstone
    sex             The character's sex, as a string (MALE, FEMALE, or 
                      NEUTRAL).
    canbeseen       1 if the Character can be seen by the Mobile.  This only 
                      makes sense within a mob class trigger.
    position        The character's current position.  Values include:
                        dead, mortally wounded, incapacitated, stunned, 
                        sleeping, resting, sitting, fighting, standing
    race            The character's race, as a string.
    subrace         The SubRace of a Mobile.  See builder docs for a list of 
                      subraces.
    str             The character's strength.
    stradd          The character's strength add.  For example, in a strength 
                      of 18/100, 100 is stradd.
    int             The character's intelligence.
    wis             The character's wisdom.
    dex             The character's dexterity.
    con             The character's constitution.
    cha             The character's charisma.
    ego             The character's ego.
    align           The character's alignment.
    height          The character's height.
    weight          The character's weight.
    essence         The character's essence.
    hit             The character's current hit points.
    hit.max         The character's maximum hit points.
    mana            The character's current mana points.
    mana.max        The character's maximum mana points.
    move            The character's current move points.
    move.max        The character's maximum move points.
    psyche          The character's current psyche points.
    psyche.max      The character's maximum psyche points.
    eq.X            This is the object in the eq position X, if any.  X is 
                      the text string of the wear position.  For fingers, 
                      RFINGER and LFINGER.  For wrists, RWRIST and LWRIST.  
                      For neck, NECK1 and NECK2.  All others as per the 
                      builder docs wear position table.
    has.X           Object that character has in eq or ready inventory
                      with vnum X.
    carrying        First object in inventory.
    nextinroom      Next character/mob in room.
    nextinworld     Next character/mob in Master Character List.
    nextconn        Next character with a live connection to the game.
    generic         A integer value that's stored on the character itself.
                      Scripts often use this variable to store information.
    nexist          How many of that mobile exist in the game.
    beamed          The room the character was beamed from, if any.
    rank            Character's Rank in a Guild.
    accum           Character's Guild Accum.
    points          Character's Guild Points.
    seed            Character's Guild Seed.
    rejuv           Number of years the character has rejuvinated.
    damroll         The character's current damroll.
    abs             The character's current damage absorption.
    ob              The character's offensive bonus.
    db              The character's defensive bonus.
    skill.X         The skill level of the character's skill X.
    in_house        Is the character in a room flagged ROOM_HOUSE.
    hasvar.X        The value of script variable X set on the character.
    has_mission.X   Returns 1 if the character has the mission with the
                    vnum X, otherwise returns 0.


Object Variable Fields
----------------------
The following is a list of fields which can be used with object variables.

    name            The short description of the item.
    id              The unique ID of the object.
    alias           The namelist of the item.
    action          The action description of the object.
    vnum            The virtual number of the item.
    room            The room the object is in.
    zone            The zone the object is in.
    keptby          The person who has the object, if any.
    type            The text name of the type of item.
    cost            The object's cost.
    value.X         These are the value fields of the object. X is 0-3.
  !!flags.X         Bitvector of the item flags set on the object.  See the
                      builder docs for a list of flags.
  !!spells.X        Bitvector of the spells on the object.  See the builder
                      docs for a list of flags.
    cost            The cost of the object.
    weight          The weight of the object.
    inside          The container of the object, if it's in one.
    contains        The first thing inside the object, if it's a container.
    contains.x      The first thing inside the object with vnum x, if it's
                      a container.
    nextinlist      Next object in container/inventory/room.
    nextinworld     Next object in Master Object List.
    generic         A integer value that's stored on the object itself.
    timer           The timer on the object before it fades. (in minutes)
    nexist          How many of that object exist in the game.
    hasvar.X        The value of script variable X set on the character.

Room Variable Fields
--------------------
The following is a list of fields for use with room variables.

    name            The room title.
    id              The room's unique ID
    vnum            The virtual number of the room.
    zone            The zone number the room belongs to.
    sector          The room sector the room has.
  !!flags.X         Bitvector of the flags set on the room.  See the builder
                      docs for the list of flags.
    people          First character in the room's list.
    objects         First object in the room's list.
    oexist.X        If an object with vnum X is in the room, then 1.
    mexist.X        If a mobile with vnum X is in the room, then 1.
    north.X         The north exit of the room.
    east.X          The east exit of the room.
    south.X         The south exit of the room.
    west.X          The west exit of the room.
    up.X            The up exit of the room.
    down.X          The down exit of the room.
    northeast.X     The northeast exit of the room.
    southeast.X     The southeast exit of the room.
    southwest.X     The southwest exit of the room.
    northwest.X     The northwest exit of the room.
    into.X          The into exit of the room.
    out.X           The out exit of the room.
                      For each exit, X can be:
                        flags - Flags affecting the exit.  See builder
                                docs for a list of exit flags.
                        key - Vnum of key that unlocks the door, if any.
                        toroom - Room that the exit leads to.
    random.char     A random character or PC in the room.  Please remember
    random.pc         if you use this, the might not be a character or PC
                      in the room, so be sure this returns someone before
                      you try to use it.  Please see mimic example, in
                      section 10.
    hasvar.X        The value of script variable X set on the character.


Special Variables
-----------------
The following is a list of special variables.  These variables can always be
used in a script, but their value may vary depending one which script they
are used within.

    self             The mob, item, or room running the script.
    random.X         This is a random number between 1 and X.
    random.X.Y       This variable returns a dice roll X number of dice and
                       Y sided dice. For example, %random.2.10% would be a
                       roll of 2d10 or 2-20.
    random.char      Use 'eval person %random.char%' and you will get a random 
    random.pc          character in the room (or %random.pc% for a random 
                       pc in the room). "person" can be any variable you 
                       wish to use in your script. Please remember that if you 
                       are using this, there may not be a character in the 
                       room, so before doing anything you should check to see 
                       if %person% (or whatever your variable is) contains 
                       someone.  Please see mimic example later in this 
                       document.
    X.get_clan       The clan associated with string X.  For example, 
                       %Dragon.get_clan% would return Dragon's clannum.
    people.X         The number of people in the room with virtual number X.
    time.X           X can be hour (the current hour in military time),
                       day (1 - 35), month (1 - 17), or year.
    weather.bits     The weather bits that are set.
    weather.season   Current season.


Special Fields
--------------
The following fields are valid for any variable.  All of the "find" 
fields, the "clan" field, and the "lword" field need to work on 
variables which are set to strings.

    isnum            Returns true of the variable is a number.
    clan             Returns the clan number of the clan matching the variable
    find_char        Finds a character with an alias matching the variable.
    find_char_room   Finds a character in the current room with an alias 
                       matching the variable.
    find_char_zone   Finds a character in the current zone with an alias 
                       matching the variable.
    find_obj         Finds an object with an alias matching the variable.
    find_obj_room    Finds an object in the current room with an alias 
                       matching the variable.
    find_obj_zone    Finds an object in the current zone with an alias 
                       matching the variable.
    lword            Strips off the left-most word from the string stored as 
                       the variable.  Filler words (in, from, with, the, on, 
                       at, to) are ignored and removed
                     Example: %arg% = This is the test.
                              eval test %arg.lword%
                              %test% = This
                              %arg% = is the test.
                              eval test %arg.lword%
                              %test% = is
                              %arg% = the test.
                              eval test %arg.lword%
                              %test% = test.
                              %arg% =
    can_walkto       Checks to see whether the argument (which should be a 
                       mob, item, or room) can be walked to from the location 
                       of the script.  If so, it returns 1 << direction 
                       number, otherwise it returns 0.

!!: These fields require a bit of explanation. To enable us to expand
    beyond normal limitations, we store the information for these fields in
    arrays. To enable you to check to see if one of these is currently set
    on a character, object or room, it requires a couple steps.
      
      Find the Flag you want to check for in the builder docs.
      Take the line that it shows up on. 0 for the first line, 1 for the 
        second line, etc.
      Multiply the number you just got by 2.
      If the letter that corresponds to that flag is capital, add 1 to the 
        line number. This is your X value.
      Take the letter of the flag and if it's uppercase, use the lowercase 
        version.
      Using a special operator called "Bitwise And" (represented by the '&' 
        symbol) we can now determine if that flag is present. 

      For example, let's say we need the flag ROOM_DARK.  It appears on the 
      first line, so we use 0.  Multiply this by 2, to get 0.  ROOM_DARK is 
      a lowercase 'a', so we do not add 1.  ROOM_DARK is already a lowercase 
      'a', so we don't need to change it.  Now, using bitwise AND, our 
      expression to check this flag is 

                if (%room.flags.0% & a)
                   do stuff

      As another example, let's say we need to find AFF_ANGELS_WARD.  This 
      flag appears on line 2, so we have an initial X of 1.  We multiply this 
      by 2, getting an X of 2.  The letter for this flag is uppercase "B", so 
      we add 1, getting an X of 3.  We change the "B" to a "b".  Now, our 
      expression to check this flag is

                if (%actor.affected.3% & b)
                    do stuff

**: These fields return the bits of the valid cyberwear/professions.  The 
    following tables give the bits to check for.

           Cyberwear                      Profession
           ---------                      ----------
            Sonar Receptors         a      Navigator       a
            Pheromone Sensor        b      Doctor          b
            Anti Grantiy            c      Engineer        c
            Chameleon Skin          d      Security        d
            Sound Dampener          e      Telepath        e
            Gills                   f      Saboteur        f
            Dermal Coating          g      Bounty Hunter   g
            Dermal Insulation       h      Ranger          h
            Pressure Field          i      Mercenary       i
            Dermal Shielding        j      Botanist        j
            Radar Tracking          k      Empath          k
            Hydraulic Calves        l      Bard            l
            Hand Razors             m      Spec Forces     m
            Mnemonic Enhancer       n      Smuggler        n
            Platelet Factory        o      Shaman          o
            Tailored Pheromones     p      Druid           p
            Spectrum Scanner        q      Monk            q
            Wired Reflexes          r      Hitchhiker      r
            Subdermal Armor         s      Geneticist      s
            Smartlink               v      Biologist       t
            Riggerjack              w      Decker          u
            Datajack                x      Hacker          v
            Skillwire  1            A
            Skillwire  2            B
            Skillwire  3            C
            Skillwire  4            E
            Skillwire  5            F
            Skillwire  6            G
            Skillwire  7            H
            Skillwire  8            I
            Skillwire  9            J
            Skillwire 10            K

$$: Valid values of X are:

          Immune
          ------
           Heal         1
           Fire         2
           Water        3
           Earth        4
           Air          5
           Energy       6
           Corrupt      7
           Blunt        8
           Slash        9
           Pierce       10


SubWrite Operators
------------------
The chart below is a list of characters which are used with the subwrite 
command to display information about the object/person in question.  This 
allows information to be shown to characters, based on how they perceive the 
thing in question.  For example, if one character performs an action while 
invisible, and another character, without "detect invisibility", perceives 
the action, they should see it as being performed by "someone", rather than 
by the character.  These symbols are only used in the various special 
sending commands available to mobs/objects/rooms:
      sasound, secho, sechoaround, ssend, ssendto, szoneecho
Regular mud commands, like say and emote do not use them.
  All of the SubWrite characters are prepended to the name of the object or 
mobile that you are referring to.  This could be something like: #bill or 
via the use of a variable something like #%self%.  If you use any of the 
listed variables in one of the valid commands but you really want to print 
out that symbol and not use it as a variable you have to protect it with a 
'\'.  For instance:

      secho The screen prints, 'Howdy, would you like a \#3 today?'

would send the following text to the room:

      The screen prints, 'Howdy, would you like a #3 today?'

However if you had not protected the # sign, there would have been an error 
and it would not have printed it as you wanted to see it shown.  For example:

      secho The screen prints, 'Howdy, would you like a #3 today?'

would send the following text to the room:

      The screen prints, 'Howdy, would you like a someone today?'

Below is a list of the subwrite operators, with an explanation of the 
results you get with each.
  NOTE: the "'s are simply to make the text more readable and are not 
  actually used in the game.

        ;:  Up-case   - The character immediately following a ; will be 
                        capitalized, if it is a lowercase letter.  This 
                        subwrite operator is applied after all variables 
                        have been evaluated, and all other subwrite operators 
                        have been applied.

        #:  PERS(ch)  - Target is you: "you"
                        Target is not able to be seen by person: "someone"
                        Otherwise: targets name

        @:  ch's      - Target is you: "your"
                        Target is not able to be seen by person: "someone's"
                        Otherwise: targets name with an "'s" at the end.

        ^:  hshr(ch)  - Target is you: "your"
                        Target is not able to be seen by person: "its"
                        Otherwise: "his", "her", or "its" based on gender.

        &:  hssh(ch)  - Target is you: "you"
                        Target is not able to be seen by person: "it"
                        Otherwise: "he", "she", "it" based on gender.

        *:  hrhm(ch)  - Target is you: "you"
                        Target is not able to be seen by person: "it"
                        Otherwise: "him", "her", "it"

        `:  OBJS(obj) - Target is not able to be seen by person: "something"
                        Otherwise: objects name

        }:  Spacing   - This character is used for formatting. If you place it
                        at the beginning of line it will protect the spacing 
                        after it.

        $:  audible beep



                        ==========================
                        = Section 7. Expressions =
                        ==========================

Expressions are simple operations within a script, using either values or 
variables.  Expressions can be used to perform mathematical or logical 
operations, such as addition or negation, or comparison, such as whether 
one number is less than another.  The four types of expressions are 
mathematical, comparison, logical, and bitwise.

Boolean Expressions
-------------------
Boolean expressions are expressions which end up being either true or 
false.  This is mainly important in things like 'if' statements, where
you want to do something only if an expression is true.  For example, in 
the statement 'if (12 < 13)', '12 < 13' is a boolean expression which is 
true.  In scripts, a false expression is any expression which results in 
either '0' or an empty string.  Every other expression is true.

Mathematical Operators
----------------------
Expression can perform a number of mathematical operations.  In general, 
mathematical operations should only be performed on numeric values, not 
on strings.

  Operator     Name             Example
  --------     ----             -------
    +          addition         10 + 1 = 11

    -          subtraction      15 - 1 = 14

    *          multiplication   5 * 10 = 50

    /          division         30 / 3 = 10

    >>         right shift      7 >> 2 = 1
                                32 >> 3 = 4
                                13 >> 1 = 6

    <<         left shift       2 << 2 = 8
                                5 << 1 = 10
                                12 << 3 = 96

    `          modulus          5 ` 3 = 2
                                5 ` 7 = 5
                                5 ` 5 = 0

Comparison Operators
--------------------
Expressions can be used to compare two values.  The substring operator 
should only be used on strings.  The equality and inequality operators 
may be used with either numeric values, or strings.  All other comparison 
operators should only be used with numeric values.

  Operator     Name             Example
  --------     ----             -------
    ==         equivalence      5 == 3 = 0
                                5 == 5 = 1
                                dog == DoG = 1
                                dog == cat = 0

    !=         inequality       0 != 0 = 0
                                0 != 1 = 1
                                dog != DoG = 0
                                dog != cat = 1

    <=         less than        1 <= 0 = 0
                   or equal     2 <= 2 = 1
                                2 <= 4 = 1

    >=         greater than     1 >= 0 = 1
                   or equal     2 >= 2 = 1
                                2 >= 4 = 0

    <          less than        1 < 0 = 0
                                2 < 2 = 0
                                2 < 5 = 1

    >          greater than     1 > 0 = 1
                                2 > 2 = 0
                                2 > 5 = 0

    /=         substring        superfluous /= super = 1
                                bill /= bob = 0

Logical Operators
-----------------
Logical operators are used to combine or modify boolean values, to produce 
a new boolean value.  For example, if you want an expression to be true if 
two simpler expressions were both true, then you would want to use a logical 
and.

  Operator     Name             Example
  --------     ----             -------
    ||         logical or       0 || 0 = 0
                                0 || 5 = 1
                                2 || 3 = 1

    &&         logical and      0 && 0 = 0
                                0 && 5 = 0
                                2 && 3 = 1

    !          negation         !1 = 0
                                !0 = 1
                                !dog = 0

Bitwise Operators
-----------------
Bitwise operations are similar to logical operation, but they work on each 
bit of a number, rather than the whole number.  This is primarily used 
with bitvectors, when you may want to combine two bitvectors using logical 
operators for each bit.  If this doesn't make sense, but you think you need 
to use bitwise operators, ask a Script Imm, or an Imp, for help.

  Operator     Name             Example
  --------     ----             -------
    |          bitwise or       0 | 0 = 0
                                1 | 0 = 1
                                1 | 1 = 1
                                5 | 3 = 7
                                0101 | 0011 = 0111
                                
    ^          bitwise xor      0 ^ 0 = 0
                                1 ^ 0 = 1
                                1 ^ 1 = 0
                                5 ^ 3 = 6
                                0101 ^ 0011 = 0110

    &          bitwise and      0 & 0 = 0
                                1 & 0 = 0
                                1 & 1 = 1
                                5 & 3 = 1
                                0101 & 0011 = 0001
                                
    @	       logical not      @0 = 1
                                @1 = 0
                                @0101 = 1010
                                @0011 = 1100



                              ============
                              = 8. Files =
                              ============

To assign a trigger to a particular mobile, object or room, you have to
include it as part of that file.
  Triggers are declared to be attached to a mob, object, or room in the 
.mob, .obj, and .wld files, respectively.  All three are declared in the 
section UTRIGGER, by listing the VNums of every script you would like to 
attach on a separate line.  Be sure the UTRIGGER section is in the 
declaration of the mob/object/room you want to attach the scripts to, and 
that it's not within another section.  For example, this might be a 
UTRIGGER section:

      UTRIGGER
      1003
      1014
      1052
      @UTRIGGER

See also the builder documentation if you do not understand where to put 
the UTRIGGER section.



                        ======================
                        = 9. Quick Reference =
                        ======================

  Triggers Available
  ------------------
  
  Flag    Type         Mob     Obj     Room
  ----    -----        ---     ---     ----
  a       Global        Y       Y       Y
  b       Random        Y       Y       Y
  c       Command       Y       Y       Y
  d       Speech        Y       Y       Y
  e       Act           Y       N       N
  f       Death         Y       Y       Y
  g       Get           N       Y       Y
  h       Drop          N       Y       Y
  i       Enter         Y       N       Y
  j       Exit          Y       N       Y
  k       Greet         Y       N       N
  l       Farewell      Y       N       N
  m       Give          N       Y       N
  n       Receive       Y       Y       N
  o       Wear          N       Y       N
  p       Remove        N       Y       N
  q       Fight         Y       Y       N
  r       Bribe         Y       N       N
  s       Invoked       Y       Y       Y
  t       Load          Y       Y       N
  u       Destruction   Y       Y       Y
  v       Unload        Y       Y       N
  w       Mission       Y       Y       Y

  Variable Commands
  -----------------
  eval <variable> <value>
  set <variable> <value>
  global <variable>
  zglobal <variable>
  unset <variable>


  Conditional Statements
  ----------------------
  if (<expression>)
  elseif (<expression>)
  else
  end

  while (<expression>)
    [continue]
    [break]
  done

  switch (<expression>)
    case <val>
      [break]
    default
  done


  Message and Display Commands
  ----------------------------
  sasound <message>
  secho <message>
  sechoaround <victim> <message>
  ssend <victim> <message>
  ssendto <victim> <message>
  szoneecho <zone> <message>


  Creation and Destruction Commands
  ---------------------------------
  sgive <vnum> <victim>
  sdrop <object>
  sjunk <object>
  sload <type> <vnum>
  spurge [<target>]


  Action Commands
  ---------------
  scast '<spell>' <victim>
  sforce <victim> <command>
  sgoto <target>
  sput <object> <container>
  steleport <victim> <target>
  swalk <target> <time per step>


  Value Alteration
  ----------------
  salter <target> <field> <argument>
  scurrency <victim> <type> <amount>
  sdoor <room> <direction> <field> <value>
  sexp <victim> <amount>
  smission <character> <action> <mission vnum> <objective id> <value>
  sprogress <character> <mission vnum> <objective id> <variable name>
  sset <target> <option> <value>


  Trigger Manipulation
  --------------------
  call <script>
  halt
  return <value>
  sattach <type> <vnum> <target> [<Xth>]
  sdetach <type> <target> <script>
  wait <number> [<type>]
  wait until <HH>:<MM>


  Other Script Commands
  ---------------------
  sat <target> <command>
  slog <text>
     

  Variable Fields
  ---------------
    Characters
    ----------
     name               alias
     id			idnum
     vnum               room
     zone               fighting
     master             level
     height             weight
     sex                align
     pc                 npc
     currency.X         currency.bank
     canbeseen          flags.X (mob only)
     race               subrace
     str                stradd
     int                wis
     dex                con
     cha                ego
     affected.X         eq.X
     hit                hit.max
     mana               mana.max
     move               move.max
     psyche             psyche.max
     cyber.X (pc only)  has.X
     nexist (mob only)  generic
     position		clan
     immune.X		profession
     essence		carrying
     nextinroom		nextinworld
     nextconn           skill.X
     beamed             rank
     accum              points
     seed               rejuv
     damroll            abs
     ob                 db
     has_var.X          has_mission.X
     in_house

    Objects
    -------
     name               alias
     id			action
     vnum               keptby
     type               value.X
     nexist             zone
     cost               weight
     spells.X           flags.X
     room               generic
     timer		inside
     contains		contains.X
     nextinlist		nextinworld
     has_var.X

    Rooms
    -----
     name               vnum
     flags.X            zone
     sector             oexist.X
     mexist.X           north.X
     east.X             south.X
     west.X             up.X
     down.X             northeast.X
     southeast.X        southwest.X
     northwest.X        into.X
     out.X              random.pc
     random.char	id
     people		objects
     mexist.X		oexist.X
     has_var.X

    Special variables
    -----------------
     self		X.get_clan
     random.X		random.X.Y
     random.char	random.pc
     people.X		time.X
     weather.bits	weather.season


    Special fields
    --------------
     isnum		clan
     find_char		find_obj
     find_char_room	find_obj_room
     find_char_zone	find_obj_zone
     lword		can_walkto


  Operators
  ---------
   ||
   &&
   |
   ^
   &
   ==
   !=
   <=
   >=
   >>
   <<
   <
   >
   /=
   -
   +
   /
   *
   !

  SubWrite
  --------
   #  PERS(ch)
   @  ch's
   ^  hshr(ch)
   &  hssh(ch)
   *  hmhr(ch)
   `  OBJS(obj)
   }  Spacing
   $  Audible Beep



                      ========================
                      = Section 10. Examples =
                      ========================

* In this Trigger, a Mob responds to being poked. First we set the Return
* value to 1 so that the poke social still sends it's message. Then we
* check to see that the target of the poke is the Mob with the script.
* Finally, based on what kind of character did the poke, respond to it.
#1000
poker mad~
c 4 100 0
poke~
return 1
if (%arg% == %self.name%)
  wait 1
  if (%actor.npc%)
    chuckle
    poke %actor%
  elseif ((%actor.level% <= 5) || (%actor.align% > 350))
    tell %actor% I would rather you didn't poke me.
  elseif (%actor.level% > 15)
    scream
    say Ya know %actor.name%. I hate being poked!!!
    hit %actor%
  else
    slap %actor%
    shout MOMMY!!! %actor.name% is poking me.
  end
end
~
* The next two Triggers would be assigned to a Room and used to enact a
* secret passageway behind a bookshelf.
*
* The first thing we do in 'book pull' is to check to make sure that the
* thing they are trying to pull is a 'book'. If it is a 'book' they are
* trying to pull but the door is already in an open state, then we'll
* send them a silly message that is still in theme with the bookcase. In
* some cases this is okay but in others you might prefer to send them a
* more informative message. If the door is closed, then the Script will
* open it up.
#1001
book pull~
c 3 100 0
pull~
return 0
if (%arg% != book)
  ssend %actor% Pull what?
else
  if (%open%)
    ssend %actor% You pull a book off the shelves to examine it more closely.
  else
    ssend %actor% You pull on a large leather bound book on the shelf.
    sechoaround %actor% #%actor% pulls on a large leather bound book.
    wait 1
    secho The bookshelf swings open, revealing a hidden passage.
    sdoor 1019 north name bookcase shelf
    sdoor 1019 north room 1012
    sdoor 1019 north description A bookshelf serves to hide a small passage.
    set open 1
    global open
  end
end
~
* Here in 'book push' we handle closing the secret door. Again the first
* thing we check is to see if it's already in the state we are trying to
* put it in. If it is, we send them a silly message. If it is open, then
* the Script closes it. Try to figure out a way we could get away with not
* having to use a global variable in this instance.
#1002
book push~
c 3 100 0
push~
return 0
if (%arg% != book)
  ssend %actor% Push what?
else
  if (!%open%)
    ssend %actor% You push around some books on the shelves and make a mess.
  else
    ssend %actor% You push the book back to its original position.
    sechoaround %actor% #%actor% pushes a book on the shelf.
    wait 1
    secho The bookcase swings shut, completely concealing the passage behind.
    sdoor 1019 north purge
    set open 0
    global open
  end
end
~
* This Trigger is relatively simple, but also very useful. It is so useful
* in fact that both Infoteq and Dranor carry one of these around with them
* all the time. If you've read the documentation you should be able to see
* that it allows you to evaluate any expression that the Scripts system
* can handle and return the results.
#1003
calculator~
c 4 100 4
calculate~
sechoaround %actor% #%actor% punches some numbers into `%self%.
ssend %actor% You punch "%arg%" into `%self%.
eval result %arg%
ssend %actor% The answer of "%result%" appears on the screen.
return 0
~
* This Trigger causes the Mob (a dog in this case) to growl at any Altair
* that walk into the room. Notice that there is a short wait before sending
* the message. This makes sure that it will only growl at one person if a
* whole group enters the room which adds a bit of realism and reduces spam. 
#1004
dog growl altair~
i 0 50 0
~
if ((%actor.race% == player) && (%actor.subrace% == altair))
  wait 2
  growl %actor%
end
~
* The next two Triggers create a temperamental cat that prefers female
* characters over male or neuter characters. Notice that these two
* triggers are of the same type, but in this case both have the
* opportunity to execute because neither one will activate 100% of the
* time.
*
* In 'cat hiss' the Trigger checks to make sure it is a PC walking in
* the room and if it's not a female, attack them.
#1005
cat hiss~
i 0 50 0
~
if (!%actor.pc%)
  halt
end
if (%actor.sex% != FEMALE)
  wait 2
  sechoaround %actor% #%self% hisses fiercely at #%actor%.
  ssend %actor% #%self% hisses fiercely at you.
  wait 5 s
  kill %actor%
end
~
* In 'cat follow' if a PC of any gender has a charisma of 14 or more, it
* will follow them for a little while and act affectionate. Otherwise it
* will hiss at the actor.
#1006
cat follow~
i 0 25 0
~
if (!%actor.pc%)
  halt
end
if (%actor.cha% >= 14)
  wait 2
  stand
  wait 1
  follow %actor%
  wait 2 s
  sechoaround %actor% #%self% rubs against #%actor%'s leg.
  ssend %actor% #%self% rubs against your leg.
  if (%actor% == FEMALE)
    wait 1 t
  else
    wait 15 s
  end
  follow self
else
  sechoaround %actor% #%self% hisses fiercely at #%actor%.
  ssend %actor% #%self% hisses fiercely at you.
end
~
* The following three Triggers direct the behavior of a guard at a bank.
*
* The 'bank guard' Trigger makes sure that all vagrants (characters who use
* the sleep command) are tossed out on their ear. The guard stands in room
* 1034 (inside the bank) and will send people west, to room 1035 (outside
* the bank).  Note that you must check that the people haven't already left 
* of their own accord before the guard can throw them out.
#1007
bank guard~
e 0 100 0
lies down and falls asleep.~
wait 1
wake %actor%
say No vagrants are allowed here!  Go find the inn!
wait 1
if (%actor.room% == %self.room%)
  emote throws %actor.name% out of the bank.
  steleport %actor% 1035
end
~
* The 'bank open' Trigger activates 13 seconds after boot time and then
* immediately goes into a wait state until 8am Game time. When it reaches
* 8am, the guard will stand and open the door, then return to his default
* state of sitting.
#1008
bank open~
ab 0 100 0
~
wait until 8:00
stand
remove key
unlock door
hold key
open door
sit
~
* The 'bank close' Trigger activates 13 seconds after the 'bank open'
* Trigger (Recall that only 1 trigger of a particular type can activate at
* a time). Then it will immediately go into a wait state until 6pm Game
* time. When it reaches 6pm, he will teleport everyone out of the bank and
* lock the door. Consider how you could combine #1008 and #1009 into one
* Trigger. Would there be any problems with doing that?
#1009
bank close~
ab 0 100 0
~
wait until 18:00
emote smiles happily.
wait 1
say It's closing time!  Time for everyone to leave.
wait 1
emote ushers everyone out of the bank.
sat 1035 emote ushers everyone out of the bank.
steleport all 1035
sat 1035 sforce all look
stand
close door
remove key
lock door
hold key
sit
~
* In this set of four Triggers, the Script emulates a shop for filling up
* drink containers of water. While this is not of much practical use to a
* Game where thirst and hunger are automatically taken care of, the idea
* of emulating another Game feature with a Script is an important one.
* If you use commands and concepts that players are already familiar with,
* it will help reduce the learning curve required to play in your area.
*
* In 'water list' we handle the listing of available goods. It doesn't
* look like the standard shop listing but that is not as important as
* using a command that the players are used to.
#1010
water list~
c 3 100 0
list~
if (%actor.canbeseen%)
  tell %actor% Water costs 24 credits per day's worth of water.
  tell %actor% Give me a container and I'll fill it.
else
  say I don't trade with someone I can't see!
end
return 0
~
* In 'water buy' we capture the purchasing command and redirect them to
* the way that this shop works. If you are going to change away from the
* standard, it important that you communicate what you would like to see
* in some fashion so that the players don't get frustrated.
#1011
water buy~
c 3 100 0
buy~
if (%actor.canbeseen%)
  tell %actor% You must give me a water container to fill.
else
  say I don't trade with someone I can't see!
end
return 0
~
* In 'water fill' we actually take care of the transaction. Using a
* Receive Trigger we make sure all of the required conditions are met and
* then complete the transaction. When writing a complicated Script like
* this one, it is important to consider in what ways would it be possible
* to do something that would break the Script. Consider what damage could
* result if we did not check what type of object was being given and the
* Script modified a weapon.
#1012
water fill~
n 0 100 0
~
if (!(%actor.canbeseen%))
  say I don't trade with someone I can't see!
  return 0
  halt
end

return 1
wait 1 s
secho #%self% looks over `%object%.
wait 1 s

if (%object.type% != LIQ_CONTAINER)
  say I can only fill drink containers!
else if (%object.value.2% != 0)
  say I'm sorry, we only sell water here.
elseif (%object.value.0% <= %object.value.1%)
  say This is already full.
else
  eval cost %object.value.0% - %object.value.1%
  eval ncost 0 - %cost%

  if (%cost% > %actor.currency.credits%)
    say You don't have enough credits!
  else
    scurrency %actor% credits %ncost%
    salter %object% value 1 %object.value.0%
    wait 1 s
    tell %actor% That's %cost% credits.  Here you go.
  end
end
give %object% %actor%
if (%self.carrying%)
  drop %object%
end
~
* In 'water reject' we take care of the fact that while 'water fill' is
* handling one character, another could come along and try to get their
* water container filled. If we didn't have this Trigger then during the
* pauses that second character might get a message saying 'Sorry, but
* you cannot do that here!' This might mislead the character into
* thinking that something is broken. 
#1013
water reject~
n 0 100 0
~
if (%actor.canbeseen%)
  tell %actor% Wait your turn.  I'm already helping another customer.
else
  ssend %actor% #%self% refuses your `%object%.
end
return 0
~
* Here are two Triggers that add a little flavor to an area with a bell
* tower. Obviously it's not very realistic that the bell ringer would sit
* in the bell tower all day so in 'bell ringer' we set up the timing and
* the walk to the tower. Notice that we wait until the 11 o'clock hour and
* precisely 75 seconds later we ring the bell.
*
* If you wanted to take it a step further you could add a second door the
* ringer goes through and have it be unpassable except when he is going
* through it. Then add a couple of Triggers to stop anyone who isn't
* sneaking from passing by him as he walks through the door. This adds a
* clever challenge and requires the players to be paying attention.  Also, 
* consider what might happen if a player was quick, and closed the panel 
* after the bellringer opened it, but before he moved west.
#1014
bell ringer~
b 100 0
~
wait until 11:00
wait 67 s
stand
wait 2 s
open panel
wait 2 s
east
wait 2 s
up
wait 2 s
pull rope
wait 2 s
down
wait 2 s
open panel
wait 2 s
west
wait 2 s
close panel
wait 2 s
sit
~
* In 'bell pull' we handle the ringing of the bell. We could have done this
* in the 'bell ringer' Script, but making a separate Trigger allows anyone
* who gets into the room to ring the bell. A tiny bit of realism can go a
* long way to giving an area a bit of authenticity.
#1015
bell pull~
c 3 100 0
pull~
if (%arg% != rope)
  ssend %actor% You do not see that here.
else
  ssend %actor% You pull on the rope.
  sechoaround %actor% #%actor% pulls on the rope.
  wait 1
  szoneecho %actor.zone% A bell chimes, tolling the hour of noon.
  ssend %actor% The bell above you rings loudly.
end
return 0
~
* The next 8 Triggers have been taken directly from SDO. If you wander
* around the mall level you should be able to see every one of these in
* action.
*
* In 'generic shop greet' the Room title becomes part of greeting that can
* be used on multiple shop keepers. It is very straightforward but adds a
* little bit of interaction for relatively little effort.
#1016
generic shop greet~
i 0 100 0
~
wait 1
eval room %self.room%
ssend %actor% #%self% says, 'Welcome to %room.name%. How may I help you?
~
* 'generic howdy' can be given to any Mob that might be considered friendly
* and outgoing. It only runs half the time and giving it 9 different things
* to potentially say gives it enough variety that it doesn't become too
* repetitive.
#1017
generic howdy~
i 0 50 0
~
set choice %random.9%
wait 1
if (%choice% == 1)
  say Hi there.
  smile
elseif (%choice% == 2)
  emote nods politely in your direction.
elseif (%choice% == 3)
  emote smiles warmly at you.
elseif (%choice% == 4)
  emote glances at you briefly.
elseif (%choice% == 5)
  emote smiles and says, 'Hiya!'
elseif (%choice% == 6)
  say Howdy.
elseif (%choice% == 7)
  emote turns its head toward you, nods, and waves.
elseif (%choice% == 8)
  say Salutations.
elseif (%choice% == 9)
  say Greetings.
end
~
* 'generic goodbye' has essentially the same parameters as the 'generic
* howdy' with the exception that there is a special Laukhi parting
* message which roughly translated means "May Sister Sky gently carry you
* to your destination."
#1018
generic goodbye~
l 0 50 0
~
set choice %random.9%
if (%choice% == 1)
say See Ya:)
  smile %actor%
elseif (%choice% == 2)
  emote leaves the area rather quickly.
elseif (%choice% == 3)
  say May the Dragons guide your path...
elseif (%choice% == 4)
  emote tries not to be noticed when leaving the area.
elseif (%choice% == 5)
  emote waves goodbye saying, 'See Ya!'
elseif (%choice% == 6)
  if (%self.race% == LAUKHI)
    says D'kar et Khystarn reahlr :)
  end
elseif (%choice% == 7)
  say Laters...
elseif (%choice% == 8)
  say Farewell.
elseif (%choice% == 9)
  say I'm late! I know I'm not going to make it.
end
~
* The three Triggers that comprise the role of the Janitor portray him/her
* as an intolerant, disgusting, exasperated and occasionally violent
* character. Needless to say this Script was fun to write. 
*
* In 'janitor general' we deal with the trait of exasperation. Notice the
* fact that he/she complains about working 24hrs a day, which is true
* since Mobs on SDO do not sleep.
#1019
janitor general~
b 0 20 0
~
grumble
say Litterbugs.
if (%random.20% <= 4)
  wait 2 s
  say All I do each day is cleanup other people's messes.
  if (%random.20% <= 4)
    wait 2 s
    say I do not get paid enough.
  elseif (%random.20% <= 4)
    wait 4 s
    say Day in.  Day out.  This is all I do 24 hours a day.
    if (%random.20% <= 1)
      wait 2 s
      shout I want a vacation!
    end
  end
end
~
* In 'janitor growl' we handle the intolerance and occasional violence.
* Many character will just drop stuff on the ground if they don't want it.
* The janitor reacts to the message sent to the room about someone dropping
* an object. Janitors are actually relatively weak Mobs so having them
* randomly attack someone doesn't pose too much of a problem.
#1020
janitor growl~
e 0 100 0
drops~
ssend %actor% #%self% yells at you, 'Litterbug! You are detestable!'
sechoaround %actor% #%self% yells at #%actor% for littering.
wait 2 s
say You are all litterbugs!
if (%random.10% <= 1)
  wait 2 s
  growl %actor%
  wait 2 s
  hit %actor%
else
  ssend %actor% #%self% yells at you, 'Pick up after yourself!'
  sechoaround %actor% #%self% forces #%actor% to pick up all the trash.
  sforce %actor% get all
end
~
* Ahh, the disgusting part. 'janitor butt/nose' portrays the truly
* horrifying aspects some might consider 'standard janitor behavior'.
#1021
janitor butt/nose~
b 0 20 0
~
if (%random.2% == 1)
  secho #%actor% pauses for a moment to pick ^%self% nose.
else
  secho #%actor% stops to pull ^%self% pants up, thankfully covering ^%self% butt.
end
~
* The next two Triggers give as much or more personality to Security
* Officers as the original 'cityguard' SpecProc did.
*
* In 'security officer entry' we search for someone in the room and see
* if the officer will react to them. Because this only activates when the
* officer moves, it will only react to one person at a time. We chose only
* 60% activation so that it didn't get too spammy.
#1022
security officer entry~
k 0 60 0
~
eval person %random.pc%
if (%person%)
  if (%person.level% >= 51)
    bow %person%
    halt
  else
    if (%person.affected.0% & s)
      peer %person%
    else
      ssend %person% #%self% eyes you suspiciously.
    end
  end
  if (%person.align% < -350)
    if (%random.20% < 2)
      say Evildoer, prepare to meet thy doom!
      wait 2 s
      hit %person%
    else
      say Be on your way %person.name%. We don't like your kind here.
    end
  end
end
~
* In 'security officer greet' we do pretty much the same thing that we
* did in the 'entry' but for people walking into the room. In this case
* we limit the number of people it can react to at one time by using a
* low percentage. Can you think of a way to make the security officer's
* Script more efficient?
#1023
security officer greet~
i 0 30 0
~
if (%actor.pc%)
  if (%actor.level% >= 51)
    bow %actor%
    halt
  else
    if (%actor.affected.0% & s)
      peer %actor%
    else
      ssend %actor% %self.name% eyes you suspiciously.
    end
  end
  if (%actor.align% < -350)
    if (%random.20% < 2)
      say Evildoer, prepare to meet thy doom!
      wait 2 s
      hit %actor%
    else
      say Be on your way %actor.name%. We don't like your kind here.
    end
  end
end
~
* This Script is very popular for players who like to leave equipment
* disbursal to random chance. The Trigger rolls two 6 sided dice and
* returns the results. Notice in the 'if' statement that we first
* check to see if they even supplied an argument before we do anything
* else. String comparisons can be cpu intensive so it is best to only
* do them where and when it's absolutely necessary. Also, rather than
* putting in a lot of extra code to check all of the possible things
* a player might type to roll, we see if what they typed is also one
* of the keywords of the item which they should be using anyways.
#1024
dice roll~
c 4 100 ab
roll~
if (%arg% && (%self.name% /= %arg%))
  eval rollone %random.6%
  eval rolltwo %random.6%
  eval rolltot (%rollone% + %rolltwo%)
  ssend %actor% You roll `%self% and get %rollone% and %rolltwo% for a total of %rolltot%.
  sechoaround %actor% #%actor% rolls `%self% and gets %rollone% and %rolltwo% for a total of %rolltot%.
  return 0
end
~
* The last 5 Triggers portray a nasty critter known as a mimic. In order
* to trap it's prey, it pretends it's an object of interest and when they
* get too close, *chomp*. This is probably one of the first Scripts we
* ever wrote to test out how the Scripting system worked.
*
* In 'mimic open' the mimic responds to an attempt to open the chest by
* attacking them. When you prevent a Mob from being able to activate a
* Trigger, you can usually get away with halting the trigger as quickly
* as possible. In this case, we are trying to trick the PCs into opening
* the chest themselves, so if they try to use a pet to do it, we make it
* seem as if they are having trouble controlling the pet.
#1025
mimic open~
c 2 100 0
open~
if (%arg% /= chest)
  if (%actor.pc%)
    return 0
    ssend %actor% As you reach out to open the chest, it comes to life!
    sechoaround %actor% %actor.name% reaches out towards the chest...
    hit %actor%
  else
    sforce %actor% emote has an indifferent look.
  end
end
~
* In 'mimic look' we give the PCs a faint clue that something is not
* right about the chest.
#1026
mimic look~
c 2 100 0
look~
if ((%arg% /= chest) && %actor.pc%)
    ssend %actor% You feel a sense of dread when you look at this chest.
    return 0
end
~
* In 'mimic load chest' we handle creating the illusion of an 'chest'
* object being present in the room. In order to complete the illusion,
* the mimic mob itself does not have a Long Desc, so when the players
* look at the room, they see only the object. This also makes the mimic
* portable. If we wanted to load one up someplace new, we would not have
* to also worry about loading the chest. The check prevents the mimic
* from loading a chest when it's fighting and prevents it from loading
* dozens of chests in the room. Of course this also means that only one
* mimic can be in a room at a time. Can you think of a way to overcome
* this limitation?
#1027
mimic load chest~
b 0 100 0
~
eval room %self.room%
if (!%self.fighting% && !(%room.oexist.3%))
    sload obj 3
end
~
* In 'mimic fight' we get rid of the chest while the mimic is fighting
* because when a mob is fighting it displays 'a mimic is here, fighting
* YOU!' So, having a chest there as well as that message can shatter the
* illusion.
#1028
mimic fight~
q 0 100 0
~
eval room %self.room%
if (%room.oexist.3%)
    spurge chest
end
~
* In 'mimic death' we handle what happens when the mimic dies. While
* you could argue that a dead mimic would look like a dead mimic, we
* decided that a dead mimic would look like a shattered chest. So when
* the mimic dies, it loads a 'shattered chest', puts anything it has
* on itself into the chest and then eliminates itself. Can you think
* of a side effect we'd have to take care of as a result of doing this?
#1029
mimic death~
f 0 100 0
~
sload obj 4
remove all
put all chest
return 0
spurge %self%
~
* Throughout this section I have posed questions for you to consider in
* order to stimulate your thinking beyond these 30 examples. If you are
* having trouble answering the questions, or if you'd like someone to
* look at what you came up with as a solution, please sign on to the
* Game and see if someone on BldrNet is available to help you. If you
* are not on BldrNet, see a 57+ for access. Barring that, please pose
* your questions on the 'builderb' board and someone should get back
* to you within a day or two.
$~