TCL-Programs Reference Manual

Trigger Commands

ObjTrigger Command

The objtrigger command is defined as a separate command.

objtrigger <name> <type> <call> [<trigger>]

Adds a trigger to the object. Use <name> to give the trigger an unique name. Non-unique names will be rejected. Also numbers are allowed names. This name can be used to delete the trigger later. Type is the trigger type, like "drop", "eat", "zap", etc. Trigger types are described later. <call> is an TCL-script that should be executed. Normally this will be the name of a procedure to execute. The <trigger> gives the trigger condition. This should be a TCL command (or script) that returns a boolean. If the boolean is true, the <call> script will be executed. If no trigger condition is given, the call script will always be executed.

The <trigger>-script may generate variables that then can be used in the <call> script. The <trigger> script has also access to all other functionality you would normally have in a TCL-mobprog.

Trigger Types

Triggers are fairly easy to add, but this basic list should hold for most needs. Their names, argument list syntaxes, and translation into more articulate English are given below. Some triggers generate a trigger value. This value can be accessed with the [trig] command or trough the $::t variable. The trig command has a lot of routines for easy access to these trigger values.

Object Triggers Command Reference

close	give	lookin	quaff	time	zap
drink	hit	open	recite	trap
drop	interpret	play	remove	unlock
eat	load	positions	sell	use
enter	lock	pre_attack	speech	wear
get	lookat	put	sun/day	weather

trigger pre_close

Trigger value:-
Default character:Person or mob going to close the object
Called before the object is closed. If it returns a FALSE, the object will not be be closed.

trigger close

Trigger value:-
Default character:Person or mob who closes the object
Called when the object has been closed.

trigger pre_drink

Trigger value:-
Default character:Person or mob going to drink the object
Called before the object is drank. If it returns a FALSE, the object will not be be drunk.

trigger drink

Trigger value:-
Default character:Person or mob who drinks the object
Called when the object has been drank.

trigger pre_drop

Trigger value:-
Default character:Person or mob going to drop the object
Called before the object is dropped. If it returns a FALSE, the object will not be be dropped.

trigger drop

Trigger value:-
Default character:Person or mob who drops the object
Called when the object has been dropped.

trigger pre_eat

Trigger value:-
Default character:Person or mob going to eat the object
Called before the object is eaten. If it returns a FALSE, the object will not be be eaten.

trigger eat

Trigger value:-
Default character:Person or mob who ate the object
Called when the object has been eaten.

trigger pre_enter

Trigger value:-
Default character:Person or mob going to enter the object
Called before a mob/char have entered the object. If it returns a FALSE, the object will not be entered.

trigger enter

Trigger value:-
Default character:Person or mob which entered the object
Called when a mob/player have entered an object.

trigger pre_get

Trigger value:-
Default character:Person or mob going to get the object
Called before the object is taken. If it returns a FALSE, the object will not be taken.

trigger get

Trigger value:-
Default character:Person or mob who got the object
Called when the object has been taken.

trigger pre_getout

Trigger value:-
Default character:Person or mob going to get an object out of the container
Called before an object is taken out of the container. If it returns a FALSE, the object will not be taken.

trigger getout

Trigger value:-
Default character:Person or mob who got an object out of the container
Called when an object has been taken out of the container.

User contributed notes: object_triggers get
j.vanijperen@student.utwente.nl Jan 27th 2004, 23:02	pre_get and get also trigger when you try to get an object out of a container. At this date (27/01/04) the (pre_)getout triggers do not work.

trigger pre_give

Trigger value:-
Default character:Person or mob going to give the object
Called before the object is given to somebody. If it returns a FALSE, the object will not be given away.

trigger give

Trigger value:-
Default character:Person or mob who gives the object
Called when the object has been given.

trigger pre_hit

Trigger value:-
Default character:Char wielding the obj
Called before the object has damaged a player. If it returns a FALSE, the attack with this object will not happen. The weapon can be used again in the same round in haste/second/third attack.

trigger hit

