PennMUSH Community

Changeset 1289

Show
Ignore:
Timestamp:
09/24/08 01:15:45 (2 months ago)
Author:
shawnw
Message:

Cleaned up pennfunc.hlp a bit more.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • 1.8.3/trunk/game/txt/hlp/pennfunc.hlp

    r1288 r1289  
    343343  after(<string1>, <string2>) 
    344344 
    345   Returns the portion of <string1> that occurs after <string2>. 
    346   If <string2> isn't in <string1>, the function returns a null string. 
     345  Returns the portion of <string1> that occurs after <string2>.  If 
     346  <string2> isn't in <string1>, the function returns a null string. 
    347347  This is case-sensitive. 
    348348  
    …… 
    361361  for easy creation of book pages, newsletters, or the like. 
    362362 
    363   <widths> is a space-separated list of column widths. '10 10 10' for the 
    364   widths argument specifies that there are 3 columns, each 10 spaces wide. 
    365   < before a number causes the field to be left-aligned (the default). A 
    366   '-' causes it to be centered, and '>' makes it right-aligned. 
    367   A '.' after the number implies the column is to be repeated for as long 
    368   as there is text remaining in a non-repeating column. A ` (left tick) 
    369   after the number implies that if the column runs out of text, it should 
    370   merge with the next leftmost column (making that column flow around). 
    371   A ' (right tick) after the number implies that if the column runs out 
    372   of text, it should merge with the next rightmost column. 
     363  <widths> is a space-separated list of column widths. '10 10 10' for 
     364  the widths argument specifies that there are 3 columns, each 10 
     365  spaces wide.  < before a number causes the field to be left-aligned 
     366  (the default). A '-' causes it to be centered, and '>' makes it 
     367  right-aligned.  A '.' after the number implies the column is to be 
     368  repeated for as long as there is text remaining in a non-repeating 
     369  column. A ` (left tick) after the number implies that if the column 
     370  runs out of text, it should merge with the next leftmost column 
     371  (making that column flow around).  A ' (right tick) after the number 
     372  implies that if the column runs out of text, it should merge with 
     373  the next rightmost column. 
    373374 
    374375  <filler> is a single character that, if given, is the character used 
    375376  to fill empty columns and remaining spaces. <colsep>, if given, is 
    376377  inserted between every column, on every row. <rowsep>, if given, is 
    377   inserted between every line. By default, <filler> and <colsep> are 
    378   a space, and <rowsep> is a newline. 
     378  inserted between every line. By default, <filler> and <colsep> are a 
     379  space, and <rowsep> is a newline. 
    379380 
    380381  Continued in HELP ALIGN2 
    …… 
    403404  allof(<expr1>[, ... , <exprN>],<osep>) 
    404405 
    405   Evaluates every expression argument (including side-effects) and returns 
    406   the results of those which are true, in a list separated by osep.  The 
    407   output separator argument is required and must be a single character, 
    408   or can be left empty, in which case a space will be used to separate the 
    409   results by default. 
     406  Evaluates every expression argument (including side-effects) and 
     407  returns the results of those which are true, in a list separated by 
     408  osep.  The output separator argument is required and must be a 
     409  single character, or can be left empty, in which case a space will 
     410  be used to separate the results by default. 
    410411 
    411412  The meaning of true or false depends on configuration options as 
    …… 
    424425 
    425426  Takes any number of arguments, and returns the word which is 
    426   lexicographically biggest. I.e., which word would be last in  
     427  lexicographically biggest. I.e., which word would be last in 
    427428  alphabetical order. 
    428429 
    …… 
    439440  cand(<boolean value 1>, <boolean value 2>[, ... , <boolean value N>]) 
    440441  
    441   Takes boolean values, and returns 1 if all of them are equivalent 
    442   to true(1).  and() always evaluates all arguments (including side 
     442  Takes boolean values, and returns 1 if all of them are equivalent to 
     443  true(1).  and() always evaluates all arguments (including side 
    443444  effects), while cand() stops evaluation after the first argument 
    444445  that evaluates to false. 
    …… 
    454455 
    455456  Thus, ANDFLAGS(me,WD) would return 1 if I was set WIZARD and DARK. 
    456   ANDFLAGS(me,W!Dc) would return 1 if I was set WIZARD, not DARK, 
    457   and CONNECTED. 
    458  
    459   If a letter does not correspond to any flag, <object> doesn't have it, 
    460   so the function returns 0. There can be an arbitrary number of flags. Do 
    461   not put spaces between flag letters. 
     457  ANDFLAGS(me,W!Dc) would return 1 if I was set WIZARD, not DARK, and 
     458  CONNECTED. 
     459 
     460  If a letter does not correspond to any flag, <object> doesn't have 
     461  it, so the function returns 0. There can be an arbitrary number of 
     462  flags. Do not put spaces between flag letters. 
    462463& ANDLFLAGS() 
    463464  andlflags(<object>, <list of flags>) 
    …… 
    472473 
    473474  If a name does not correspond to any flag, <object> doesn't have it, 
    474   so the function returns 0. There can be an arbitrary number of flags. 
     475  so the function returns 0. There can be an arbitrary number of 
     476  flags. 
    475477& ANDLPOWERS() 
    476478  andlpowers(<object>, <list of powers>) 
    …… 
    518520  aposs(<object>) 
    519521 
    520   Returns the absolute possessive pronoun - his/hers/its/theirs - 
    521   for an object. The %a substitution returns the absolute possessive 
     522  Returns the absolute possessive pronoun - his/hers/its/theirs - for 
     523  an object. The %a substitution returns the absolute possessive 
    522524  pronoun of the enactor. 
    523525& ART() 
    524526  art(<string>) 
    525527 
    526   This function returns the proper article, "a" or "an", based on whether 
    527   or not <string> begins with a vowel. 
     528  This function returns the proper article, "a" or "an", based on 
     529  whether or not <string> begins with a vowel. 
    528530& ASIN() 
    529531  asin(<sine>[,<angle type>]) 
    …… 
    576578  band(<integer1>, <integer2>[, ... , <integerN>]) 
    577579 
    578   Does a bitwise AND of all its arguments, returning the result 
    579   (A number with only the bits set in every argument set in it). 
     580  Does a bitwise AND of all its arguments, returning the result (A 
     581  number with only the bits set in every argument set in it). 
    580582& BASECONV() 
    581583  baseconv(<number>, <from base>, <to base>) 
    …… 
    592594  beep([<number>]) 
    593595  
    594   Sends <number> "alert" bell characters. <number> must be in the range 
    595   1 to 5, or, if unspecified, defaults to 1. 
    596   This function may only be used by royalty and wizards.  
     596  Sends <number> "alert" bell characters. <number> must be in the 
     597  range 1 to 5, or, if unspecified, defaults to 1.  This function may 
     598  only be used by royalty and wizards. 
    597599  
    598600& BEFORE() 
    599601  before(<string1>, <string2>) 
    600602  
    601   Returns the portion of <string1> that occurs before <string2>. 
    602   If <string2> isn't in <string1>, <string1> is returned. 
    603   This is case-sensitive. 
     603  Returns the portion of <string1> that occurs before <string2>.  If 
     604  <string2> isn't in <string1>, <string1> is returned.  This is 
     605  case-sensitive. 
    604606  
    605607  Examples: 
    …… 
    613615  brackets([<string>]) 
    614616 
    615   Returns a count of the number of left and right square brackets,  
     617  Returns a count of the number of left and right square brackets, 
    616618  parentheses, and curly braces in the string, in that order, as a 
    617   space-separated list of numbers. This is useful for finding missing  
    618   or extra brackets in MUSH code.  
     619  space-separated list of numbers. This is useful for finding missing 
     620  or extra brackets in MUSH code. 
    619621 
    620622  Example: 
    …… 
    640642  bound(<number>, <lower bound>, <higher bound>) 
    641643 
    642   bound() returns <number> if it is between <lower bound> and 
    643   <higher bound>. If it's lower than the lower bound, the lower 
    644   bound is returned. If it's higher than the higher bound, 
    645   the higher bound is returned. 
     644  bound() returns <number> if it is between <lower bound> and <higher 
     645  bound>. If it's lower than the lower bound, the lower bound is 
     646  returned. If it's higher than the higher bound, the higher bound is 
     647  returned. 
    646648   
    647649See also: ceil(), floor(), round(), trunc() 
    …… 
    655657   
    656658  Returns <string> with the first character capitalized. 
     659 
    657660  Example: capstr(foo bar baz) returns "Foo bar baz" 
    658661 
    …… 
    661664  cat(<string1>[, ... , <stringN>]) 
    662665 
    663   cat() concatenates strings, separating each string by a space. 
    664   So "[cat(one, two)]" will return 'one two'. 
     666  cat() concatenates strings, separating each string by a space.  So 
     667  "[cat(one, two)]" will return 'one two'. 
    665668 
    666669See also: strcat() 
    …… 
    674677  center(<string>, <width>[, <fill>[, <rightfill>]]) 
    675678  
    676   This function will center <string> within a field <width> characters wide, 
    677   using the <fill> string for padding on the left side of the string, 
    678   and <rightfill> for padding on the right side. <rightfill> defaults 
    679   to the mirror-image of <fill> if not specified. <fill> defaults to 
    680   a space if neither <fill> nor <rightfill> are specified.  
    681  
    682   If <string> divides <width> into uneven portions, the left side 
    683   will be one character shorter than the right side. 
     679  This function will center <string> within a field <width> characters 
     680  wide, using the <fill> string for padding on the left side of the 
     681  string, and <rightfill> for padding on the right side. <rightfill> 
     682  defaults to the mirror-image of <fill> if not specified. <fill> 
     683  defaults to a space if neither <fill> nor <rightfill> are specified. 
     684 
     685  If <string> divides <width> into uneven portions, the left side will 
     686  be one character shorter than the right side. 
    684687  
    685688  Examples: 
    …… 
    697700  checkpass(<player>, <string>) 
    698701 
    699   Returns 1 if <string> matches the player's password otherwise 0. 
    700   If <player> has no password, this function will always return 1. 
     702  Returns 1 if <string> matches the player's password otherwise 0.  If 
     703  <player> has no password, this function will always return 1. 
    701704  <player> should be specified as a dbref or *<name>. 
    702705 
    …… 
    708711  ord(<character>) 
    709712 
    710   ord() returns the numerical value of the given character. 
    711   chr() returns the character with the given numerical value. 
     713  ord() returns the numerical value of the given character.  chr() 
     714  returns the character with the given numerical value. 
    712715 
    713716  Examples: 
    …… 
    719722  clone(<object>) 
    720723  
    721   This function clones <object>, and returns the dbref number of the clone. 
     724  This function clones <object>, and returns the dbref number of the 
     725  clone. 
    722726 
    723727  This is a side-effect function and may not be enabled on some MUSHes. 
    …… 
    726730 
    727731  Returns the number of commands issued by a player during this 
    728   connection as indicated by WHO.  
     732  connection as indicated by WHO. 
    729733 
    730734  The caller can use the function on himself, but using on any other 
    …… 
    736740 
    737741  Returns the number of characters sent by a player during this 
    738   connection as indicated by SESSION.  
     742  connection as indicated by SESSION. 
    739743 
    740744  The caller can use the function on himself, but using on any other 
    …… 
    746750 
    747751  Returns the number of characters received by a player during this 
    748   connection as indicated by SESSION.  
     752  connection as indicated by SESSION. 
    749753 
    750754  The caller can use the function on himself, but using on any other 
    …… 
    756760 
    757761  Comp compares two values.  It returns 0 if they are the same, -1 if 
    758   value1 is less than/precedes alphabetically value2, and 1  
    759   otherwise. 
     762  value1 is less than/precedes alphabetically value2, and 1 otherwise. 
    760763 
    761764  By default the comparison is a case-sensitive lexicographic (string) 
    762   comparison. By giving the optional <type>, the comparison can 
    763   be specified: 
     765  comparison. By giving the optional <type>, the comparison can be 
     766  specified: 
     767 
    764768      <type>            Comparison 
    765769        A               Maybe case-sensitive lexicographic (default) 
    …… 
    769773        F               Floating point numbers 
    770774 
    771   Whether or not the a sort type is case-sensitive or not depends 
    772   on the particular mush and its environment. 
     775  Whether or not the a sort type is case-sensitive or not depends on 
     776  the particular mush and its environment. 
    773777& CON() 
    774778  con(<object>) 
    …… 
    792796  ncondall(<cond1>, <expr1>, [<condN>, <exprN>], ...[<default>]) 
    793797 
    794   cond() evaluates <cond>s until one returns a boolean true value. Should 
    795   none return true, <default> is returned. 
    796  
    797   condall() returns all <expr>s for those <cond>s that evaluate to true. 
    798  
    799   ncond() and ncondall() are identical to cond(), except it returns <expr>s 
    800   for which <cond>s evaluate to false. 
     798  cond() evaluates <cond>s until one returns a boolean true 
     799  value. Should none return true, <default> is returned. 
     800 
     801  condall() returns all <expr>s for those <cond>s that evaluate to 
     802  true. 
     803 
     804  ncond() and ncondall() are identical to cond(), except it returns 
     805  <expr>s for which <cond>s evaluate to false. 
    801806 
    802807  Examples: 
    …… 
    813818  config(<option>) 
    814819 
    815   With no arguments, this function returns a list of config option names. 
    816   Given a config option name, this function returns its value. 
     820  With no arguments, this function returns a list of config option 
     821  names.  Given a config option name, this function returns its value. 
    817822  Boolean configuration options will return values of "Yes" or "No". 
    818823 
    …… 
    822827  conn(<player|descriptor>) 
    823828  
    824   This function returns the number of seconds a player has been connected. 
    825   <player name> must be the full name of a player, or a player's dbref. 
    826   Players who are not connected have a conn value of "-1", as do dark 
    827   wizards, when conn() is used on them by a non-priv'ed player. 
     829  This function returns the number of seconds a player has been 
     830  connected.  <player name> must be the full name of a player, or a 
     831  player's dbref.  Players who are not connected have a conn value of 
     832  "-1", as do dark wizards, when conn() is used on them by a 
     833  non-priv'ed player. 
    828834  
    829835See also: CONNECTED 
    …… 
    832838   
    833839  With no <attribute>, this function returns 1 if <object> controls 
    834   <victim>, or 0, if it does not. With an <attribute>, it will return 1 
    835   if <object> could successfully set <attribute> on <victim> (or alter 
    836   <attribute>, if it already exists). If one of the objects does not exist, 
    837   it will return #-1 ARGN NOT FOUND (where N is the argument which is the 
    838   invalid object). If <attribute> is not a valid attribute name, it will 
    839   return #-1 BAD ATTR NAME. You must control <object> or <victim>, or have 
    840   the See_All power, to use this function. 
     840  <victim>, or 0, if it does not. With an <attribute>, it will return 
     841  1 if <object> could successfully set <attribute> on <victim> (or 
     842  alter <attribute>, if it already exists). If one of the objects does 
     843  not exist, it will return #-1 ARGN NOT FOUND (where N is the 
     844  argument which is the invalid object). If <attribute> is not a valid 
     845  attribute name, it will return #-1 BAD ATTR NAME. You must control 
     846  <object> or <victim>, or have the See_All power, to use this 
     847  function. 
    841848 
    842849See also: CONTROL 
    …… 
    849856  This function converts seconds to a time string, based on how many 
    850857  seconds the number is after Jan 1, 1970 UTC. Because it's based on 
    851   UTC, but returns local time, convsecs(0) is not going to be 
    852   "Thu Jan 1 00:00:00 1970" unless you're in the UTC (GMT) timezone. 
     858  UTC, but returns local time, convsecs(0) is not going to be "Thu Jan 
     859  1 00:00:00 1970" unless you're in the UTC (GMT) timezone. 
    853860  
    854861  convutcsecs() and convsecs() with a second argument of 'utc' return 
    …… 
    867874  convtime(<time string>) 
    868875 
    869   This functions converts a time string (in the local time zone) to the 
    870   number of seconds since Jan 1, 1970 GMT. A time string is of the 
     876  This functions converts a time string (in the local time zone) to 
     877  the number of seconds since Jan 1, 1970 GMT. A time string is of the 
    871878  format: Ddd MMM DD HH:MM:SS YYYY where Ddd is the day of the week, 
    872879  MMM is the month, DD is the day of the month, HH is the hour in 
    …… 
    876883 
    877884  If the extended convtime() is supported (See @config compile), more 
    878   formats for the date are enabled, including ones missing the day 
    879   of week and year, and a 'Month Day Year' format. 
     885  formats for the date are enabled, including ones missing the day of 
     886  week and year, and a 'Month Day Year' format. 
    880887 
    881888  Example: 
    …… 
    890897  
    891898  Returns the cosine of <angle>. Angle must be in the given angle 
    892   type, or radians by default.  
     899  type, or radians by default. 
    893900 
    894901  Examples: 
    …… 
    908915  create(<object>, <cost>) 
    909916  
    910   This function creates an object with name <object> for <cost> pennies, 
    911   and returns the dbref number of the created object. 
    912  
    913   This is a side-effect function and may not be enabled on some MUSHes. 
     917  This function creates an object with name <object> for <cost> 
     918  pennies, and returns the dbref number of the created object. 
     919 
     920  This is a side-effect function and may not be enabled on some 
     921  MUSHes. 
    914922& CTIME() 
    915923& CSECS() 
    …… 
    917925  csecs(<objecct>) 
    918926  
    919   If creation times are enabled, this function will return the  
    920   date and time that the object was created. If the optional <utc> 
    921   argument is true, the time is returned for the UTC time zone, if 
    922   false or present, for the local time zone. 
     927  If creation times are enabled, this function will return the date 
     928  and time that the object was created. If the optional <utc> argument 
     929  is true, the time is returned for the UTC time zone, if false or 
     930  present, for the local time zone. 
    923931  
    924932  csecs() returns the time as the number of seconds since the epoch. 
    …… 
    930938  ctu(<angle>,<from>,<to>) 
    931939 
    932   Converts between the different ways to measure angles. 
    933   <from> controls what the angle is treated as, and <to> what form 
    934   it is turned into. They can be 'd' for degrees, or 'r' for radians. 
    935   There is also a third way to measure angle, 'g' for gradians, but it's not 
     940  Converts between the different ways to measure angles.  <from> 
     941  controls what the angle is treated as, and <to> what form it is 
     942  turned into. They can be 'd' for degrees, or 'r' for radians.  There 
     943  is also a third way to measure angle, 'g' for gradians, but it's not 
    936944  used often and is only included for completeness. 
    937945 
    …… 
    945953  dec(<string-ending-in-integer>) 
    946954 
    947   Dec returns the integer minus 1. If given a string that ends in an integer, 
    948   it decrements only the final integer portion. That is: 
     955  Dec returns the integer minus 1. If given a string that ends in an 
     956  integer, it decrements only the final integer portion. That is: 
    949957 
    950958  > think dec(3) 
    …… 
    964972  decompose(<string>) 
    965973 
    966   decompose() works like escape() with the additional caveat that it inserts 
    967   parse-able characters to recreate <string> exactly after one parsing. It 
    968   takes care of multiple spaces, '%r's, and '%t's. 
     974  decompose() works like escape() with the additional caveat that it 
     975  inserts parse-able characters to recreate <string> exactly after one 
     976  parsing. It takes care of multiple spaces, '%r's, and '%t's. 
    969977 
    970978See also: @decompile2, escape(), secure() 
    …… 
    9941002  is readable by you.  Otherwise, it evaluates the default case, and 
    9951003  returns that.  Note that the default case is only evaluated if the 
    996   attribute does not exist or cannot be read. Note further than an empty 
    997   attribute counts as an existing attribute. 
    998  
    999   This is useful for code that needs to return the value of an attribute, 
    1000   or an error message or default case, if that attribute does not exist. 
     1004  attribute does not exist or cannot be read. Note further than an 
     1005  empty attribute counts as an existing attribute. 
     1006 
     1007  This is useful for code that needs to return the value of an 
     1008  attribute, or an error message or default case, if that attribute 
     1009  does not exist. 
    10011010  
    10021011  Examples: 
    …… 
    10141023  
    10151024  Return a modified <string>, with <len> characters starting after the 
    1016   character at position <first> deleted. In other words, it copies <first> 
    1017   characters, skips <len> characters>, and then copies the remainder of 
    1018   the string. If <len> is negative, deletes characters leftwards from <first>. 
    1019   Characters are numbered starting at 0.  
     1025  character at position <first> deleted. In other words, it copies 
     1026  <first> characters, skips <len> characters>, and then copies the 
     1027  remainder of the string. If <len> is negative, deletes characters 
     1028  leftwards from <first>.  Characters are numbered starting at 0. 
    10201029 
    10211030  Examples: 
    …… 
    10321041  number of sides, a certain number of times, and sums the results. 
    10331042  For example, DIE(2, 6) would roll "2d6" - two six-sided dice, 
    1034   generating a result in the range 2-12. The maximum number of 
    1035   dice this function will roll in a single call is 20. 
    1036   If a third argument is given and it's a true value, the result will 
    1037   be a space-seperated list of the individual rolls rather than their 
    1038   sum. 
     1043  generating a result in the range 2-12. The maximum number of dice 
     1044  this function will roll in a single call is 20.  If a third argument 
     1045  is given and it's a true value, the result will be a space-seperated 
     1046  list of the individual rolls rather than their sum. 
    10391047 
    10401048  Examples: 
    …… 
    10461054  dig(<name>[, <exit to>[, <exit from>]]) 
    10471055  
    1048   This function digs a room called <name>, and optionally opens and links 
    1049   <exit to> and <exit from>, like the normal @dig command. It returns 
    1050   the dbref number of the new room. 
     1056  This function digs a room called <name>, and optionally opens and 
     1057  links <exit to> and <exit from>, like the normal @dig command. It 
     1058  returns the dbref number of the new room. 
    10511059 
    10521060  This is a side-effect function and may not be enabled on some MUSHes. 
    …… 
    10601068  md2 md4 md5 sha sha1 dss1 mdc2 ripemd160 
    10611069 
    1062   Without SSL, only the sha algorithm is enabled. In both cases, sha returns 
    1063   the same thing as the sha0() function. 
     1070  Without SSL, only the sha algorithm is enabled. In both cases, sha 
     1071  returns the same thing as the sha0() function. 
    10641072 
    10651073See also: sha0() 
    …… 
    10821090  divided by the second number.  Floordiv returns the largest integer 
    10831091  less than or equal to the quotient of the first number divided by 
    1084   the second.  For positive numbers, these are the same thing, but 
    1085   for negative numbers they may be different: 
     1092  the second.  For positive numbers, these are the same thing, but for 
     1093  negative numbers they may be different: 
    10861094 
    10871095   div(13,4)          ==>  3       and     floordiv(13,4)     ==>  3 
    …… 
    11511159   
    11521160  This returns the position of <item> in <list>, where <list>'s items 
    1153   are separated by <separator>. A wildcard match is done, so this  
    1154   function behaves much like MATCH(), except its separator argument 
    1155   is required, not optional. 
     1161  are separated by <separator>. A wildcard match is done, so this 
     1162  function behaves much like MATCH(), except its separator argument is 
     1163  required, not optional. 
    11561164   
    11571165  Example: 
    …… 
    11641172  
    11651173  This function returns the words in <list of words> that are in the 
    1166   positions specified by <list of numbers>. Optionally, a list delimiter 
    1167   other than a space can be used. 
     1174  positions specified by <list of numbers>. Optionally, a list 
     1175  delimiter other than a space can be used. 
    11681176  
    11691177  Examples: 
    …… 
    12101218 
    12111219  Returns an encrypted string produced by a simple password-based 
    1212   encrypted algorithm. Good passwords are long passwords. 
    1213   This is not high-security encryption. 
    1214  
    1215   If the optional <encode> argument is true, the resulting string 
    1216   is further encoded in base 64 so that it only contains alphanumeric 
     1220  encrypted algorithm. Good passwords are long passwords.  This is not 
     1221  high-security encryption. 
     1222 
     1223  If the optional <encode> argument is true, the resulting string is 
     1224  further encoded in base 64 so that it only contains alphanumeric 
    12171225  characters. 
    12181226 
    …… 
    12231231  With no arguments, the entrances() function returns a list of all 
    12241232  exits, things, players, and rooms linked to your location, like 
    1225   @entrances. You can specify an object other than your current location 
    1226   with <object>. You can limit the type of objects found by specifying 
    1227   <type> as follows: 
     1233  @entrances. You can specify an object other than your current 
     1234  location with <object>. You can limit the type of objects found by 
     1235  specifying <type> as follows: 
     1236 
    12281237        a        all (default) 
    12291238        e        exits 
    …… 
    12311240        p        players 
    12321241        r        rooms 
    1233   You can also limit the range of the dbrefs searched by giving <begin> 
    1234   and <end>. 
     1242 
     1243  You can also limit the range of the dbrefs searched by giving 
     1244  <begin> and <end>. 
    12351245& EQ() 
    12361246  eq(<number1>, <number2>) 
    …… 
    12421252  escape(<string>) 
    12431253  
    1244   The ESCAPE() function "escapes out" potentially "dangerous" characters, 
    1245   preventing function evaluation in the next pass of the parser. It  
    1246   returns <string> after adding the escape character ('\') at the  
    1247   beginning of the string, and before the following characters: 
     1254  The ESCAPE() function "escapes out" potentially "dangerous" 
     1255  characters, preventing function evaluation in the next pass of the 
     1256  parser. It returns <string> after adding the escape character ('\') 
     1257  at the beginning of the string, and before the following characters: 
     1258 
    12481259  %  ;  [  ]  {  }  \ ( ) , ^ $ 
    12491260   
    1250   This function prevents strings entered by players from causing side  
     1261  This function prevents strings entered by players from causing side 
    12511262  effects, such as performing an unintended GET() of an attribute. It 
    1252   is only needed when the resulting string will be passed through @force 
    1253   or used as an attribute for an object (like the description of a mail 
    1254   message object).  Since the function preserves the original string,  
    1255   it is, in most cases, a better choice than SECURE(). 
     1263  is only needed when the resulting string will be passed through 
     1264  @force or used as an attribute for an object (like the description 
     1265  of a mail message object).  Since the function preserves the 
     1266  original string, it is, in most cases, a better choice than 
     1267  SECURE(). 
    12561268 
    12571269See also: decompose(), secure() 
    …… 
    12761288      >    -Shalott 
    12771289 
    1278   Get_eval() does the same thing, except it uses the format of get() instead 
    1279   of xget() -- using a slash rather than a comma to separate the object from 
    1280   the attribute. It is included for TinyMUSH 2.x compatibility. 
     1290  Get_eval() does the same thing, except it uses the format of get() 
     1291  instead of xget() -- using a slash rather than a comma to separate 
     1292  the object from the attribute. It is included for TinyMUSH 2.x 
     1293  compatibility. 
    12811294   
    12821295See also: get(), u(), xget() 
    …… 
    12871300 
    12881301  You can get the complete exit list of any room you may examine, 
    1289   regardless of whether or not exits are dark.  You can get the partial 
    1290   exit list (obeying DARK/LIGHT/etc.) of your current location or the 
    1291   enactor (%#).  You CANNOT get the exit list of anything else, 
     1302  regardless of whether or not exits are dark.  You can get the 
     1303  partial exit list (obeying DARK/LIGHT/etc.) of your current location 
     1304  or the enactor (%#).  You CANNOT get the exit list of anything else, 
    12921305  regardless of whether or not you have objects in it. 
    12931306 
    …… 
    13001313  extract(<list>[, <first>[, <length>[,<delimiter>]]]) 
    13011314 
    1302   This function returns <length> elements of a list, counting 
    1303   from the <first> element. If <length> is not specified, the 
    1304   default is 1, so extract(list,3) acts like elements(list,3).  
    1305   If <first> is not specified, the default is the 1, so 
    1306   extract(list) acts like first(list). 
     1315  This function returns <length> elements of a list, counting from the 
     1316  <first> element. If <length> is not specified, the default is 1, so 
     1317  extract(list,3) acts like elements(list,3).  If <first> is not 
     1318  specified, the default is the 1, so extract(list) acts like 
     1319  first(list). 
    13071320 
    13081321  For example: 
    …… 
    13141327  fdiv(<numerator>, <denominator>) 
    13151328  
    1316   Returns the quotient of the two numbers. Note that the DIV() and MOD() 
    1317   functions cannot be used on floating point numbers. 
     1329  Returns the quotient of the two numbers. Note that the DIV() and 
     1330  MOD() functions cannot be used on floating point numbers. 
    13181331 
    13191332See also: div() 
    …… 
    13231336  filterbool([<obj>]/<attr>, <list>[,<delimiter>[, <osep>]]) 
    13241337 
    1325   This function returns the elements of <list> for which a user-defined 
    1326   function evaluates to "1", or to a boolean true value if filterbool() 
    1327   is used. That function is specified by the first argument (just as 
    1328   with the ufun() function), and the element of the list being tested is 
    1329   passed to that user-defined function as %0. 
    1330    
    1331   Thus, "filter(obj/attr, x1 x2 x3)" is nearly equivalent to 
    1332   "iter(x1 x2 x3, switch(ufun(obj/attr, ##),1,##,))" 
    1333   though the iter version may have extra blank spaces. 
     1338  This function returns the elements of <list> for which a 
     1339  user-defined function evaluates to "1", or to a boolean true value 
     1340  if filterbool() is used. That function is specified by the first 
     1341  argument (just as with the ufun() function), and the element of the 
     1342  list being tested is passed to that user-defined function as %0. 
     1343   
     1344  Thus, "filter(obj/attr, x1 x2 x3)" is nearly equivalent to "iter(x1 
     1345  x2 x3, switch(ufun(obj/attr, ##),1,##,))" though the iter version 
     1346  may have extra blank spaces. 
    13341347   
    13351348  Example: 
    …… 
    13431356  findable(<object>, <victim>) 
    13441357  
    1345   This function returns 1 if <object> can locate <victim>, or 0, if 
    1346   it cannot. If one of the objects does not exist, it will return 
    1347   #-1 ARGN NOT FOUND (where N is the argument which is the invalid 
     1358  This function returns 1 if <object> can locate <victim>, or 0, if it 
     1359  cannot. If one of the objects does not exist, it will return #-1 
     1360  ARGN NOT FOUND (where N is the argument which is the invalid 
    13481361  object). 
    13491362  
    …… 
    13571370  firstof(<expr1>, <expr2>[, ... , <exprN>]) 
    13581371 
    1359   Returns the first evaluated expression that is true.  If no arguments 
    1360   are true, then the last argument, <exprN>, is returned as the default 
    1361   expression, whether it is true or false.   
     1372  Returns the first evaluated expression that is true.  If no 
     1373  arguments are true, then the last argument, <exprN>, is returned as 
     1374  the default expression, whether it is true or false. 
    13621375 
    13631376  The meaning of true or false is dependent on configuration options 
    …… 
    13831396  flags() 
    13841397 
    1385   Flags returns a string consisting of the flags attached to the  
     1398  Flags returns a string consisting of the flags attached to the 
    13861399  object or the attribute on the object. The string is a single word 
    13871400  made up of all the appropriate flag letters. 
    13881401 
    1389   Given no arguments, this function returns a string consisting of 
    1390   all the flag letters of all the flags the server knows. Note that 
    1391   some flags may not have flag letters, and multiple flags may have 
    1392   the same letter (and will appear twice). 
     1402  Given no arguments, this function returns a string consisting of all 
     1403  the flag letters of all the flags the server knows. Note that some 
     1404  flags may not have flag letters, and multiple flags may have the 
     1405  same letter (and will appear twice). 
    13931406 
    13941407See also: lflags() 
    …… 
    13981411  lflags() 
    13991412 
    1400   Lflags returns a space-separated list consisting of the names of flags 
    1401   attached to the object or the attribute on the object. 
    1402  
    1403   Given no arguments, this function returns a space-separated list 
    1404   of all flag names known to the server. 
     1413  Lflags returns a space-separated list consisting of the names of 
     1414  flags attached to the object or the attribute on the object. 
     1415 
     1416  Given no arguments, this function returns a space-separated list of 
     1417  all flag names known to the server. 
    14051418 
    14061419See also: flags() 
    …… 
    14351448  fold([<obj>/]<attr>, <list>[, <base case>[,<delimiter>]]) 
    14361449   
    1437   This function "folds" a list through a user-defined function, specified 
    1438   by the first argument to fold(), which is analogous to ufun()'s first 
    1439   argument. 
    1440    
    1441   If no base case is provided, fold() passes the first element of <list> 
    1442   as %0, and the second element of <list> as %1, to the user-defined 
    1443   function. The user-defined function is then called again, with the 
    1444   result of the first evaluation being %0, and the next (third) element 
    1445   of the list as %1. This is repeated until all the elements of the  
    1446   list have been used. 
    1447    
    1448   If a base case is provided, it is passed as %0, and the first element 
    1449   of list is passed as %1, to the user-defined function. The process for 
    1450   the no-base-case fold() is then used. 
     1450  This function "folds" a list through a user-defined function, 
     1451  specified by the first argument to fold(), which is analogous to 
     1452  ufun()'s first argument. 
     1453   
     1454  If no base case is provided, fold() passes the first element of 
     1455  <list> as %0, and the second element of <list> as %1, to the 
     1456  user-defined function. The user-defined function is then called 
     1457  again, with the result of the first evaluation being %0, and the 
     1458  next (third) element of the list as %1. This is repeated until all 
     1459  the elements of the list have been used. 
     1460   
     1461  If a base case is provided, it is passed as %0, and the first 
     1462  element of list is passed as %1, to the user-defined function. The 
     1463  process for the no-base-case fold() is then used. 
    14511464   
    14521465  See 'help FOLD2' for examples. 
    …… 
    14821495  Maps a function onto a string. 
    14831496  
    1484   Each character in <string> has the user-defined function of the first 
    1485   argument performed on it; the character is passed to the function as 
    1486   %0, and its position in the string as %1 (the first character has  
    1487   position 0). The results are concatenated. If a start character is given, 
    1488   everything before that character is copied without passing it to the 
    1489   function, and everything after it until the end of the string or an end 
    1490   character is passed to the function. Anything left after the end character 
    1491   is also copied unevaluated. The start and end characters themselves are  
    1492   not copied. 
     1497  Each character in <string> has the user-defined function of the 
     1498  first argument performed on it; the character is passed to the 
     1499  function as %0, and its position in the string as %1 (the first 
     1500  character has position 0). The results are concatenated. If a start 
     1501  character is given, everything before that character is copied 
     1502  without passing it to the function, and everything after it until 
     1503  the end of the string or an end character is passed to the 
     1504  function. Anything left after the end character is also copied 
     1505  unevaluated. The start and end characters themselves are not copied. 
    14931506  
    14941507Continued in HELP FOREACH2 
    …… 
    15121525  fraction(<number>) 
    15131526 
    1514   This function returns a fraction representing the floating-point <number>. 
    1515   Since not all numbers can be expressed as a fraction, dividing the 
    1516   numerator by the denominator of the results will not always return the 
    1517   original <number>, but something close to it.   
     1527  This function returns a fraction representing the floating-point 
     1528  <number>.  Since not all numbers can be expressed as a fraction, 
     1529  dividing the numerator by the denominator of the results will not 
     1530  always return the original <number>, but something close to it. 
    15181531 
    15191532  Examples: 
    …… 
    15281541 
    15291542  Fullname() returns the name of object <object>. It is identical to 
    1530   name() except that for exits, fullname() returns the complete 
    1531   exit name, including all aliases. 
     1543  name() except that for exits, fullname() returns the complete exit 
     1544  name, including all aliases. 
    15321545   
    15331546  >"[fullname(south)] 
    …… 
    15441557  get(<object>/<attribute>) 
    15451558 
    1546   The get() function returns the string stored in an object's attribute.  
    1547   You may get the attributes of objects you control, the attributes you 
    1548   own on other objects, and publicly accessible attributes. 
    1549    
     1559  The get() function returns the string stored in an object's 
     1560  attribute.  You may get the attributes of objects you control, the 
     1561  attributes you own on other objects, and publicly accessible 
     1562  attributes. 
    15501563& GRAB() 
    15511564& REGRAB() 
    …… 
    15551568  regrabi(<list>, <regexp>[,<delimiter>]) 
    15561569   
    1557   This function returns the first word in list which matches the pattern. 
    1558   For grab(), the pattern is specified as in match(); i.e., it  
    1559   can contain wildcards. For regrab(), the pattern is a regular expression. 
    1560   regrabi() is case-insensitive. 
    1561    
    1562   Basically, this is a much more efficient way to do: 
    1563   extract(list, match(list, pattern, delimiter), 1, delimiter) or 
    1564   the regular expression variation thereof. 
     1570  This function returns the first word in list which matches the 
     1571  pattern.  For grab(), the pattern is specified as in match(); i.e., 
     1572  it can contain wildcards. For regrab(), the pattern is a regular 
     1573  expression.  regrabi() is case-insensitive. 
     1574   
     1575  Basically, this is a much more efficient way to do: extract(list, 
     1576  match(list, pattern, delimiter), 1, delimiter) or the regular 
     1577  expression variation thereof. 
    15651578 
    15661579See also: match(), extract(), element(), elements(), index(), regmatch(), 
    …… 
    15731586  regraballi(<list>, <regexp>[,<delim>[, <output separator>]]) 
    15741587   
    1575   These functions work identically to the grab() and regrab()/regrabi() 
    1576   functions, save that they return all matches, not just the first: They  
    1577   return all words in the <list> which match <pattern>.  
    1578   If none match, an empty string is returned. 
     1588  These functions work identically to the grab() and 
     1589  regrab()/regrabi() functions, save that they return all matches, not 
     1590  just the first: They return all words in the <list> which match 
     1591  <pattern>.  If none match, an empty string is returned. 
    15791592   
    15801593  Examples: 
    …… 
    16021615   
    16031616  These functions return a list of attributes on <object> containing 
    1604   <substring>, matching the wildcard <pattern>, or matching the regular 
    1605   expression <regexp>.  <attrs> is a wildcard pattern for attribute 
    1606   names to search. 
     1617  <substring>, matching the wildcard <pattern>, or matching the 
     1618  regular expression <regexp>.  <attrs> is a wildcard pattern for 
     1619  attribute names to search. 
    16071620 
    16081621  Parsing _does_ occur before this function is invoked. Therefore, 
    1609   "special" characters will need to be escaped out.  
     1622  "special" characters will need to be escaped out. 
    16101623 
    16111624  grep()/wildgrep()/regrep() are case-sensitive.  
    …… 
    16351648  is present and 0 if it is not. 
    16361649 
    1637   hasattr() returns 1 if the object has the attribute, 0 if it doesn't. 
     1650  hasattr() returns 1 if the object has the attribute, 0 if it 
     1651  doesn't. 
    16381652   
    16391653  hasattrp() also checks for attributes inherited from parent objects. 
    …… 
    16431657  hasattrpval() is hasattrval() but checks parents. 
    16441658   
    1645   All four functions will also work with one argument in the form 
    1646   of <object>/<attribute>. 
     1659  All four functions will also work with one argument in the form of 
     1660  <object>/<attribute>. 
    16471661 
    16481662& HASFLAG() 
    …… 
    16631677  HASTYPE() function. 
    16641678 
    1665   If an attribute is given, checks to see if the attribute has the  
    1666   given attribute flag. See 'help attribute flags' for attribute flag names. 
     1679  If an attribute is given, checks to see if the attribute has the 
     1680  given attribute flag. See 'help attribute flags' for attribute flag 
     1681  names. 
    16671682 
    16681683See also: orlflags(), andlflags(), orflags(), andflags() 
    …… 
    16711686  
    16721687  Returns 1 if the object has the named power, and 0 if it does not. 
    1673   If the object does not exist, #-1 will be returned.  
    1674  
    1675   You may or may not have to be able to examine the object to use this. 
     1688  If the object does not exist, #-1 will be returned. 
     1689 
     1690  You may or may not have to be able to examine the object to use 
     1691  this. 
    16761692& HASTYPE() 
    16771693  hastype(<object>, <type list>) 
    16781694 
    1679   Returns 1 if the object is of the named type, otherwise 0. 
    1680   Valid types are: ROOM, EXIT, PLAYER, THING, GARBAGE. You can 
    1681   test to see if the object is one of a number of types by using a space- 
    1682   separated list of types. 
    1683   If an invalid type is given, #-1 NO SUCH TYPE is returned. 
     1695  Returns 1 if the object is of the named type, otherwise 0.  Valid 
     1696  types are: ROOM, EXIT, PLAYER, THING, GARBAGE. You can test to see 
     1697  if the object is one of a number of types by using a space- 
     1698  separated list of types.  If an invalid type is given, #-1 NO SUCH 
     1699  TYPE is returned. 
    16841700& HIDDEN() 
    16851701  hidden(<player|descriptor>) 
    …… 
    16911707  home(<object>) 
    16921708  
    1693   Returns the object's 'home'.  This is the home for a player or thing, 
    1694   the drop-to of a room, or source of an exit. 
     1709  Returns the object's 'home'.  This is the home for a player or 
     1710  thing, the drop-to of a room, or source of an exit. 
    16951711& HOST() 
    16961712& HOSTNAME() 
    …… 
    16981714  hostname(<player|descriptor>) 
    16991715 
    1700   Returns the hostname of a player as indicated by WHO.  This may 
    1701   be more reliable that get(<player>/lastsite) if the player has 
    1702   multple connections from different locations, and the function 
    1703   is called with a descriptor argument. 
     1716  Returns the hostname of a player as indicated by WHO.  This may be 
     1717  more reliable that get(<player>/lastsite) if the player has multple 
     1718  connections from different locations, and the function is called 
     1719  with a descriptor argument. 
    17041720 
    17051721  The caller can use the function on himself, but using on any other 
    …… 
    17131729  
    17141730  This function returns the number of seconds a player has been idle, 
    1715   much as WHO does. <player name> must be the full name of a player, or 
    1716   a player's dbref. Players who are not connected have an idlesecs of "-1", 
    1717   as do dark wizards, when idle() is used on them by a non-priv'ed player. 
     1731  much as WHO does. <player name> must be the full name of a player, 
     1732  or a player's dbref. Players who are not connected have an idlesecs 
     1733  of "-1", as do dark wizards, when idle() is used on them by a 
     1734  non-priv'ed player. 
    17181735 
    17191736& IF() 
    …… 
    17221739  ifelse(<condition>, <true expression>, <false expression>) 
    17231740 
    1724   These functions evaluate the <condition> and return <true expression> 
    1725   if the <condition> is true, or <false expression> (if provided) if the 
    1726   <condition> is false. 
     1741  These functions evaluate the <condition> and return <true 
     1742  expression> if the <condition> is true, or <false expression> (if 
     1743  provided) if the <condition> is false. 
    17271744 
    17281745See also: BOOLEAN VALUES, switch() 
    …… 
    17421759  inc(<string-ending-in-integer>) 
    17431760 
    1744   Inc returns the integer plus 1. If given a string that ends in an integer, 
    1745   it increments only the final integer portion. That is: 
     1761  Inc returns the integer plus 1. If given a string that ends in an 
     1762  integer, it increments only the final integer portion. That is: 
    17461763 
    17471764  > think inc(3) 
    …… 
    17631780  This function is similar to EXTRACT(), except that it requires four 
    17641781  arguments, while EXTRACT() uses defaults for its arguments if they 
    1765   aren't given. The function returns <length> items starting from 
    1766   the <first> position. Trailing spaces are trimmed. The comma cannot 
    1767   be used as the <character> separator unless it's escaped with a \.  
     1782  aren't given. The function returns <length> items starting from the 
     1783  <first> position. Trailing spaces are trimmed. The comma cannot be 
     1784  used as the <character> separator unless it's escaped with a \. 
    17681785   
    17691786  Examples: 
    …… 
    17851802 
    17861803  That means that <new item> then becomes the <position>th element of&n