PennMUSH Community

Changeset 1197

Show
Ignore:
Timestamp:
01/06/08 02:07:34 (8 months ago)
Author:
shawnw
Message:

#7491: Help function list improvements.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • 1.8.2/branches/devel/game/txt/hlp/pennfunc.hlp

    r1181 r1197  
    33  other input. Function take the general form:  [FUNCTION(<input>)] 
    44 
    5   The brackets are used to delimit and force evaluation of the function  
    6   (or nested functions). The brackets can also be used to group functions  
    7   for the purposes of string concatenation. In general, more than one pair  
    8   of brackets is not required, but you can nest an arbitrary number of 
    9   brackets. 
     5  The brackets are used to delimit and force evaluation of the 
     6  function (or nested functions). The brackets can also be used to 
     7  group functions for the purposes of string concatenation. In 
     8  general, more than one pair of brackets is not required, but you can 
     9  nest an arbitrary number of brackets. 
    1010 
    1111  Examples: 
    …… 
    2323& FUNCTIONS2 
    2424 
    25   A list of available built-in functions can be obtained via the command 
    26   "@config/functions". In the help text, the list is under the topic 
    27   "FUNCTION LIST". 
    28  
    29   In addition to these built-in functions are MUSH-defined "global user 
    30   functions."  These are defined by wizards or those with the "Function" 
    31   power, via the "@function" command. To the user, they act just like 
    32   the built-in game functions. For details on global user functions, 
    33   see "help @function". 
     25  A list of available built-in functions can be obtained via the 
     26  command "@config/functions". In the help text, the list is under the 
     27  topic "FUNCTION LIST". 
     28 
     29  In addition to these built-in functions are MUSH-defined "global 
     30  user functions."  These are defined by wizards or those with the 
     31  "Function" power, via the "@function" command. To the user, they act 
     32  just like the built-in game functions. For details on global user 
     33  functions, see "help @function". 
    3434 
    3535See also: MUSHCODE 
    …… 
    6565  stored in attributes on objects. 
    6666 
    67   aposs()       attrib_set()  default()     edefault()    eval() 
    68   get()         grep()        grepi()       lattr()       nattr() 
    69   obj()         poss()        regrep()      regrepi()     subj() 
    70   udefault()    ufun()        uldefault()   ulocal()      v-function 
    71   wildgrep()    wildgrepi()   xget()        zfun() 
     67  aposs()        attrib_set()   default()      edefault()     eval() 
     68  get()          grep()         grepi()        hasattr()      hasattrp() 
     69  lattr()        nattr()        obj()          poss()         regrep() 
     70  regrepi()      subj()         udefault()     ufun()         uldefault() 
     71  ulocal()       v-function     wildgrep()     wildgrepi()    xget() 
     72  zfun()          
    7273 
    7374See also: ATTRIBUTES, NON-STANDARD ATTRIBUTES 
    7475& Bitwise functions 
    75   These functions treat integers as a sequence of binary bits (Either 0 
    76   or 1) and manipulate them. 
    77  
    78   For example, 2 is represented as '0010' and 4 as '0100'. If these two 
    79   numbers are bitwise-or'ed together with BOR(), the result is 6, or 
    80   (In binary) '0110'. These functions are useful for storing small 
     76  These functions treat integers as a sequence of binary bits (Either 
     77  0 or 1) and manipulate them. 
     78 
     79  For example, 2 is represented as '0010' and 4 as '0100'. If these 
     80  two numbers are bitwise-or'ed together with BOR(), the result is 6, 
     81  or (In binary) '0110'. These functions are useful for storing small 
    8182  lists of toggle (Yes/No) options efficiently. 
    8283 
    …… 
    8687& Boolean functions 
    8788  Boolean functions all return 0 or 1 as an answer. 
    88   Your MUSH may be configured to use traditional PennMUSH booleans, 
    89   in which case non-zero numbers, non-negative db#'s, and strings 
    90   are all considered "true" when passed to these functions. 
    91   Alternatively, your MUSH may be using TinyMUSH 2.2 booleans, 
    92   in which case only non-zero numbers are "true". 
     89 
     90  Your MUSH may be configured to use traditional PennMUSH booleans, in 
     91  which case non-zero numbers, non-negative db#'s, and strings are all 
     92  considered "true" when passed to these functions.  Alternatively, 
     93  your MUSH may be using TinyMUSH 2.2 booleans, in which case only 
     94  non-zero numbers are "true". 
    9395 
    9496  and()         cand()        cor()         eq()          gt() 
    …… 
    138140  quota()       restarts()    type()        version()     visible() 
    139141& List functions 
    140   List functions take at least one list of elements and return transformed 
    141   lists or one or more members of those lists. Most of these functions 
    142   can take an arbitrary <delimiter> argument to specify what delimits 
    143   list elements; if none is provided, a space is used by default. 
     142  List functions take at least one list of elements and return 
     143  transformed lists or one or more members of those lists. Most of 
     144  these functions can take an arbitrary <delimiter> argument to 
     145  specify what delimits list elements; if none is provided, a space is 
     146  used by default. 
    144147 
    145148  element()     elements()    extract()     filter()      filterbool() 
    …… 
    155158See also: LISTS 
    156159& Math functions 
    157   Math functions take one or more floating point numbers and return  
    158   a numeric value. 
     160 
     161  Math functions take one or more floating point numbers and return a 
     162  numeric value. 
    159163  abs()         acos()        add()         asin()        atan() 
    160164  atan2()       bound()       ceil()        cos()         ctu() 
    …… 
    171175  remainder() 
    172176 
    173   These functions operate on n-dimensional vectors. A vector 
    174   is a delimiter-separated list of numbers (space-separated, by default): 
     177  These functions operate on n-dimensional vectors. A vector is a 
     178  delimiter-separated list of numbers (space-separated, by default): 
    175179  vadd()        vcross()      vdim()        vdot()        vmag() 
    176180  vmax()        vmin()        vmul()        vsub()        vunit() 
    …… 
    187191& SQL functions 
    188192  These functions perform queries or other operations on an SQL 
    189   database to which the MUSH is connected, if SQL support is 
    190   available and enabled. 
     193  database to which the MUSH is connected, if SQL support is available 
     194  and enabled. 
    191195 
    192196  sql()         sqlescape()   mapsql()