Trigger value:-
Default character:Char wielding the obj
Called when the object has hit somebody.

trigger nohit

Trigger value:miss|parry|dodge|block
Default character:Char wielding the obj
Called when the obj failed to hit the opponent. Reason for it is in [trig value]. This trigger is NOT preceded by a pre_hit action.

trigger interpret_unknown

Trigger value:The command given by the player.
Default character:The person who gave the command.
This trigger is tested every time a character has entered a command which wasn't recognized as a valid command.

NOTE: Both mobs and players can trigger this trigger.

trigger pre_interpret

Trigger value:The command given by the player.
Default character:The person who gave the command.
This trigger is tested when a character is going to execute a valid command but the command hasn't been executed yet. If the procedure returns a TRUE, the command is blocked.

NOTE: Both mobs and players can trigger this trigger.

trigger post_interpret

Trigger value:The command given by the player.
Default character:The person who gave the command.
This trigger is tested every time a character a valid command is executed.

NOTE: Both mobs and players can trigger this trigger.

User contributed notes: object_triggers interpret
jodocus@fataldimensions.nl.eu.org Mar 25th 2001, 20:28	When using the interpret unknown trigger, the program should return false if it understood the command and true if it didn't understand it.

aggreviate@fataldimensions.org Dec 7th 2001, 10:44	Note: For both pre_interpret and post_interpret triggers. If it returns false, the valid command is blocked. If it returns true, the valid command is executed. In both cases of returns, the procedure called up by the trigger will always be run.

trigger load

Trigger value:-
Default character:-
Happens when an object is loaded and placed into a room, inventory or in another object. Note that this trigger doesn't go off for treasures and objects created during the loading of the player.

trigger canlock

Trigger value:-
Default character:Person or mob going to lock the object
Called before the object is locked. If it returns a FALSE, the object will not be be locked. This trigger REPLACES the check for a valid key.

trigger pre_lock

Trigger value:-
Default character:Person or mob going to lock the object
Called before the object is locked. If it returns a FALSE, the object will not be be locked.

trigger lock

Trigger value:-
Default character:Person or mob who locks the object
Called when the object has been locked.

trigger pre_lookat

Trigger value:-
Default character:Person or mob going to look at the object
Called before the object is looked at. If it returns a FALSE, the object will not be be looked at. Because of POLA this trigger will also fire when looking at extra-descriptions and the object has no pre_lookat_ed trigger.

trigger pre_lookat_ed

Trigger value:Extra description keyword
Default character:Person or mob going to look at the extra-description of an object
Called before the object is looked at. If it returns a FALSE, the object will not be be looked at.

trigger lookat

Trigger value:-
Default character:Person or mob who looked at the object
Called when the object has been looked at.

trigger lookat_ed

Trigger value:Extra description keyword
Default character:Person or mob who looked at the objects extra-description
Called when the objects extra-description has been looked at. Because of POLA this trigger will also fire when looking at extra-descriptions and the object has no lookat_ed trigger.

trigger pre_lookin

Trigger value:-
Default character:Person or mob going to look in the object
Called before the object is looked in. If it returns a FALSE, the object will not be be looked in.

trigger lookin

Trigger value:-
Default character:Person or mob who looked in the object
Called when the object has been looked in.

trigger pre_open

Trigger value:-
Default character:Person or mob going to open the object
Called before the object is opened. If it returns a FALSE, the object will not be be opened.

trigger open

Trigger value:-
Default character:Person or mob who opens the object
Called when the object has been opened.

trigger playfilter

Trigger value:full name of the song
Default character:Person or mob fidling with the jukebox
Called when showing the list of songs in the jukebox. Once for each song. If the trigger returns false the song is hidden from view. Also called before the pre_play trigger. If this trigger returns false the jukebox behaves as if the song doesn't exist.

trigger pre_play

Trigger value:full name of the song
Default character:Person or mob fidling with the jukebox
Called before the jukebox starts a song. If the trigger returns FALSE the song is never started.

trigger play

