str^%act(txt,inv,ch,vict,mode)
	 returns a string similar to act()
	 <mode> defines the view-point:
	    1: room       not implemented
	    2: vict       
	    3: notvict    not implemeneted
	    4: char     
	
	 returns -1 on error

room^%act(txt,inv,ch,vict,pulse)
	 act() TO_ROOM
	 Sends the output to everybody in the room, except <ch>
	 <txt>   is the relating echo text (check 'help mumps-act')
	 <inv>   1, then 'cansee' is checked and eventually you see 'Someone'
	 <ch>    instance of the actor
	 <vict>  instance of the victim (char or object)
	 <pulse> if pulse is not given, the %act is executed immediately,
	         else it is executed in <pulse> pulses         

vict^%act(txt,inv,ch,vict,pulse)
	 act() TO_VICT
	 Sends the output to the character <vict>
	 <txt>   is the relating echo text (check 'help mumps-act')
	 <inv>   1, then 'cansee' is checked and eventually you see 'Someone'
	 <ch>    instance of the actor
	 <vict>  instance of the victim (char or object)
	 <pulse> if pulse is not given, the %act is executed immediately,
	         else it is executed in <pulse> pulses         

notvict^%act(txt,inv,ch,vict,pulse)
	 act() TO_NOTVICT
	 Sends the output to everyone in the room, except <ch> and <vict>
	 <txt>   is the relating echo text (check 'help mumps-act')
	 <inv>   1, then 'cansee' is checked and eventually you see 'Someone'
	 <ch>    instance of the actor
	 <vict>  instance of the victim (char or object)
	 <pulse> if pulse is not given, the %act is executed immediately,
	         else it is executed in <pulse> pulses         

char^%act(txt,inv,ch,vict,pulse)
	 act() TO_CHAR
	 Sends the output to <ch>
	 <txt>   is the relating echo text (check 'help mumps-act')
	 <inv>   1, then 'cansee' is checked and eventually you see 'Someone'
	 <ch>    instance of the actor
	 <vict>  instance of the victim (char or object)
	 <pulse> if pulse is not given, the %act is executed immediately,
	         else it is executed in <pulse> pulses         

hit^%char(ch,set)
	 if <set> is not given, return hitpoints of character <ch>,
	 else set the hitpoints of character <ch> to <set>

maxhit^%char(ch)
	 return the maximum hitpoints of character <ch>

mana^%char(ch,set)
	 if <set> is not given, return mana points of character <ch>
	 else set the mana of character <ch> to <set>

maxmana^%char(ch)
	 return the maximum mana of character <ch>

move^%char(ch,set)
	 if <set> is not given, return the movement points of char <ch>
	 else set the moves of character <ch> to <set>

maxmove^%char(ch)
	 return the maximum movement points of character <ch>

exp^%char(ch)
	 return the number of experience points of character <ch>

str^%char(ch,set)
	 return the strength of character <ch>

con^%char(ch,set)
	 return the constitution of character <ch>

dex^%char(ch,set)
	 returns the dexterity of character <ch>

agi^%char(ch,set)
	 returns the agility of character <ch>

int^%char(ch,set)
	 returns the inteligence of character <ch>

spi^%char(ch,set)
	 returns the spiritual stat of character <ch>

wil^%char(ch,set)
	 returns the will of character <ch>

apt^%char(ch,set)
	 returns the aptitude of character <ch>

per^%char(ch,set)
	 returns the perception of character <ch>

straff^%char(ch,set)
	 returns the affected strength of character <ch>
	 if <set> is given, it will set the affected value.
	 Note: this is the absolute value, not the relative one (+10 or -20)

conaff^%char(ch,set)
	 returns the affected constitution of character <ch>
	 if <set> is given, it will set the affected value.
	 Note: this is the absolute value, not the relative one (+10 or -20)

dexaff^%char(ch,set)
	 returns the affected dexerity of character <ch>
	 if <set> is given, it will set the affected value.
	 Note: this is the absolute value, not the relative one (+10 or -20)

agiaff^%char(ch,set)
	 returns the affected agility of character <ch>
	 if <set> is given, it will set the affected value.
	 Note: this is the absolute value, not the relative one (+10 or -20)

intaff^%char(ch,set)
	 returns the affected inteligence of character <ch>
	 if <set> is given, it will set the affected value.
	 Note: this is the absolute value, not the relative one (+10 or -20)

spiaff^%char(ch,set)
	 returns the affected spiritual of character <ch>
	 if <set> is given, it will set the affected value.
	 Note: this is the absolute value, not the relative one (+10 or -20)

wilaff^%char(ch,set)
	 returns the affected will of character <ch>
	 if <set> is given, it will set the affected value.
	 Note: this is the absolute value, not the relative one (+10 or -20)

aptaff^%char(ch,set)
	 returns the affected aptitude of character <ch>
	 if <set> is given, it will set the affected value.
	 Note: this is the absolute value, not the relative one (+10 or -20)

peraff^%char(ch,set)
	 returns the affected perception of character <ch>
	 if <set> is given, it will set the affected value.
	 Note: this is the absolute value, not the relative one (+10 or -20)

isnpc^%char(ch)
	 returns 1 if the instance is a mobile, else 0. Returns -1 if
	 the given pointer isn't an instance pointer.

level^%char(ch)
	 returns the level of the given character instance

name^%char(ch)
	 returns the name/sdesc of the given character instance

nameown^%char(ch)
	 returns the name/sdesc of the given character instance and
	 appends either ' or 's depending on the name

ldesc^%char(ch,set)
	 If <set> is not submitted, the ldesc of the given character
	 instance is returned. if <set> is given, the ldesc will be changed
	 to <set>. If <set> is "", the ldesc will be initiallized to the
	 ldesc of the relating prototype.
	 You may also use that function to change the ldesc of a player.
	 Use this feature with care - it will be reset each time the player
	 leaves the room.
	 Returns -1 on error (for instance if char instance does not exist)

title^%char(ch)
	 returns the title of the given character instance

sex^%char(ch)
	 returns the sex of the given character instance
	 0: neutral,	1: male,  2:female

class^%char(ch)
	 returns the class index of the given character instance
	 0-3 obsolete
	  4: human warrior	 5: human rogue		 6: human cleric
	  7: elf warden	 8: elf ranger		 9: elf wizard
	 10: elf druid	11: dwarf warrior	12: dwarf slayer
	 13: orc shaman	14: black orc marauder  15: night gob fanatic
	 16: night gob hunter	17: forest gob scout	18: forest gob shaman
	 19: skaven storm	20: skaven gutter	21: skaven assassin
	 22: skaven monk	23: skaven grey seer

town^%char(ch)
	 returns the hometown index of the given  character instance
	 (none defined yet)

age^%char(ch)
	 returns the age in days of the current character instance

weight^%char(ch)
	 returns the weight in 1g of the current character instance

height^%char(ch)
	 returns the height in 1cm of the current character instance

race^%char(ch)
	 returns the race index of the current character index
	 PC:
	 -1 undef     0 human         1 elf           2 dwarf
	  3 orc       4 black orc     5 night gob     6 forest gob
	  7 skaven    8 immortal
	
	 NPC:
	  0 human     1 elf           2 dwarf         3 halfling
	  4 orc       5 golbin        6 ogre          7 troll
	  8 giant     9 drow         10 beastman     11 lizard
	 12 snake    13 plant        14 tree         15 insectoid
	 16 bird     17 fish         18 dragon       19 fungi
	 20 arachnid 21 spectral     22 winged-mammal23 multipede-mammal
	 24 skaven   25 crustacean   26 hobgoblin    27 objective
	 28 snotling 29 undead

align^%char(ch,set)
	 returns the align of the given character instance
	 if set is specified, sets the character's align

wait^%char(ch,set)
	 set waitstate delay for <ch> in <set> ms

fighting^%char(ch)
	 if <ch> is fighting the victim instance is returned
	 else -1

hunting^%char(ch)
	 if <ch> is hunting, the instance of the hunted char is returned
	 else -1

position^%char(ch)
	 return the char position of character <ch>
	 0: dead	1: mortallyw	2: incap	3: stunned
	 4: sleeping	5: resting	6: sitting	7: fighting
	 8: standing

setpos^%char(ch,pos)
	 change the char position of instance <ch>
	 0: dead      1: mortallyw    2: incap        3: stunned
	 4: sleeping  5: resting      6: sitting      7: fighting
	 8: standing

cweight^%char(ch)
	 return the carried weight of character <ch>

items^%char(ch)
	 return the number of carried items of character <ch>

id^%char(ch)
	 return the player_id of character <ch>

