TCL-Programs Reference Manual

Contents

• Introduction
• Mob Triggers
• Object Triggers
• Room Triggers
• Area Triggers
• Mob Commands
• Char Commands
• Object Commands
• Area Commands
• Mud Commands
• Room Commands
• Trigger Commands
• Clan Commands
• Filesystem Commands
• Miscellaneous Commands
• Special functions

Mob commands

Default the mob command will use the mob that is running the mobprog. Directly after the mob command you can use switches to search for another mob. It duplicates some of the char commands to make writing mobprogs easier.

Switches:

Mob Command Reference

mob act <to> <format> [arg1] <arg2> [minposition]
The mob act command will be the main command for displaying texts. This command will take care of things like invisibility or blindness. It is wise to use this command for all messages that contain the mobs name in it. It is the same as the act_new function in the C code of the mud.

to can have the following values:

format This is a format string, with formatting specifications introduced by '$' (just as 'printf' introduces its formatting sequences with '%'). Typically this is a complete sentence with a subject and an object. Normally TCL also expands the $ sequences to variable names. To prevent this always specify the format string between curly brackets { }. Here are all the '$' sequences supported by 'act':

arg1 arg2 The first argument is optional and only has to be supplied when a $ sequence is used that needs the first argument. The second argument must always be supplied. If it isn't needed an empty string can be given.

minposition The message will only be send if the mob has at least the minimum position (optional argument). The positions are:

User contributed notes: mob act
mavetju@chello.nl Apr 5th 2000, 10:21	An example for the mob act function:   mob act tovict {$n hopes you'll behave.} [char id]

mob listaff
Returns a list of lists with the affects on the mob. The second level list consists of the following fields:

mob around <TCL-script>
This command executes the TCL-script in all surrounding rooms. This will mostly be used in combination with the act command.

mob assist <charid>
This command will help the charid in its current fight.

mob at <location> <TCL-script>
Execute TCL program while mob is at another location. Example:

mob at 3001 {
    ! smile
    ! say "Try to catch me!"
}
        

mob cansee <charid>
Returns true if the mob can see charid. This routine will not check if charid is in the same room as the mob.

mob cast [-noisy] [-speechonly] <spell> [target]
Lets the mobile to cast spells. Beware, this does only crude validity checking and does not use up any mana. All spells are available regardless of the race or other abilities of the mobile. Casting the spell occurs silently when -noisy isn't supplied, but spell effects are displayed normally. If -speechonly is supplied, all the mob does is say the spell. (speechonly implies noisy) Use this instead of [! say] to take the listeners magic_lore into account.

User contributed notes: mob cast
mavetju@chello.nl Mar 12th 2000, 13:05	-noisy is available since March 9th 2000.

mob delay <number>
Without arguments it returns the current delay timer. By specifying "cancel" as number the delay is canceled. With arguments it sets the delay timer. mob delay sets the time in PULSE_MOBILE after which the mobiles delay trigger is activated. If the mobile has a program defined for delay trigger, the program is executed when the timer expires.
mob hasdelay
Returns true if this mob has a mobprog pending.

mob descr [new description]
Returns the description of the mob. Or sets it if new description is supplied.

mob drunk <text> [<text> <text> ...]
Let the mob say this text as if it was drunk.

User contributed notes: mob drunk
mavetju@chello.nl Jan 4th 2001, 12:02	Usage: proc greet {} { mob drunk More beer! } addtrigger 1 greet {greet} {trig true}

mob echo <text> [<text> <text> ...]
Sends the text directly to this mob.

mob exists
Returns true if the mob exists. This is the only command that will not result in an error and the script aborting if there is no mob found. Useful for testing if a trigger has a -second mob.

mob extract
Removes this mob from the game. When executing mob commands will generate error messages most of the time.

mob extradescr list|add|mod|del [keyword [description]]

mob fighting [-id|-vnum|-name]
Returns the id (or vnum or name) of whoever the mob is fighting. If the mob is not fighting 0 (or in case of -name an empty string) is returned. If the mob is fighting a PC and -vnum is specified 0 is returned.

mob flee
Causes a mobile to unconditionally flee from combat. Can be used for example with the hit point percentage trigger to simulate "wimpy" behavior.

mob fullname [new full name]
Returns the full name of the mob. Or sets it if new full name is supplied.

mob give [-loud] <object id> <char id>
Transfers the ownership of an object from the mob to a mob/player

mob goto <location>
The mob goes to the specified location. No messages are displayed.

mob hasbeenkilledby
Returns true if the mob (or an instance) has already been killed once by the character.

mob he
Returns he/she or it depending on sex.

mob him
Returns him/her or it depending on sex.

mob his
Returns his/hers or its depending on sex.

mob hpcnt
Returns percentage of hitpoints left.

mob hunt <charid>
Hunts a mob or character. Returns -2 if the char doesn't exist, returns -1 if no path was found or the numerical value of the exit when it was found (see also: directionname in the misc-section). NOTICE: this command doesn't move the mob, it only returns the direction to the target.
mob walk [-room] [-mob] [-char] [-global] <id>
Walks to a mob, character or a room. If the target is a mob or a char -global makes the search go beyond area boundris, the flag has no affect when used with -room. Returns false if the id does not exist. See also the walked-trigger.
mob hunt_type
Returns either 'none','find','kill','room','unknown' depending on which (and if) the mob is hunting
mob hunt_id
Returns the id of the char/mob (or vnum of the room) the mob is hunting

User contributed notes: mob hunting
jodocus@fataldimensions.org Jan 11th 2002, 21:50	It helps to add 'g:' in front of the id to search the whole mud. eg mob hunt g:[char id]

mob id
Returns the id of the mob.
mob vnum
Returned the vnum of the mob

mob impinvis [boolean]
Set the AFF_IMPINVISIBLE flag. With argument true the impinvisible flag will be set. Otherwise it will be removed. This command returns the new status of the impinvis flag. Without arguments it will just return the status.

mob isactive
Returns true if the mob isn't sleeping (or dieing)

mob iscarrying <objid>
Returns true if mob is carrying object with objid.

mob iswearing <objid>
Returns true if the mob is wearing the object with given objectid.

mob kill <charid>
Mob will kill char with charid.

User contributed notes: mob kill
edwin@mavetju.org Aug 20th 2001, 09:06	Won't attack NPCs, works only on players.

mob leave
Let the mob leave in a random direction.

mob level [new level]
Returns (or sets) the level of the mob. Setting the level will influence the armor-class, damage, hit- and dam-roll, hitpoints, mana, and movement of the mob

mob longdescr [new long description]
Returns the long description of the mob. If a new long description has been specified, it will be used as the new long description. The newline at the end of the description will be added automaticly.

User contributed notes: mob longdescr
Smokey@fataldimensions.org Feb 9th 2003, 01:47	mob long "Wendie the newbie helper is helping [char]."

mob
Returns the mobs name. (Same as mob name)

mob money [-gold] [-silver] [-total] [-amountismax] [-deduct]|[-add] [amount [amount]]
Without options, or with -total it will return the total value of money a mob has, in silver-pieces. With -gold or -silver, it returns amount of gold or silver coins the mob has.

if none of -gold -silver -total are given , the amount of money the mob has is set or increased|decreased depending on -add|-deduct. A single amount is interpreted as 'total', two amounts as respectively gold and silver.

An attempt to deduct more money than the mob has will result in an error unless -amountismax is specified.

mob name
Returns the first name of the mob.

mob namespace [-db]
Returns the complete namespace where the mobprog for this mob instance resides. if -db is given, the namespace for the mobs database object is given instead.

mob oload <vnum> [level] [wear|take|wearnoshow]
This command will load object with vnum vnum into the mobs inventory. If "wear" is specified, the mob will wear the object. The "take" option is default. "wearnoshow" will equip the object but not show to other people.

mob peace[-self]
Causes the mob and all those fighting the mob to instantly stop fighting. If -self is given only the mob stops.

mob pet [char id]
Makes the mob a pet of char id. If char id is not supplied it returns true if the mob is (or has been) somebody's pet. A char can't have more than one pet. A mob can only become a pet once.

mob position [-text]
Returns the position of the mob. Using -text it returns a text:

User contributed notes: mob position
mavetju@chello.nl Mar 20th 2000, 23:49	mob position was added on 2000-03-20

mob property <key> <type> [value]
If value is defined, it will set the property to the character, otherwise it will return the value of the property matching the specified key/type.

Type can be:

mob delproperty <key> <type>
Removes the property from the mob.

mob remember [charid]
This command returns the remembered target. When giving an charid it remembers this character.

This command enables the mobile to remember a player for future reference in a mobprog. The player can subsequently be referred as char -target in programs activated by the mobile. mob forget clears the target. Most commonly this command is used in delayed programs, where the mobile has to remember the player who triggered the original event, for example to continue conversation.
mob forget
Forgets the remembered char.
mob hastarget
Does this mob have a target?
mob targethere
Returns true if the target of the mob is in the room of the mob.

User contributed notes: mob remember
mavetju@chello.nl Jun 2nd 2000, 11:49	See also: mob targethere

mob remove [-all] [objid]
Normally the remove command removes the object with the given object id from the character. When the -all switch is given the object with that objectid will be removed and the same command will be repeated again until no objects are found. If no arguments are given the command does nothing. If only the -all switch is given, all objects are removed.

This command removes objects from the inventory as will from the equipment.

mob restore
Just like the "restore" command in the mud: restore a mob to its max of hit/mana/movementpoints.

mob sex [new gender]
Reads or sets the gender of a mob. When reading it returns 'male' of 'female'. If new gender is given the gender is set to the new value. new gender may be one of the following:

mob short [new short description]
Returns the short description of the mob. Or sets it if new short description is supplied.

User contributed notes: mob short
A.J.Jessurun@tue.nl Feb 16th 2000, 17:30	Most of the time it is better to use the mob act command to display the mob short message. With mob act the visibility of the mob is taken into account.

mob dex
Returns the current dex of the mob.
mob str
Returns the current strength of the mob.
mob int
Returns the current intelligence of the mob.
mob wis
Returns the current wisdom of the mob.
mob con
Returns the current constitution of the mob.

mob timer [value]
Without arguments it returns the timer setting. With arguments it sets the timer. If argument is cancel the timer will be stopped.

mob timer value starts the timer at the given value. Every PULSE_MOBILE the timer will be increased. The timer can be stopped with the mob timer cancel command. The timer triggers the TIMER triggers. The trigger value will contain the value of the timer.
mob hastimer
Returns true if this mob has a timer running.

mob addtrigger <name> <type> <call> <trigger>
See addtrigger command
mob deltrigger [-all] [-prefix] [name]
It needs one ore more arguments. With the -all switch it deletes all triggers from this mob. You can also give the name of the trigger to delete. With the -prefix switch you can delete all triggers that are starting with a certain prefix.
mob triggers
Returns a list of triggernames for use with the trigger command.

User contributed notes: mob triggers
Smokey@fataldimensions.org Feb 9th 2003, 01:42	This can also be used to give other mobs triggers: for example this proc is on mob 30212, and gives 30213 a trigger. proc givetrig {} { ! grin mob -find v: 30213 addtrigger 1 exall {! say "None will pass!" ; return false} {trig exit north} } (PS you can't transfer a variable in it)

mob unequip [-silent] <location>
removes an object from the equipment location and puts it in the inventory.