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

This command can be used to get information about the area. Default the area where the (mobprog executing) mob is standing will be used.

area ?-vnum <vnum>? ?-last? ?-area? <option> ?<arg> <arg> ...?

Switches:

Area Command Reference

area allchar [-name]
Returns a list of id's (or name's) of all player characters in the area.

area allmob <charid> <TCL commands>
This command will find all mobs with the given char id and run the TCL command as if they are the mob that is running the mob program (making it the default mob). No PC's will be used to execute these commands.

area
Returns the name of the area.

area count [-vnum <vnum>] [-group] [type]
Returns the number of players or mobs in the area. type is mob, PC or all. Default is player. For mobs the -vnum switch can be used. If the -vnum switch is used the mob parameter will be assumed. It overrides the PC as type. -group returns the number of group members of the char that initiates the room command.

area creator
Returns the name of the creator of this area.

area 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. area delay sets the time in PULSE_MOBILE after which the area delay trigger is activated. If the area has a program defined for delay trigger, the program is executed when the timer expires.

area echo <text ...>
Sends message to all players in the area.

area flag <name>
Returns the value of the area flag.

area llevel
Returns the lower level for this area.
area ulevel
Returns the upper level for this area.

area namespace
Returns the complete namespace where the areaprog for this area resides

area playersaround
Returns the amount of players in this area.

area recall
Returns the recall point of this area (as a vnum). Not all rooms in this area might have the same recall point.

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

area timer value starts the timer at the given value. Every PULSE_MOBILE the timer will be increased. The timer can be stopped with the area timer cancel command. The timer triggers the TIMER triggers. The trigger value will contain the value of the timer.

area addtrigger <name> <type> <call> <trigger>
See areatrigger command
area 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.
area triggers
Returns a list of triggernames for use with the trigger command.

area variable <name> <default value>
Creates a virtual local variable linked with a variable of the same name at area level. If the area level variable doesn't exist yet, it is created with value default value. The value of the variable will survive a copyover if and only if a link to it has been created since the previous copyover.

area vnum [name of area]
Returns the vnum of the area or, if name of area is not defined, the current area.

User contributed notes: area vnum
edwin@mavetju.org Mar 13th 2001, 11:48	How to use it: addtrigger 2 speech { areading } { trig true } proc areading {} { ! say We are now in [area vnum] set vnum [area vnum [trig]] if { $vnum != -1 } { ! say En [trig] is $vnum by [area -vnum $vnum creator] } }

area lvnum
Returns the lower vnum for this area.
area uvnum
Returns the upper vnum for this area.