room^%char(ch)
	 return the room number where character <ch> is in, -1 if <ch> does
	 not exist and -2 if the room number is in NOWHERE

vnum^%char(ch)
	 return the virtual number incase <ch> is a mobile
	 else -1

leader^%char(ch)
	 if <ch> is following, then the leader instance is returned
	 else -1

mount^%char(ch)
	 if <ch> is riding, the instance pointer to the mount is returned
	 else -1

rider^%char(ch)
	 if someone is riding <ch>, the instance to the rider is returned
	 else -1

damage^%char(ch,vict,dam,force)
	 <ch> damages <vict> by <dam> points
	 Immortals are not damaged, except when <force> = 1
	 (the <force> variable may be omitted)
	 returns: 0: vict died, else 1

isppl^%char(ch)
	 checks if instance <ch> is a player
	 returns  1, if it is a connected player
	 returns  0, if it is a mobile
	 returns -1, if it is a linkless player
	
	 NOTE: if you just want to check if the instance is a mobile or
	 a player - DO NOT USE THIS FUNCTION - use $$isnpc^%char()

player^%char(name)
	 returns instance pointer to player <name>, else 0

pid^%char(p)
	 if p is a name, the player_id for player <p> will be returned
	 if p is a number, the name for the player with id <p> will returned,
	 else -1

force^%char(ch,text,delay)
	 force player/mobile <ch> to execute command <text>
	 if <delay> is set, the force will be delayed for <delay> pulses.
	
	 NOTE: if force is delayed, it is scheduled by C, so events will
	       trigger

toroom^%char(ch,room)
	 move character <ch> to room <room>
	 returns 1, if successful and -1 on error

toroomd^%char(ch,room,dir,script)
	 delayed-move character <ch> to room <room>.
	<dir> should contain the 'from_dir'-number if available - else,
	 set -1. Delayed in this context means, that it will be sent ASAP,
	 but after the script has ended. That has the nice advantage, that
	 an enter event is sent to the room.
	 If given the mumps-<script> is executed just after moving the char.
	 In this case, variables <who>, <dir> and <room> will be set.
	 Returns the cookie pointer, or -1 on error.

movedly^%char(ch,dir,script)
	 delayed-move character <ch> into the direction <dir>.
	 (just as if the character would have been forced)
	 Delayed in this context means, that it will be sent ASAP,
	 but after the script has ended. That has the nice advantage, that
	 an enter event is sent to the room.
	 If given the mumps-<script> is executed just after moving the char.
	 In this case, variables <who>, <dir> and <room> will be set.
	 Returns the cookie pointer, or -1 on error.

cansee^%char(ch,vict)
	 returns 1, if <vict> is visibile to <ch>, else 0

seeroom^%char(ch)
	 checks if <ch> can see in the current room. Returns:
	 0: if he cannot see
	 1: if he can see
	 2: if he can partially see (partial-nightvision; rooms and mobs)

list^%char(ch)
	 if <ch> is 0 or "" it will returns the first instance pointer
	 of the character list. Use this instance pointer as <ch> to get
	 the second entry, etc... All active mobile and player instances are
	 stored in that list.
	 Will returns 0 or -1 on Errors.
	
	 This function may only be called from % scripts.

send^%char(ch,txt,delay)
	 sends text <txt> to character <txt>. If <delay> is set
	 then the echo is delayed for <delay> pulses.
	 note that you have to add CR/LF at the end of the line

follower^%char(ch)
	 returns a string of the instance pointers to all followers of
	 <ch>, which are in the same room.
	 for example: 24433234 9927832 232232 #3
	 or #0, if no follower is in the same room
	
	 * THIS FUNCTION WILL DIE * DO NOT USE *

stopfi^%char(ch)
	 makes <ch> stop fighting
	 returns -1 if error

startfi^%char(ch,vict)
	 starts a fight between <ch> and <vict>
	 returns -1 if one of the instances did not exist
	         -2 if ch is already fighting

fightnum^%char(ch)
	 returns number of instances fighting <ch>

victnum^%char(ch,n)
	 returns the <n>'th instance (starts with 0) fighting <ch>
	 returns -1 if error

rent^%char(ch,mob)
	 rents player <ch>
	 if <mob> = 0, then the player will just be rented silently
	          = a mobile instance, then the player will be rented by the
	            mobile (CAN_SEE checks etc)
	  returns: 2, if char was rented
	           1, char was rented silently
	           1, mob>0, but player was rented
	           1, mob=0, but player was rented
	           0, mob>0, but rent didnt work
	          -1, if char has noquit or does not exist
	          

extract^%char(ch)
	 extracts character instance <ch> from the game
	 WARNING: for now, please only use $$extract on <me>
	 if mobile did not exist return -1

getdpos^%char(ch)
	 return default position of mobile <ch> - else -1

setdpos^%char(ch,pos)
	 set default position of mobile <ch>

load^%char(vnum)
	 loads mobile <vnum>. Returns the instance pointer if success
	 or -1 on error

proto^%char(vnum,f)
	 return prototype information for mobile <vnum>
	 f = 1: name
	 f = 2: short description
	 f = 3: long description
	 f = 4: load message
	 f = 5: deathcry
	 f = 6: relating corpse decay message
	
	 returns -1 if error

enemy^%char(ch)
	 returns the relating enemy name (e.g. *an Orc*) for the given
	 character instance returns -1 on error

sideok^%char(ch,vict)
	 returns 1, if the character instances are from the same
	 side. returns 0, if that is not the case

ex^%char(ch)
	 returns 1 if the character instance exists, else -1

var^%char(ch,var,value,tim)
	 either sets or reads a mob/player specific variable
	 <ch>    is the instance number
	 <var>   is the name of the variable
	         or a position indicator which will return the variable
	         name and its value seperated by a ':'
	 <value> if set, that value will be assigned to the given variable
	         if unset, the current value of the given variable will be
	         returned. -2 if it does not exist.
	 <tim>   if set, the var will delete after <tim> pulses
	 returns -1 on error, 1 on success or see above

vdel^%char(ch,var,mode)
	 deletes a given instance variable
	
	 <mode> = 0 or not given: just delete var
	 <mode> = 1             : delete all variables starting with <var>
	
	 returns 1 or the number of delete variables if successful
	  -1 if error, -2 if not found, -3 if secure

vwipe^%char(ch)
	 deletes all instances vars, returns 1 if ok and -1 if instance
	 did not exist

col^%char(ch,code)
	 returns the color sequence relating to the keyword <code>,
	 which was chosen by user <ch>. It returns the default color, if
	 <code> was empty-string. It returns the emptry-string on any error.
	 (see: 'change col' for the keywords)

walkmess^%char(ch,dir,mode)
	 returns the MUD arrive/leave message for char <ch>
	 moving into direction <dir> (number)
	 <mode> = 0: leave     = 1: arrive

num^%char(vnum)
	 returns number of mobiles with <vnum> which are loaded
	 and -1 on error

geteq^%char(ch,pos)
	 return the instance to the object, which <ch> is wearing at
	 position <pos> (see wornat^%obj for positions) - returns -1 on err

equip^%char(ch,obj,pos)
	 equip character <ch> with obj <obj> at pos <pos>
	 returns -1 on error

exist^%char(vnum)
	 returns 1 if a mob with given vnum exists and -1 if not

roomppl^%char(room,ch)
	 if <ch> is not used, it will return the instance of the
	 first character in room. If <ch> is used, it will return the
	 instance of the next char instance in room. 
	 It returns 0, if no instance follows and -1 on error.

getflag^%char(ch,bit)
	 returns bit <bit> of the character <ch>, -1 on error
	
	 players:
	 8 noshout      
	12 nowizlist    
	18 notell
	
	 mobiles:
	 0 specprog      1 sentinel      2 scavenger     3 %
	 4 aware         5 aggressive    6 stay_zone     7 wimpy
	 8 aggr_evil     9 aggr_good    10 aggr_neutral 11 memory
	12 helper       13 nocharm      14 nosummon     15 nosleep
	16 nobash       17 noblind      18 %            19 mount
	20 horse        21 stay_sector  22 stay_sec_gr  23 use_doors
	24 patrol       25 no_events    26 security     27 hunter
	28 build        29 unique

togflag^%char(ch,bit)
	 toggles <bit> of character <ch>
	 (check /mum grep $$getflag^%char for bit descriptions)
	 
	 Watch out - if someone saves the mobile, your changed flags will
	 be saved too - so reset the relating flags on create_event ...

immort^%char(ch)
	 returns 1 if immortal, 0 if mortal and, -1 if error

affects^%char(ch)
	 returns the hunger, thirst, drunk status or -1 if error
	 <hunger>,<thirst>,<drunk>
	 additonal search keyword: food, water, drink