Trigger value:full name of the song
Default character:Person or mob fidling with the jukebox
Called when a song is started in a jukebox. The first line of the song appears some time after this trigger.

trigger pre_sleep

trigger pre_rest

trigger pre_sit

trigger pre_stand

Trigger value:-
Default character:Person or mob using the obj
Called before the mob starts to sleep/rest/sit/stand on the obj. If it returns a FALSE, the mob won't move to the new position.

trigger sleep

trigger rest

trigger sit

trigger stand

Trigger value:-
Default character:Person or mob using the obj
Called after the mob went to sleep/rest/sit/stand on the obj.

trigger pre_attack

Trigger value:means of starting the fight. Currently one of: bash, dirtkick, trip, tail, kill, murder, backstab, rescue, attack, eyepok e, magic
Default character:Person initiating the attack
This trigger is called when a mob start combat without using magic. (eg. kill/eyepoke/trip/backstab/....) The second char [char -second] is the mob being attacked.

trigger pre_put

Trigger value:-
Default character:Person or mob going to put the object
Called before the object is put into something. If it returns a FALSE, the object will not be be put into it.

trigger put

Trigger value:-
Default character:Person or mob who puts the object
Called when the object has been putted.

trigger pre_putin

Trigger value:-
Default character:Person or mob going to put an object in the container
Called before something is put in the container. If it returns a FALSE, the object will not be be put into it.

trigger putin

Trigger value:-
Default character:Person or mob who puts an object into the container
Called when an object has been put into the container.

trigger pre_quaff

Trigger value:-
Default character:Person or mob going to quaff the object
Called before the object is quaffed. If it returns a FALSE, the object will not be be quaffed.

trigger quaff

Trigger value:-
Default character:Person or mob who quaffs the object
Called when the object has been quaffed.

trigger pre_recite

Trigger value:-
Default character:Person or mob going to zap the object/mob
Called before the object is recite. If it returns a FALSE, the scroll will not be be recited. Target of the scroll is stored in -second (either obj or char)

trigger recite

Trigger value:-
Default character:Person or mob who recited the scroll
Called when the scroll has been recited. Target of the scroll is stored in -second (either obj or char)

trigger pre_remove

Trigger value:-
Default character:Person or mob going to remove object.
Called before the object is removed. If it returns a FALSE, the object will not be removed.

trigger remove

Trigger value:-
Default character:Person or mob which removed the object.
Called when the object has been removed.

trigger pre_sell

Trigger value:-
Default character:Person or mob going to sell the object, and the shopkeeper
Called before the object is sold. If it returns a FALSE, the selling of this object will not be done.

trigger sell

Trigger value:-
Default character:Person or mob selling the object, and the shopkeeper
Called when the object has been sold.

trigger buy

Trigger value:-
Default character:Person or mob selling the object, and the shopkeeper
Called when the object has been bought.

trigger pre_speech

Trigger value:The words said
Default character:Person or mob going to say the words
Called before the words are said. If it returns a FALSE, the words will not be be said.

This only goes for the objects in your inventory, in your equipment and in the room. Not for objects in objects.

trigger speech

Trigger value:The words said
Default character:Person or mob who said the words
Called when the words have been said.

This only goes for the objects in your inventory, in your equipment and in the room. Not for objects in objects.

trigger sunset

Trigger value:-
Default character:-
Happens after the message "the sun disappears in the west".

trigger sunrise

Trigger value:-
Default character:-
Happens after the message "the sun rises in the east".

trigger end_day

Trigger value:-
Default character:-
Happens after the message "the night has begun."

trigger start_day

Trigger value:-
Default character:-
Happens after the message "the day has begun."

trigger timer

Trigger value:-
Default character:-
Every object has a timer, this timer can be started with the obj timer command. Normally you issue an obj timer 0 command to let the timer start counting from 0. Every PULSE_TICK the timer trigger is called. You can use trig compare to check the trigger value.

trigger hour

Trigger value:time of day
Default character:-
This trigger is tested every hour in MUD time.

trigger random

