UOX3 v69.02+ Trigger System
By Zadius (linkage@xmission.com)
(Document version 6)
Visit the Official Quests and Triggers Web Page

Introduction:
    The trigger system first derived from an idea I had when I created a game a while back that was much like Diablo and UO.  In fact it was during the glory days of Diablo and  I remember that UO was still in beta at this time.  Hmmm.  Where does the time go eh?  Anyway, for my game, I needed some what to make the NPC and items react to the actions of the player, so I designed and implemented the trigger system into this game.  Recently,  something just hit me.  I realized that this trigger system would be the perfect thing for UOX3 and thus, with a little coding and studying the UOX3 code, I began my work with much success.  Even though UOX3 was not optimally designed in some aspects, I was still able to add a fully functional trigger system with very little to no performance deteriations.  What this document contains is a description of the trigger system, a table containing trigger tokens and some trigger samples.  Remember, the Trigger System is still in its infancy and will get more robust as it progresses.  There are tons of cool tokens already that can allow you to do some pretty cool things so have fun!

The Trigger System Defined:
    The trigger system is a internal processing engine for processing functionality commands to cause an effect on the player or thier environment when an item or NPC is triggered.  The trigger code is described as "flow through" which means that all triggers flow through the code from top to bottom.  For speed considerations, there are no condition branches.  There are however, some tokens that will abort the flow when a certain condition is not met.  Basically, they are true/false conditions only.  There are currenty 3 types of triggers available.  They are:

    1. Static triggers which are triggers that can be activated when a user uses an evoked item on a static item or a dynamic item.  Static triggers are defined by thier ID and are coded in the "wtrigrs.scp" file.  To specify an item to be envokable, specify it by its ID in the "envoke.scp" file.  You can also activate a static world item by typing "/use" and then clicking on the object.  For instance the following Static trigger will allow the player to drink from any fountain in the world.

            SECTION x173fx1738x1739x173bx1741x173dx173cx139ex179b
            { Replenish from a fountain
            EMT *Slurp*  Ahhhh... Tasty!
            SND 00 50
            ACT 22
            STAM 10
            }

    2. Dynamic Triggers are triggers that can be assigned to an item by typing "/itrig #" then clicking on the item.  This will set the items "TRIGGER" property to the specified trigger as refferenced by the trigger number in the "triggers.scp" file.  There are two types so far for dynamic triggers. They are:

            A. Type 0 (default).  User double-clicks item to fire trigger.
            B. Type 1.  User walks over item to fire trigger.
           (Note: To set a trigger type, enter "/ttrig #" then click the item.)

I plan on adding more trigger types in the future.  For instance, fire trigger when dopped on ground, fire trigger when dropped in pack,  fire trigger when character dies, fire trigger when character is attacked and fire trigger when dropped on NPC. ect ect ect.  You can make any item in the "items.scp" file be automatically triggered upon creation by entering a "TRIGGER #" token and a "TRIGTYPE # " token in the items section.  The following Dymanic trigger will allow you to play chess using a chess board.

            SECTION TRG 7
            { Play chess
            EMT Your move....
            SND 00 42
            CALCUSES -1
            RNDUSES 5 20
            EMT Checkmate!  I win!
            SND 00 3d
            }
(After creating the chess board, enter "/itrig 7" then click on the chessboard.  Or you can add the token "TRIGGER 7" in the "items.scp" file in the chessboards section to have every chessboard triggered when created.  In this case the triggers number is 7.)

    3. NPC triggers are fired when you speak to NPC's and say a certain word.  Well, in acuality I made it so that NPC triggers can also be assigned to the players for gaming purposes.  For instance, giving a player a curse, or for making spreadable diseases. :)  To set a trigger on a NPC or character enter "/ctrig #" as specified by the trigger number in the "ntrigrs.scp" file then click on the char.  Then set the trigger word by entering "/wtrig !hail" for instance.  You can also make the NPC or character be automatically triggered upon creation by entering the "TRIGGER #" token and the "TRIGWORD <string>" token in the characters section of the "npc.scp" file.  NPC triggers are not fired unless the trigger word is spoken to the character.  The following example makes a NPC serve you a drink when you say. "Im thirtsy! Give me a drink!":

            SECTION TRG 1
            { ask  tavern keeper for drink
            EMT Thar ya be yer warshipness!  Drinks are on the house!
            SND 00 42
            IADD 5004
            NPCACT 13
            DISABLE 10
            }
(After creating the character, enter "/ctrig 1" then click on the character.  Then enter "/wtrig !drink" and click the character. Or you can add the token "TRIGGER 1"  and the "TRIGWORD drink" token in the "npc.scp" file in the characters section to have every said character triggered when created.  In this case the triggers number is 1.)

Trigger Tokens Described:
 

Future Token Ideas:

    There will be some more tokens being coded in the next version or versions.  Here are a few of the ideas I have in mind.  If you have some suggestions for some trigger tokens, please feel free to visit my web site and submit your suggestion.

    -SETCOLOR (Will be used to set the color of an item that was created by the IDADD token for use in making gold, silver, adamantium and silver ore for instance)
    -NPCPUT (Will place the triggered NPC at a specified location)
    -EVREMOVE (Will remove the envoked item)
    -SWAP (Will swap the ID of the item if one of the given IDs match the other ID given)
 

Trigger Examples:

    Here are a few examples of triggers.  Hopefully these will get your brain juices flowing.

    1.  Static Examples (wtrigrs.scp)

           This trigger will perform the functionality of allowing the player to chop at a dynamic tree or a static tree to produce wood.

            SECTION xce0xce3xcddxcd3xce6xcd8 <- The ID of the trees. Ommit leading zeros and include an "x"
            { Chop at a tree
            REQ xf43xf47xf49xf4bxf51        <- If the player used one of these items...
            STAM -5                    <- Subtract 5 from the users stamina...
            SND 01 3e                  <- Play the wood chopping sound effect...
            ACT d                      <- Make player do the "swing low" action...
            CSKL 44                    <- Make check against players lumberjacking skill...
            SKL 44 1                   <- If check passes, add 1 point to jumberjacking skill...
            IADD 7021                  <- Add a log at the players feet.
            }

            This tigger will allow the player to use tongs on the small forge to produce iron ingots considering they have ore in thier pack.

            SECTION xfb1               <- The ID of the forge
            { Use a small forge
            REQ xfbbxfbc               <- Requires tongs...
            NEED x19b7x19b8x19b9x19ba        <- Must have ore in thier pack...
            STAM -3                    <- If they have ore, lower stamina by 3...
            SND 00 54                  <- Play pumping forge sound effect...
            ACT e                      <- Make player do a "staff jab" action...
            CSKL 7                     <- Make check against blacksmithy skill...
            USEUP x19b7x19b8x19b9x19ba       <- If check passes, use up some ore...
            SKL 7 5                    <- Add 5 to thier blacksmithy skill...
            IADD 7030                  <- Add an iron ingot at thier feet.
            }
 

Credits:
        Zadius Trigger code, trigger token and documentation author
        SpaceDog Trigger token designer and testing
        Tauriel Trigger code testing and merging
        Genesis Trigger token submissions and testing
        Myth Trigger code suggestions and testing