setaff^%char(ch,hunger,thirst,drunk)
	 set hunger, thirst and drunk (set "" to keep
	 the current setting)
	 additonal search keyword: food, water, drink

stopflee^%char(ch)
	 stop fleeing for <ch>

startflee^%char(ch)
	 if <ch> is a player, then start the periodic flee mode. If it
	 is a mobile, just try one flee

canmove^%char(ch,room,dir,echo)
	 several checks are done to see, if either
	 - <ch> is able to move to <room>
	 - <ch> is able to move into the direction <dir> (number)
	 (if both are given, <dir> overrides)
	
	 Returns:
	   >0  (actor instance), if <ch> is able to move
	   =0  if <ch> is not able to move
	   <0  on other errors. (e.g. room or char does not exist)
	
	 If <echo> is not given or 0, no echos at all will be made, if <echo>
	 is 1, echos like "You need a boat.." are sent to the char.
	
	 CHECKS:
	 - player (writing) or (fighting) or (charmed) cannot move
	 - mount checks (able to ride, invalid position)
	 - npc: stay_zone, stay_sector, stay_sect_group, nomob room/exitflg
	 - need boat, swim
	 - enough movement points
	 - godroom
	 - climb (if <dir> is given)
	
	 WARNING: no exit exist checks are done!!! (see: $$exitok^%char)
	
	 NOTE: for return >0. 'Actor instance' will be the mob/pc which
	       will actually move. In most cases it is <ch>, but if <ch>
	       is riding, the instance of the mount is returned.

exitok^%char(ch,dir,echo)
	 checks to see, if <ch> is able to move to <dir> (num)
	 Returns: 1 if able, 0 if unable and -1 on error.
	
	 If <echo> is not given or 0, no echos at all will be made, if <echo>
	 is 1, echos like "You need a boat.." are sent to the char.
	
	 CHECKS:
	 - exit exists
	 - door open
	
	 (also see: $$canmove^%char)

idle^%char(ch)
	 returns the idle timer of <ch> or -1 on error

full^%char(ch)
	returns 1 if char is full and cannot eat anymore, else it returns 0
	 it will return -1, if <ch> is no existing char

stoptrack^%char(ch)
	 stop tracking

randir^%char(ch)
	 return a random direction number for <ch>
	 (it does 'exitok' and 'canmove' checks)

okdirs^%char(ch)
	 returns the number of accessible directions of <ch> and the
	 relating direction mask. It returns -1 on error.
	
	 If <dir> is given, then the direction is not included in the result.
	
	 e.g.: w $$okdirs^%char(me)  =>  "3-015"
	                                  |  +---- north, east, down
	                                  +------- 3 dirs
	
	 (accessible := $$exitok and $$moveok must apply)
	

walkto^%char(ch,room,speed,mode)
	 make mobile <ch> walk to <room>. It does that at a
	 speed of one room per <speed> seconds. If <speed> is not given
	 a default of 10 is used.
	
	 The function returns 1 if the walk request was sent, -1 if the
	 mobile does not exist and -2 if the room is not reachable.
	 
	 If <room> == "", then the mobile will walk 'back' to the original
	 room (if that existed). An ARRIVE event is triggered when arriving
	 back home aswell as when arriving at the destination.
	 
	 <mode> bit0: (01)  track through doors
	        bit1: (02)  enter/leave
	        bit2: (04)  ignore nomob
	        bit3: (08)  also open closed hidden doors
	
	 NOTE: stay_zone, stay_sector and stay_sect_group flags are ignored

dest^%char(ch)
	 returns <ch>'s destination room, else -1
	 (see $$walkto^%char() )

home^%char(ch)
	 return 'home'-room of <ch>, else -1
	 (see $$walkto^%char() )

account^%char(ch)
	 returns the account index to which <ch> belongs. Or
	 -1 if it is a mobile
	 -2 if the player is not connected
	 -3 if the player does not belong to any account

addwound^%char(hitter,ch,type,pos,duration)
	 adds a wound to <ch> done by <hitter>
	 at <pos> body position for <duration> seconds. If <ch> == <hitter>,
	 then no echo, by the C-code is done.
	 returns 1 if ok and -1 if some error occured.
	
	 <pos> 0 head         1 rip           2 l.shoulder    3 r.shoulder
	       4 l.arm        5 r.arm         6 r.hand        7 l.hand
	       8 r.leg        9 l.lef        10 r.foot       11 l.foot
	
	 <type> 0 swollen     1 shallow       2 blistered     3 puncture

gainxp^%char(ch,xp)
	 adds <xp> to the experience points of <ch>. <xp> may also be
	 a negative number!
	
	 returns either -1 on error or the new experience value of the 
	 relating char.
	
	 limits:
	  * only works for mortal players
	  * does not work for |<xp>| > 5000 

echo^%char(ch,mode)
	 handles local-echo for <ch>
	 <mode> == 0 for echo_off   and <mode> == 1 for echo_on

save^%char(ch)
	 save character <ch>. Returns 1 if ok, and -1 on error.

validnam^%char(nam)
	 returns 1, if the MUD thinks this is a valid name, else 0

tracks^%char(room,ch)
	 tracks character <ch> in <room>. Returns values are:
	 255, if char is in just this room
	 0-5, representing the direction if tracks of <ch> were found
	  -1, if something went wrong

tellok^%char(ch,vict)
	 check if <ch> is allowed/able to send a tell to <vict>.
	 Returns 1, if this is possible, 0 if not and -1, if one of the
	 instances do not exist.
	 checks for:
	 - telling to self
	 - linkless
	 - sleeping
	 - notell
	 - player and not a mobile

tellok2^%char(ch,vict)
	 check if <ch> is allowed/able to send a tell to <vict>.
	 Returns 1, if this is possible, 0 if not and -1, if one of the
	 instances do not exist.
	 checks for:
	 - tellers are visible to each other
	 - immortal tell restrictions are ok

tell^%char(ch,vict,txt)
	 send tell <txt> from <ch> to <vict>. Returns always 1.
	 (only check done, is for POS_SLEEPING)
	 it is advisable to only do that when $$tellok() returned 1.

note^%char(pid,txt,mode)
	 add <txt> to the notes of player with <pid>. *secure*
	 <mode> 0: without any prefix
	        1: prefix date
	        2: prefix spaces as long as a date-string
	        3: prefix CRLF and then date

bashed^%char(ch)
	 returns 1, if <ch> is bashed and 0 if not bashed, else -1

wps^%char(ch)
	 returns wps of char <ch> or -1 on error
	
	 result: <rounded>,<floating_point>
	         e.g.: 15,14.9998
	
	 note: only the 'rounded' number is shown to mortals (warlords, info)

acclist^%char(aid)
	 sets a table (pid) with char_ids as index, which are in the
	 account <aid> *secure*
	 returns -1 on error or the number of chars_in_account
	
	 $$acclist^%char(6)
	   pid(1)=6
	   pid(10)=6
	   pid(245)=6
	
	 character with pid 1, 10 and 245 are in account 6

invis^%char(ch,set)
	 get/set invis level of character
	 if <set> is not a number or not defined, then the invis level of
	 the given character is returned. If <set> is a number and <ch> is
	 an immortal, then the invis level is set to <set>.
	 If the character does not exist or is not immortal, -1 is returned.

findroom^%char(room,vnum,num)
	 return the char instance of the <num>th mobile
	 with <vnum> in <room>. returns -1 on error.
	 
	 This also works for players. If <vnum> is negative, it looks for
	 the player with the relating <id>.

prompt^%char(ch)
	 returns the prompt of <ch> or -1 on error

camefrom^%char(ch,dir)
	 if <dir> is not set, the direction number where <ch>
	 came from is returned. If <dir> is set - this number is set as
	 came_from direction.
	 returns -1 on error

maxcarry^%char(ch)
	 max-weight the character <ch> can carry

speed^%char(ch,secs)
	 set mobile movement speed to once move every <secs>. If
	 <secs> is omitted, the current mobile speed is returned

dontmove^%char(ch,set,ti,label)
	 Set the 'dont_move' flag to <set> (either 0 or 1).
	 If <set> and <ti> are omitted, the current value of that flag is
	 returned.
	
	 If <ti> is set, the dontmove flag is set to 0 after <ti> pulses.
	 If in addition <label> is set, then the given code is called. In
	 this case <who> is set to identify the relating instance.

retired^%char(ch)
	 returns 1, if the relating character is retired. Else 0. If
	 some error occured we get -1.

zone^%char(ch)
	 returns the zone <ch> is in, else returns -1