Trigger value:-
Default character:-
NOTE: This trigger is checked each PULSE_TICK, even if there are no players in the room but there are in the area. If you want this event to be triggered always, you must set the ACT_UPDATE_ALWAYS flag of the mobile.

trigger delay

Trigger value:-
Default character:-
NOTE: This trigger is checked every PULSE_TICK and activates when the delay of a object (set with the obj delay command) expires. This trigger can be used to create staged object behavior. See also obj remember. An object can have several delay triggers, but every time the delay timer expires, all the triggers are checked and the first successful one executed.

trigger pre_trap

Trigger value:-
Default character:Person or mob triggering the trap
Called before the trap is sprung. If it returns a FALSE, the trap will not function. The mud will not report this, the progs need to take care of this if desired.

trigger trap

Trigger value:-
Default character:Person or mob who triggered the trap
Called when the trap has sprung.

trigger canunlock

Trigger value:-
Default character:Person or mob going to unlock the object
Called before the object is unlocked. If it returns a FALSE, the object will not be be locked. This trigger REPLACES the check for a valid key.

trigger pre_unlock

Trigger value:-
Default character:Person or mob going to unlock the object
Called before the object is unlocked. If it returns a FALSE, the object will not be be unlocked.

trigger unlock

Trigger value:-
Default character:Person or mob who unlocks the object
Called when the object has been unlocked.

trigger pre_use

Trigger value:whatever came behind 'use <obj>'
Default character:Person or mob going to use the object
Called before the object is used. If it returns a FALSE, the object will not be used.

trigger use

Trigger value:whatever came behind 'use <obj>'
Default character:Person or mob who uses the object
Called when the object is used. The normal use command doesn't output anything, it completly relies on these triggers for output.

trigger pre_wear

Trigger value:-
Default character:Person or mob going to wear the object
Called before the object is being worn. If it returns a FALSE, the object will not be be worn.

trigger wear

Trigger value:-
Default character:Person or mob wearing the object
Called when the object has been worn.

trigger weather

Trigger value:new_state old_state
Trips every time the weather changes. State is one of 'cloudless', 'cloudy', 'raining', 'lightning'.

trigger pre_zap

Trigger value:-
Default character:Person or mob going to zap the object/mob
Called before the object is zapped. If it returns a FALSE, the object will not be be zapped. Target of the zap is stored in -second (either obj or char)

trigger zap

Trigger value:-
Default character:Person or mob who zapped the object/mob
Called when the object has been zapped. Target of the zap is stored in -second (either obj or char)

TCL-Programs Reference Manual

Contents

Trigger Commands

ObjTrigger Command

Trigger Types

Object Triggers Command Reference

trigger pre_close

trigger close

trigger pre_drink

trigger drink

trigger pre_drop

trigger drop

trigger pre_eat

trigger eat

trigger pre_enter

trigger enter

trigger pre_get

trigger get

trigger pre_getout

trigger getout

trigger pre_give

trigger give

trigger pre_hit

trigger hit

trigger nohit

trigger interpret_unknown

trigger pre_interpret

trigger post_interpret

trigger load

trigger canlock

trigger pre_lock

trigger lock

trigger pre_lookat

trigger pre_lookat_ed

trigger lookat

trigger lookat_ed

trigger pre_lookin

trigger lookin

trigger pre_open

trigger open

trigger playfilter

trigger pre_play

trigger play

trigger pre_sleep

trigger pre_rest

trigger pre_sit

trigger pre_stand

trigger sleep

trigger rest

trigger sit

trigger stand

trigger pre_attack

trigger pre_put

trigger put

trigger pre_putin

trigger putin

trigger pre_quaff

trigger quaff

trigger pre_recite

trigger recite

trigger pre_remove

trigger remove

trigger pre_sell

trigger sell

trigger buy

trigger pre_speech

trigger speech

trigger sunset

trigger sunrise

trigger end_day

trigger start_day

trigger timer

trigger hour

trigger random

trigger delay

trigger pre_trap

trigger trap

trigger canunlock

trigger pre_unlock

trigger unlock