armour^%char(ch)
	 return the physical and mental armour of <ch>, or -1 on error
	 Example output: "5%/13%", where the first is physical-armour and
	 the last is mental-armour.

enemynum^%char(ch)
	 returns the number of mortal enemies in the same room,
	 or-1 on error

coins^%char(ch,set)
	 returns the coins of the given character instance
	 if <set> is specified, sets the character's coins
	 keyword: gold, silver, copper, money

stats^%char(ch)
	 returns OB,PB,DB,SB of character <ch>, or -1 on error

lasttell^%char(ch)
	 returns the <pid> to which <ch> last sent a tell and -1 on err

pidinfo^%char(pid)
	 return player info based on player <pid>
	 returns: <aid>,<name>,<level>   or -1 on error

inroom^%char(room,vnum)
	 returns 1, if mobile with <vnum> is in room *OPTIMIZE*

log^%comm(t)
	 log the given text <t> to the mud syslog

mudlog^%comm(t)
	 log the given text <t> to syslog and to the messaging system

time^%comm()
	 returns timestamp of current real time in seconds e.g.: 1044528824

daytime^%comm()
	 returns time of day (sunrise, day, sunset, night)

in^%comm(time,ken,code,prio)
	 NOTE: this function actually only got 2 parameters,
	 but due to downwards compatibility, we still got to keep all 4!
	
	 THIS FUNCTION IS OBSOLETE - please use add^%sched
	
	 <time> is the time in seconds when the task should execute
	 <ken>  is the code to be executed (must not exceed 160bytes)
	
	 Returned is a cookie number. Using this number and $$cancel^%sched()
	 the task may be canceled. -1 is returns if those code is too long.

sendall^%comm(txt)
	 global echo of <txt>

sendflagged^%comm(var,txt)
	 send <txt> to all players who got the instance variable
	 <var> set

port^%comm(ch)
	 set mumps output-port to character instance <ch>
	 after that all 'write' commands are sent to that instance
	
	 if <ch> is set to 1, then all the writes will be appended to the
	 databuffer. If you are done with appending, call $$port again
	 and set it to 0
	
	 as hack you may also use a character name as <ch>

hour^%comm()
	 returns the current hour of the mud day

sendlvl^%comm(lvl,txt)
	 send echo <txt> to all players above level <lvl>

event^%comm(enum,room,me,vars)
	 triggers a room event <enum> for room <room>
	 <me> is the triggering instance pointer (that will prevent, that
	      the calling instances will get its own event)
	 <vars> is a set of variables and their values which are needed by
	        the event (e.g. who="_me_" from="_room)
	 note: the event will not be triggered insta, but after the relating
	       script is finished
	 check 'help mumps-events' for the relating event numbers
	
	 WARNING: it is very important to make exactly the same variables
	          available which would have been if the event was triggered
	          by the MUD.
	
	 WARNING: <override> and <mute> of course do not work, since the
	          event is triggered by itself and not as part of some
	          mob/user interaction. Not being able to override might
	          lead to UNEXPECTED BEHAVIOR on other scripts. Be AWARE !

instance^%comm(ptr)
	 returns a description of the given instance pointer
	 Examples: {mobile 4 postmaster} or {object 809 broom} or
	           {player 2 Axeltest} or {room 100}
	 It returns {undefined} if no match was found

format^%comm(txt)
	 formats/wraps <txt> for 80 column output. Also converts the
	 first letter of the string to uppercase. Then it returns the new
	 string

flog^%comm(file,text)
	 writes <txt> to the file <file>. lib/log is prepended to
	 the given <file> and "." may not be part of it.

mcall^%comm()
	 returns the script-entry (label^routine) which was called by the C
	 code. Usually ( <event>^<scriptname> )

ev^%comm()
	 returns the event-number which triggered a script or ""      

evnam^%comm(ev)
	 returns the event-name to the given event number or ""

evhook^%comm(script)
	 returns a 0/1-string representing the events, which are
	 hooked by <script>.  e.g.: <script> = ro3342
	 on error or if no events are hooked it returns ""

crash^%comm()
	 returns 1, if last restart was due to a crash and 0 otherwise

editfile^%comm(ch,filename,mode,script)
	 let <ch> edit the file <filename>
	 For obvious security reasons the filename will be relative to the
	 'lib/etc/mumps' directory. In addition (dots) '.' are not allowed
	 in the filename.
	
	 if <mode>=1 then not the contents of the file will be used as base,
	 but the data-buffer.
	
	 <script> may be the label to a script which is called when the edit
	 session is either finished or canceled. Following vars are imported:
	   <who>        instance of the actor
	   <action>     0: canceled, 1 saved
	   <id>         edit session id (pointer)
	   <data>       filename
	
	 returns sessions editing id or -1 if error

viewfile^%comm(ch,filename,source,mode)
	 let <ch> view the file <filename>
	 <source>  0: file(*),   1: data-buffer
	 mode: 1: paged,   2: depending on editor setting(*)
	 For obvious security reasons the filename will be relative to the
	 'lib/etc/mumps' directory. In addition (dots) '.' are not allowed
	 in the filename.
	 returns 1, if viewing was started. Else -1

frmbuf^%comm(
	 formats the contents of the databuffer

attach^%comm(obj,lidx)
	 attaches library <lidx> to the non-prototyped object <obj>
	 *SECURED*
	 returns:
	    1, if successful
	    0, if not successful
	   -1, if <obj> does not exist
	   -2, if <lidx> is not valid
	   -3, if the object is prototyped
	   -4, if script was called from a non-% script

shutdown^%comm()
	 returns the number of secunds until shutdown/reboot - or 0

pulse^%comm()
	 returns the current pulse

tps^%comm()
	 pulses per second

playing^%comm()
	 returns a list of how many players are playing *secure*
	 return: <sum_of_all>-<race0>,<race1>,..

override^%comm(v)
	 set the C-code-check override variable
	 bit 0: (01) override climb-flag check
	 bit 1: (02) override swim-flag check
	 bit 2: (04) override exhausted check

cmd^%comm()
	 returns the last command-keyword which was typed *secure*
	 warning: this may not work for all delayed commands!!

attachevent^%comm(evnum,type,vnum,code)
	 attach an event to a mob, obj or room
	 Please ask before using - this is still beta!!!
	
	 <evnum> event number as found in 'mumps-events'
	 <type>  0:mob, 1:obj, 2:room
	 <vnum>  ..
	 <code>  label
	
	 *DO NOT USE*!

removeevent^%comm(evnum,type,vnum)
	 remove-event *DONT USE*

color^%comm(col)
	 sets the color-type to use for the next send^%char() or
	 send^%room(). Returns -1 on error.
	
	 That setting is reset to Normal (5) after the script is done
	 or on the next heartbeat. Though in most cases you should add
	 another call of this function after the colored output is done,
	 so all following output is colored appropriately again.
	
	  0 damage     1 enemy         2 hit           3 look
	  4 narrate    5 normal        6 shout         7 tell
	  8 emote      9 say          10 exits        11 system
	 12 weather   13 daytime      14 yell         15 gossip
	 16 condition

maxsecs^%comm(s)
	 time in seconds until a script is auto-interrupted (protection
	 from endless-loops) *SECURE*
	 <s> == 0: current value is returned

dontcancel^%comm()
	 do not cancel the current script on time overrun *SECURE*

%deb^%deb(nam,txt)
	 send <txt> to player with he name <nam> [2004-Nov-29 Sigmar]

dress^%lib(me)
	 call lib-dress, where <me> is the instance of the loaded mobile

vars^%lib(id)
	 returns string of relating variables to that library, or -1 if
	 error or nothing was found

ptr^%lib(id)
	 returns the pointer to the lib struct, or -1

goto^%lstory(me,who,lab)
	 start story script of mobile instance <me> at label <lab>
	 using <who> as the one who the story is directed to. The story
	 will be started insta (in the same pulse)
	
	 ALONE mode. If who is set to 0 the storyteller should
	 act with no player target; nor react to enter, hear or give; and not
	 cancel on being in a different room.
	
	 DEVOTE mode. If who is set to "dev:"_(player instance)
	 the storyteller should react only to this player, and not cancel on
	 being in a different room.
	
	 return codes:
	  1 ok
	 -1 character <me> does not exist
	 -2 label does not exist

stop^%lstory(me)
	 stop story of <me>. Always returns 1

var^%lstory(ch,var,set)
	 lets you read/write variables of the storyteller mobile <ch>
	 See: $$var^%char() for a list of return values.

busy^%lstory(ch)
	 returns 1 if the storyteller mobile <ch> is telling a story
	 Otherwise, if done or hung, returns 0.

vdel^%lstory(ch,var)
	 deletes a variable of the storyteller <ch>
	 See: $$vdel^%char() for return values

remove^%obj(o)
	 remove object <o> from any connected instance (room,mob,container)
	 returns 1 if successful or -1 if object does not exist

room^%obj(o)
	 returns the room vnumber where object <o> is located, -1 if <o> does
	 not exist and -2 if the room is NOWHERE

give^%obj(o,ch)
	 give object <o> to character <ch>. Returns 1 if successful
	 and -1 if either the object or the character did not exist.

create^%obj()
	 creates a virtual object and returns its instances pointer

extract^%obj(o)
	 extract object <o> from the world. And return 1.
	 WARNING: for now, please only use $$extract on <me>
	 if object did not exist return -1

vnum^%obj(o)
	 returns the object vnum. Or -1.

owner^%obj(o)
	 returns the player_id of the object owner and -1 if failed

name^%obj(o,set)
	 if <set> is not given, the object name (aliases) is returned
	 if <set> is given, the object name is changed to <set>
	 returns -1 on error

ldesc^%obj(o,set,ch)
	 if <set> is not given, the object ldesc is returned
	 if <set> is given, the object ldesc is changed to <set>
	 if <set> is "", the ldesc will be initialized to the ldesc of
	 the relating prototype.
	
	 In special cases it could be useful to not just output the long-desc
	 string, but to have it behave in the way %act does. In that case
	 the character who looks at the room will be automatically set as
	 the actor (the $n in act), while the given argument <ch> will be
	 saved as the victim ($N in act)
	 (the coder-flags output is screwed up a little, if above act
	 feature is used)
	 
	 returns -1 on error

sdesc^%obj(o,set)
	 if <set> is not given, the object sdesc is returned
	 if <set> is given, the object sdesc is changed to <set>
	 if <set> is "", the sdesc will be initiallized to the ldesc of
	 the relating prototype.
	 returns -1 on error

edesc^%obj(o,set)
	 if <set> is not given, the object edesc is returned
	 if <set> = 1, the object edesc is changed to the contents
	          of the data buffer (see: $$port^%comm)
	 if <set> is some other string, the edesc will be changed to <set>
	 if <set> is "", the edesc will be initiallized to the ldesc of
	 the relating prototype.
	 returns -1 on error

notake^%obj(o,set)
	 if <set> is not given, the object notake-desc is returned
	 if <set> is given, the object notake-desc is changed to <set>
	 if <set> is "", the ldesc will be initiallized to the ldesc of
	 the relating prototype.
	 returns -1 on error

carried^%obj(o)
	 returns the instance of the character who has this object in
	 inventory. Returns -1 if it is not in an inventory.

wornby^%obj(o)
	 returns the instance of the character who is wearing this object
	 returns -1 if it is not worn or any other error.

wornat^%obj(o)
	 returns the position where the object is worn. returns -1, if
	 it is not worn or on any other error.
	  0 hold1      1 hold2         2 wield1        3 wield2
	  4 shield     5 buckler       6 finger_r      7 finger_l
	  8 wrist_r    9 wrist_l      10 neck         11 body
	 12 head      13 legs         14 feets        15 hands
	 16 arms      17 about        18 shoulder     19 back
	 20 acr_back  21 face         22 w_2handed    23 tail
	 24 as_belt   25 onbelt1      26 onbelt2      27 onbelt3
	 28 onbelt4   29 onbelt5

in^%obj(o)
	 if given object is in a container, the instance of the container
	 is returned. Else -1

material^%obj(o)
	 returns the material number of the given object. If the object
	 does not exist, -1 is returned.
	  0: undef	 1: wood	 2: stone	 3: metal
	  4: mithril	 5: vegetation	 6: flesh	 7: grass
	  8: leather	 9: cloth	10: paper	11: gemstone
	 12: gold	13: silver	14: bone

typeflag^%obj(o,set)
	 if <set> is not given, the object type number is returned
	 if <set> is given, the object type is changed to <set>
	 returns -1 on error
	  0: undef	 1: light	 2: scroll	 3: wand
	  4: 		 5: weapon	 6: 		 7: missile
	  8: treasure	 9: armor	10: potion	11:
	 12: other	13: trash	14: 		15: container
	 16: note	17: drinkcon	18: key		19: food
	 20: money	21: pen		22: boat	23: fountain
	 24: shield	25: herb	26: ring	27: amulet
	 28: furnitur

wearflag^%obj(o,set)
	 if <set> is not given, the object wear number is returned
	 if <set> is given, the object wear number is changed to <set>
	 returns -1 on error
	  0: take	 1: finger	 2: neck	 3: body
	  4: head	 5: legs	 6: feet	 7: hands
	  8: arms	 9: shield	10: about	11: as_belt
	 12: wrist	13: wield	14: on_belt	15: shoulder
	 16: back	17: about_back	18: face	19: tail
	 (those are bit-values - e.g. on_belt => 2^14 = 16384)

extflag^%obj(o,set)
	 if <set> is not given, the object extra flag is returned
	 if <set> is given, the object extra flag is changed to <set>
	 returns -1 on error
	  0: build	 1: security	 2: norent	 3: magic
	  4: nodrop	 5: anti-good	 6: anti-evil	 7: anti-neutral
	  8: no-sell

weight^%obj(o,set)
	 if <set> is not given, the object weight is returned
	 if <set> is given, the object weight is changed to <set>
	 returns -1 on error

cond^%obj(o,set)
	 if <set> is not given, the object condition is returned
	 if <set> is given, the object condition is changed to <set>
	 returns -1 on error

maxcond^%obj(o)
	 the maximum object condition is returned or -1 on error

aff^%obj(o,set)
	 if <set> is not given, the object affects are returned
	 if <set> is given, the object affects are changed to <set>
	 returns -1 on error

toroom^%obj(o,r)
	 moves the object <o> to the room <r>. Returns 1 if successful
	 and -1 if either object or room did not exist.

tochar^%obj(o,ch)
	 move object <o> into the character <ch>'s inventory
	 that function also takes care that the objects is removed from
	 the previous holder instance
	 Returns 1 on succesa and -1 on failure.

toobj^%obj(o,tobj)
	 move object <o> into object<tobj>
	 that function also takes care that the objects is removed from
	 the previous holder instance

list^%obj(obj)
	 if <obj> is 0 or "" it will return the first instance pointer
	 of the object list. Use this instance pointer as <obj> to get
	 the second entry, etc... 
	 Will returns 0 or -1 on Errors.

listroom^%obj(room,obj)
	 if <obj> is 0 or "", it will return the first instance
	 pointer of the objects-in-room-list. Use this instance pointer as
	 argument <obj> to get the second entry, etc... Will return 0
	 on end of list
	 Will returns 0 or -1 on Errors.

findroom^%obj(name,room,num)
	 search the given <room> for an object with the alias
	 <name>. With <num> you may specify an object other than the first
	 one. Returns -1 if not found or on error.
	
	 Addition: <name> may also be a number, if that is the case, the code
	 will search for the object <vnum> instead of the name.

timget^%obj(obj,timer)
	 if <timer> is not given, this function will return the
	 object life timer (in minutes). If <timer> is set, this functions
	 will set the object life timer to the given value.
	 Returns -1 if error.
	
	 timer ticking when object is carried (= not on the ground)

timdrop^%obj(obj,timer)
	 if <timer> is not given, this function will return the
	 object life timer (in minutes). If <timer> is set, this functions
	 will set the object life timer to the given value.
	 Returns -1 if error.
	
	 ticking down when object is on the ground (reset when picked up)

findinv^%obj(name,ch,num)
	 searches the equipment and then the inventory of
	 character <ch> for object <name>. With <num> you may specify an
	 object other than the first one.
	
	 <name> may be either a keyword of that object or a vnum
	
	 Returns -1, if not found or on error.

cansee^%obj(ch,obj)
	 can character <ch> see obj <obj>, returns 1 if yes, else 0

load^%obj(vnum)
	 loads object with the vnum <vnum>. Returns the object instance
	 if successful and -1 on error

proto^%obj(vnum,f)
	 return prototype information for object <vnum>. If <vnum> is
	 <=0 then the real_number is used.
	
	 f = 1: name
	 f = 2: short description
	 f = 3: long description
	 f = 4: vnum,type,material,weight,volume,value
	 f = 5: val0,val1,val2,val3,val4,val5,val6
	       
	Light    (1) 0: ticks left, 1: refillable, 2: lit?
	Weapon   (5) 0,1,2: XdY+Z dam 3: subgroup, 4: balance, 5:length, 6: OB
	Armour   (9) Absorbs (0) up to (1) hits 
	Contain (15) 5: corpse? 6: <0 pid, >0 mobvnum  (5 => corpse states)
	             0: capacity, 1: locktype, 2: keynum
	Drinkcon(17) 0: capacity, 1: Poisoned, 2: LiquidType
	Note    (16) 0: tongue
	Food    (19) 0: units, 3: poisoned
	Money   (20) 0: coins
	Shield  (24) 0: block, 1: buckler?
	
	 returns -1 if error

corpse^%obj(obj)
	 returns -1 if the given object instance does not exist or 0,
	 if the object is not a corpse.
	
	 For all other values: if the returned number is negative, then
	 the corpse is a player corpse and then number is the relating player
	 number.
	
	 If the returned number is positive, the corpse was from a mobile
	 and the returned number is the mobile vnum.

ex^%obj(ch)
	 returns 1 if the object instance exists, else -1

var^%obj(obj,var,value,tim)
	 either sets or reads an obj specific variable
	 <obj>   is the instance number
	 <var>   is the name of the variable
	         or a position indicator which will return the variable
	         name and its value seperated by a ':'
	 <value> if set, that value will be assigned to the given variable
	         if unset, the current value of the given variable will be
	         returned. -2 if it does not exist.
	 <tim>   if set, the var with delete after <tim> pulses
	 returns -1 on error, 1 on success or see above

vdel^%obj(obj,var,mode)
	 deletes a given instance variable
	 
	 <mode> = 0 or undef: delete just <var>
	 <mode> = 1         : delete all vars starting with <var>
	
	 returns 1 or the number of delete vars if successful
	  -1 if error, -2 if not found, -3 if secure

vwipe^%obj(obj)
	 deletes all instances vars, returns 1 if ok and -1 if instance
	 did not exist

num^%obj(vnum)
	 returns the number of obj <vnum> which are loaded and -1 on error

exist^%obj(vnum)
	 returns 1 if an object with the given <vnum> exists, else -1

drink^%obj(obj,set)
	 if <set> is "" or unset, it will return the number of
	 drink units of the given object. If <set> is used, it will set
	 the number of drink units.  Returns -1 on error.

maxdrink^%obj(obj,set)
	 if <set> is "" or unset, it will return the maximum number
	 of drink units of the given object. If <set> is used, it will set
	 the number of drink units.  Returns -1 on error.

drinktype^%obj(obj)
	 returns the type of liquid in a drink-container.
	 
	 <n>,<str>  liquid type, liquid name
	 -1         if <obj> is not defined or it is not a drink-container
	 -2         if it is empty

listcont^%obj(cont,obj)
	 if <obj> is omitted, the first object in the container
	 <cont> is returned. If <obj> is given, the next object instance
	 in the container is returned.
	
	 returns 0, if no object follows or -1 on error

wgroup^%obj(o)
	 returns the weapon group, subgroup and the relating skill
	 or -1 on error
	
	 Example output:
	    "0,Blades,1,Daggers,85,short blades"
	     |   |    |    |    |   |
	     |   |    |    |    |   +- skill_text
	     |   |    |    |    +----- skill_idx
	     |   |    |    +---------- subgroup_text
	     |   |    +--------------- subgroup_idx
	     |   +-------------------- weapongroup_text
	     +------------------------ weapongroup_idx
	

value^%obj(o)
	 returns the value of the given object or -1 on error

assign^%prac(ch,skill,max)
	 assign skill index <skill> to pracmaster mob <ch>
	 with a <max> number of taught pracs

skill^%prac(name)
	 get the relating id to the skill <name>, -1 if skill does not ex

reset^%prac(ch,skill)
	 reset <skill> for player instance <ch>. If <skill> is not
	 given - all pracs of the player are reset.
	 returns -1 if instance does not exist and -2 if skill does not ex

pracs^%prac(ch)
	 returns the number of free practice sessions.
	 returns -1 if character instance was not found

know^%prac(ch,skill,mode)
	 get the knowledge of <ch> in the skill <skill>, where
	 <skill> is the unique skill_id. Returns -1 on error.
	 <mode> = 0 based on affected stats
	 <mode> = 1, based on real stats

name^%prac(skill)
	 returns the skill name to <skill> id, or -1 on error

find^%prac(room)
	 find a pracmaster in the given <room> and returns its character
	 instance, or 0 on error
	
	 note: if "%guildmaster_inactive" is set on the mob instance, the
	 guildmaster will not respond to mortals. (use enable^%prac() and
	 disable^%prac() to change this)

tryprac^%prac(ch,gm,skill)
	 tries to practice <skill> (string) on pracmaster mob
	 <gm> for char <ch>
	 returns the number of pracs in that skill, or
	 -1, if <ch> or <skill> does not exist
	 -2, if master does not know skill
	 -3, if you know more than the master
	 -4, no pracs left

disable^%prac(ch)
	 disables the guildmaster-abilities of <ch>. (All this routine
	 does, is set an instance variable to the mobile. When someone
	 wants to practice this variable is checked... Use enable^%prac()
	 to remove this flag again)

enable^%prac(ch)
	 enables the guildmaster-abilities of <ch>. (in other words, it
	 removes the inactivity-flag from this mobile - so it does not mean,
	 that by calling this function, the mobile will be a guildmaster!)

exits^%room(room)
	 return exits in the current <room> as a string of:
	 - if door exists <dir>:<vnum>/<door>/<status>  e.g. e:110/door/L
	 - if enter exit  g:<vnum>/<keyword>            e.g. g:199/cage
	 - if only exit   <dir>:<vnum>                  e.g. e:110
	  
	 <dir>    : n | e | s | w | u | d | g | l
	 <status> : O | C | L
	
	 note: 'g' means enter-exit, 'l' means leave-exit
	 
	 e.g.: e:110 s:120/wooden/O w:100 -3  (3 is the number of exits)
	       e:9 s:14 d:23 g:199/cage -4

ppl^%room(room)
	 returns <num_mortal>,<num_npc>,<num_immort> for the given room, or
	 -1 on error

route^%room(src,tar,mode)
	 returns direction number to next room on a route from
	 <src> to <tar>
	 <mode> = bit0: (01) track through doors
	          bit1: (02) use enter leave exits
	          bit2: (04) go into nomob rooms/exits
	          bit3: (08) even open closed hidden doors
	 returns values: 0,1,2,3,4,5 (n,e,s,w,u,d)
	                 -1 => error, -2 => already_there, -3 => no path

delexit^%room(room,dir)
	 removes to the direction <dir> in room <room>
	 returns 1 if success and -1 if fail.
	 (dir=0:north, 1:east, 2:south, 3:west, 4:up, 5:down, 6:enter)

setexit^%room(src,tar,dir)
	 connects room <src> with room <tar> in the dir <dir>
	 returns 1 if success and -1 if fail.
	
	 dir=0:north, 1:east, 2:south, 3:west, 4:up, 5:down, <string>:enter
	
	 if <dir> is a string longer than 3 chars, then an enter exit
	 will be created.

exdesc^%room(ro,dir,t)
	 sets exit desc <t> in room <ro> to the dir <dir>
	 if <t> = 1, the contents of the databuffer is used

exroom^%room(room,dir)
	 returns the room number to direction <dir> in room <room>
	 returns "", if not found
	 (dir=0:north, 1:east, 2:south, 3:west, 4:up, 5:down)

sector^%room(room,set)
	 returns the sector type number
	 if <set> is given the room sector will be set to <set>
	
	  0: city_sqaure       1: city_other           2: room_large
	  3: room_small        4: street_wide          5: street_narrow
	  6: street_crossing   7: field_farm           8: field_park
	  9: grass_high       10: grass_short         11: road_wide
	 12: road_small       13: road_crossing       14: trail_wide
	 15: trail_narrow     16: trail_goat          17: brush_light
	 18: brush_dense      19: swamp_light         20: swamp_thick
	 21: forest_clearing  22: forest_dense        23: forest_sparse
	 24: hills            25: hilltop             26: slope_light
	 27: slope_steep      28: mountain            29: mountain_plateau
	 30: mountain_summit  31: underwater          32: water_still
	 33: water_lake       34: water_shallow       35: river_slow
	 36: river_quick      37: river_rapid         38: water_noswim
	 39: flying           40: cavern_made         41: cavern_natural
	 42: skaven_tunnel    43: tunnel_crossing     44: forest_trail	
	 45: mountain_trail   46: barren_fields       47: tunnels_non_skaven
	 48: forested_slope

moveloss^%room(room)
	 returns the movement-loss number for this room

campdo^%room(room)
	 returns the time in seconds, until to do a campfire

campdie^%room(room)
	 returns the time in seconds, until the campfire decays

terrain^%room(room)
	 returns the terrain number for this room
	  0: inside		 1: water		 2: underwater
	  3: hill		 4: mountain		 5: road
	  6: plain		 7: swamp		 8: forest
	  9: city		10: brush		11: river
	 12: lake		13: air			14: cavern
	 15: wilderness

send^%room(room,txt,mode,delay)
	 send echo <txt> to room <room>. Only visible for chars
	 with a position of > SLEEPING. If the function is used the original
	 way, the <mode> argument does not need to be supplied.
	
	 Following arguments may be omitted:
	 <mode> = 1: only send to chars who can see
	        = 2: only send to chars who cannot see
	        = 0: the original way - send to all chars in room
	
	 Wait <delay> pulses until the echo is shown.

damage^%room(room,dam)
	 will damage all players and mobiles in room <room> with
	 a <dam> hps loss. Returns 1 on success and -1 on error.

move^%room(src,tar,mode,act)
	 move all contents (mobs + objs) from room <src> to
	 room <tar>. If <mode> = 1, then the moved character will 'look'
	 at the room and the players in the target room will see the given
	 <act> message (us $n to display the relating charname).
	 If <mode> = 0, it will be all quietly.
	 The function returns 1 if successful, else -1

var^%room(room,var,value,tim)
	 either sets or reads a room specific variable
	 <room>  is the room vnumber
	 <var>   is the name of the variable
	         or a position indicator which will return the variable
	         name and its value seperated by a '§'
	 <value> if set, that value will be assigned to the given variable
	         if unset, the current value of the given variable will be
	         returned. -2 if it does not exist.
	 <tim>   if set, the var will delete after <tim> pulses
	 returns -1 on error, 1 on success or see above

vdel^%room(room,var,mode)
	 deletes a given instance variable
	
	 <mode> = 0 or undef: delete just the given variable
	 <mode> = 1: delete all variables starting with <var>
	
	 returns 1 or the number of deleted variables if successful
	  -1 if error, -2 if not found, -3 if secure

vwipe^%room(room)
	 deletes all instances vars, returns 1 if ok and -1 if instance
	 did not exist

visit^%room(room)
	 returns the pulse number, when last a character was in this room
	 returns -1, on error
	 NOTE: that counter is only set, if mortals are in the room

finddoor^%room(room,door,dir)
	 find <door> in <room> in the direction <dir>.
	 If you do not submit the <dir> string, it will search for the first
	 occurance. (<dir> may be a direction string or the relating number)
	 (you may use 'exit' as doorname)
	
	 returns either <0 on error or the number of the direction where the
	 door was found. (N: 0, E:1, S:2, W:3, U:4, D:5)
	
	 e.g.: $$finddoor^%room(100,"gates","d")

flags^%room(room)
	 returns room flags for <room>, else -1
	   0 dark        1 lit          2 nomob       3 indoors
	   4 peaceful    5 soundproof   6 notrack     7 nomagic
	   8 daytime     9 private     10 godroom    11
	  12 noride     13 nonarrate

dark^%room(room)
	 1 is returned, if room is completely dark
	 0 is returned, if it lit by sunlight or artifically
	 -1 is returned, if room does not exist

sunlit^%room(room)
	 1 is returned, if the room is lit by sunlight
	 0 is returned, otherwise (not nescessarily dark!)
	 -1 is returned, if room does not exist
	 source in it.

obj^%room(room,vnum)
	 returns the first instance to the object <vnum> in the room
	 <room> -- if that does not exist it returns -1

npc^%room(room,num)
	 returns the <num>'th npc (mobile) in <room> or -1

pc^%room(room,num)
	 returns the <num>'th pc (immorts + mortals) in <room> or -1

immort^%room(room,num)
	 returns the <num>'th immortal in <room> or -1

mortal^%room(room,num)
	 returns the <num>'th mortal in <room> or -1

start^%room(ch)
	 returns the start/death room for <ch> and -1 on error

name^%room(room)
	 returns the room name of <room> or -1 if it does not exists

exitflag^%room(room,dir,set)
	 if <set> is omitted, return the exit/door flags for
	 <dir> in <room>. If <set> is given, set the relating value as exit
	 flag
	
	    <dir> (N: 0, E:1, S:2, W:3, U:4, D:5)
	
	    bit 0: isdoor                bit 5: nomob
	    bit 1: closed                bit 6: climb_up
	    bit 2: locked                bit 7: lockable
	    bit 3: pickproof             bit 8: climb_down
	    bit 4: hidden
	

region^%room(room)
	 returns region information to given room or -1 if none are set.
	 return string: <reg_idx>,<reg_name>,<reg_side>,<delay>,<distance>
	   example: 6,Goblin Caves,Greenskin,20,8
	                                     |  |
	   pulses until cdef is triggered ---+  +------------+
	   again by that PC                                  |
	                                                     |
	   all rooms in that distance from the trigger room -+
	   will get the cdef event ('range' event)

dontmove^%room(room,set,ti,label)
	 Set the 'dont_move' flag to all chars in <room>
	 (see: dontmove^%char)

add^%sched(ch,pulse,cancancl,prompt,done,cancel,cleanup,data1,data2,desc,ondam)
	 Add to MUD scheduler
	 <ch>       if 0, it will be independant and not tied or visible
	                  to the player
	            if set, with the arguments you can either show the /|\-
	                  to the player or it be canceled on keypress- this
	                  may only be used for players - not for mobiles!!
	 <pulse>    number of pulses till action should trigger (function
	            <done> will be called)
	 <cancancl> if 1, the keypress cancels,
	            if that is not wanted, set it to 0
	 <prompt>   if 1, the player will see \|/- while waiting
	            if that is not wanted, set it to 0
	 <done>     a mumps routine which shall be called when the waiting
	            is done
	 <cancel>   a mumps routine which is called when it was cancelled
	 <cleanup>  a mumps routine which is called for cleanup
	 <data1>    any string, you want to make visible to the three
	            routines above. That string will then be represented
	            in the variable 'ptr1'
	 <data2>    (see above, but 'ptr2')
	 <desc>     short description
	 <ondam>    a mumps routine, called when the delayed char is damaged
	            during fight (if you want to cancel the task, you have
	            to do that yourself)
	
	 Returns the relating schedule_entry pointer (used for cancel) or
	 -1, if something went wrong.
	
	 Example:   w $$add^%sched(0,10,0,0,"done^mob10",0,0,me,0)

simple^%sched(pulse,done,data,desc)
	 simple/quick way to add to the MUD scheduler
	 <pulse>    number of pulses till action should trigger (function
	            <done> will be called)
	 <done>     a mumps routine which shall be called when the waiting
	            is done
	
	 Following arguments may be omitted:
	 <data>     any string, you want to make visible to the three
	            routines above. That string will then be represented
	            in the variable 'ptr1'
	 <desc>     short description
	
	 Returns the relating schedule_entry pointer (used for cancel) or
	 -1, if something went wrong.
	
	 Example:   w $$simple^%sched(10,"done^mob10",who)

cancel^%sched(cookie)
	 Cancels a scheduled task. Returns 1, if that was successful
	 otherwise it returns -1 (if entry not found)
	 If cancelled with this function, the cancel function which was
	 originally set when adding the scheduled task, won't be called.
	 Though the cleanup function will be called.
	 Note: if a player is moved out of a room, a player-depending
	 task (if ch != 0 in add^%sched), is canceled without calling the
	 cancel code.

cookie^%sched(ch)
	 returns the cookie of the active schedule task/delay for <ch>
	 or -1 if none or error.

init^%ship(ctrl,rooms,echorooms)
	 initializes the ship control room
	 <ctrl>       room number of the control room
	 <rooms>      list of rooms, which belong to the ship (delim is ,)
	 <echorooms>  list of rooms, which receive echos (delim is ,)
	              (if not given - <room> will be used here)

start^%ship(ctrl,pos,dir)
	 start the ship, where <ctrl> is the ship control-room
	 if <pos> is not given it uses '0'
	 if <dir> is not given it uses '1'
	
	 Instant-Variables to the <ctrl> room
	    ship-cookie:    cookie to the scheduled-event
	    ship-delay:     delay until next echo (pulses)
	    ship-direction: 1 or -1
	    ship-pos:       position in the 'trip'-echo-list
	    ship-state:     "stopped" | "moving"
	    ship-rooms:     list of rooms which belong to the ship
	    ship-echorooms: list of rooms which receive the echos

stop^%ship(ctrl)
	 stop the ship

start^%story(ch,rtn,label,delay)
	 start a story with <ch> as storyteller
	 <rtn>   script name of the corresponding mobile scripts
	         e.g.: mob600 (usually $zn is a good choice)
	 <label> label pointing to the story: e.g. story
	 <delay> delay in seconds between each output
	
	 The story usually is located in the mobile script of the storyteller
	 It is a list of comments and starts at the given <label>. The first
	 character after the semicolon is the mode indicator:
	
	 F<cmd>      force a mud command    (e.g: Fsay hello)
	 S<num>      set the state          (e.g: S2)
	 X<code>     script xecute          (e.g: Xn dummy s dummy=1)
	 $<label>    end of story           (e.g. $done^mob500)
	
	 The <label> after $ is optional. You may use it if you want to
	 call a script when the story is over. The call of the label then is
	 scheduled for the next pulse. <ptr1> will be the instance of the
	 storyteller.
	
	 You may append a "|<number>" to each story line. That will
	 override the default delay. Instead the next story line will be
	 delayed <number> seconds
	
	 Example:
	
	 [..]
	 story   ;Fsay Hello
	         ;Fsmile
	         ;$done^mob103

stop^%story(ch)
	 stop a story, where <ch> is the storyteller
	",2)

state^%system(ch)
	 toggle between state CON_PLAYING and CON_SCRIPT (DON'T USE!!!!)
	 only works if a label 'system' exists in the relating routine,
	 which will be called after a command is entered.
	 The output port will automatically be set to the relating character
	 instance (the command 'exit' _always_ gets back!)
	 <who>    instance pointer of actor
	 <cmd>    command which was entered
	 <state>  state variable
	 <prompt> prompt to be used
	 the <state> and <prompt> variables will be imported back to the
	 C code - increase <state> from the script..
	 (DON'T USE - ask Axel!)

build^%system()
	 returns the warp-kernel-build version

empty^%zone(z)
	 returns 1 if zone is empty, 0 if it is not empty and -1 if
	 any error occured. Note that Immortals do not count in.

chars^%zone(z)
	 returns <num_pcs>,<num_npcs> or -1 on error.

send^%zone(zone,mode,txt)
	 send <txt> to zone <zone>. Only sent to characters with
	 a position index of > SLEEPING. If <mode> == 1, then text is only
	 sent to outdoor rooms, if <mode> == 0 then its sent to all rooms.

echo^%zone(room,steps,flags,col,ch,pre,post)
	 echo a text to each room within a
	 distance of <steps> rooms into every direction, starting from <room>
	
	 The <text> is send as act TOCHAR. So you may use $n, which will be
	 the relating char who might see the echo.
	 
	 If <ch> is set, the echo was initiated by a character (e.g. yell)
	 in this case you may use $N too.
	
	 <flags> may be the sum of following options:
	  1 - closed doors stop the current 'branch'
	  2 - underwater stops the current 'branch'
	  4 - will not echo to 'inside/indoor' rooms
	  8 - will not echo to outdoor rooms
	 16 - will not echo to soundproof rooms
	
	 <col> might be deactivated by setting it to "" or -1. It may be the
	 relating internal color index, which sets colors accordingly as
	 saved in 'change colour ...' to each char.
	
	 <pre> and <post> make up the text which is to be echoed. If <ch>
	 is not set only <pre> needs to be used. If <ch> is set, <pre> and
	 <post> are the string to be echoed before and after the name which
	 is represented by <ch>.
	
	 Example:
	    pre="From far away",post="yells 'hello'"
	    => "From far away *an Orc* yells 'hello'"
	 

evrange^%zone(room,dist,flags,ident)
	 trigger event-range to a group of rooms,
	 distributed by the same means as decribed in $$echo^%zone.
	 <room> is the starting room, while <dist> is the distance to be
	 covered. See $$echo^%zone for the relating <flags>
	 <ident> should be an unique identifier. It gets imported as
	 argument, when the range event triggers, so the scripts can decide
	 if the event was meant for them or not.
	
	 Note: the relating range room-events do not trigger instantly. One
	 event triggers each pulse. So if lets say 20 rooms are supposed to
	 see the range event, it will take approximately 1s until all the
	 triggering is done.
	
	 Note: do not use this function a lot, since it eats a lot of
	 processing time.

region^%zone(reg,delay,range)
	 changes <delay> and <range> values for the
	 given region-index <reg>. Returns -1 on error and 1 on success

note^%zone(pid,txt,mode)
	 add <txt> to the notes of player with <pid>. *secure*
	 <mode> 0: without any prefix
	        1: prefix date
	        2: prefix spaces as long as a date-string
	        3: prefix CRLF and then date
	i $$immort^%char(who)<1 d  q

lb^util(s,l)
	 output string <s> with a maximum length of <l> aligned to the left
	 - if <s> is shorter than <l> the rest is filled up with spaces
	 - if <s> is longer than <l>, <s> will be cut to the length of <l>

nam^util(t)
	 convert <t> to a name (captial first char, rest lowcase)

abbrev^util(cmd,full,len)
	 Returns 1, if <cmd> an abbreviation of <full>, else 0
	 <len> defines the minimum number of nescessary matching chars

tw^util(s)
	 trim string <s> cut away leading and trailing spaces

spaces^util(s)
	 delete spaces of string <s>, so that only one space is left
	 between the words

gostr^util(d,art)
	 return an arrive/leave string, where <d> is the direction.
	 <art>=0: leave,  <art>=1: arrive
	 <d>=0: north, 1: east, 2: south, 3: west, 4: up, 5: down

isset^util(v,b)
	 returns 1, if bit <b> is set in value <v>

setbit^util(v,b)
	 sets bit <b> in value <v> and returns the new value

clrbit^util(v,b)
	 clears bit <b> in value <v> and returns the new value

togbit^util(v,b)
	 toggles bit <b> in value <v> and returns the new value

numtext^util(num)
	 returns the corresponding text string to a given number
	 e.g. 99 => ninety-nine

weight^util(num)
	 returns the corresponding weight string to a given number
	 (number in 10 gramms) e.g. 100 => two pounds

height^util(num)
	 returns the corresponding height string to a given number
	 (number in centimeters) e.g. 160 => five feet three

ischar^util(p)
	 returns 1, if the given instance pointer is either a player or mob
	 else 0

instroom^util(p)
	 returns the room number of the instance, or -1

var^util(p,var,val)
	 behaves same way as $$var^%room, $$var^%mob and $$var^%obj
	 do, but detects which one to use. for return values check those
	 functions

vdel^util(p,var)
	 behaves the same way as $$vdel^%room (.. mob or obj), but
	 it detects which one to use. for return values check the respective
	 functions

dir^util(n)
	 if <n> is a number, the relating direction string is returned
	 if <n> is a string, the relating direction number is returned
	 emptry string if error

revdir^util(n)
	 output the 'reversed' direction number
	 emptry string if error

lower^util(s)
	 string to lowcase

upper^util(s)
	 string to lowcase

rnd^util(d)
	 randomized delay -> return value may vary between +/- 25% of <d>

cap^util(txt)
	 capitalizes the first character of <txt> and returns the new string

tstr^util(s,mode)
	 returns a time text relating to the <s> seconds
	 <mode> = 0: extended format  (e.g. 1 day 2 hours 4 seconds)
	 <mode> = 1: short format (e.g. 1d 2h 4s)
	 <mode> = 2: short format (e.g. 1day) <= output only highest value

lock^util(id,pulse)
	 lock-handling for the Identifier <id>. Make sure your <id>
	 is UNIQUE! (for instance use $zn)
	 <pulse> controls in how many pulses a lock will be removed.
	 If <pulse> is omitted, the default value of 0 (asap) will be used.
	
	 returns 0: if unlocked (will then set the lock)
	 returns 1: if locked
	
	 This function could be used to prevent multiple triggering of the
	 same script in the same pulse. e.g.: get all chest
	
	 All semaphores are saved as instance variable into room 1.

count^util(str,word)
	 returns the number of occurances of <word> in <str>

ispart^util(str,word)
	 case-insensitive search, if the complete word <word> is
	 part of the space delimitered string <str>
	 Before the search is started, all whitespace is reduced to the
	 length of 1. Whitespace at the start or the end of the sentence
	 gets removed.  (e.g. " my   name  " => "my name")
	
	 returns 0, if the phrase was not found, else it returns the word-
	 number, which <word> is represented as.
	
	 Examples:   1  2    3  4
	             |  |    |  |
	   $$ispart("My Name Is Axel","axel") => 4
	   $$ispart("My Name Is Axel","Axe")  => 0
	     (since "Axe" is not a complete word in that str)
	 

racestr^util(race)
	 returns the singular and plurar race-strings to given
	 race index