PennMUSH Community

Changeset 1196

Show
Ignore:
Timestamp:
01/06/08 01:46:23 (8 months ago)
Author:
shawnw
Message:

#7491: Help function list improvements.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • 1.8.3/branches/devel/game/txt/hlp/pennfunc.hlp

    r1183 r1196  
    11& FUNCTIONS 
    22  Functions are specialized commands used to manipulate strings and 
    3   other input. Function take the general form: [FUNCTION(<input>)] 
    4  
    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. 
     3  other input. Function take the general form: [FUNCTION(<input>)] 
     4 
     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  hasattrval()   lattr()        nattr()        obj()          poss() 
     70  regrep()       regrepi()      subj()         udefault()     ufun() 
     71  uldefault()    ulocal()       v-function     wildgrep()     wildgrepi() 
     72  xget()         zfun()          
    7273 
    7374See also: ATTRIBUTES, NON-STANDARD ATTRIBUTES 
     
    7677  or 1) and manipulate them. 
    7778 
    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 
     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() 
     
    129131  Information functions return values related to objects or the game. 
    130132 
    131   alias()       andflags()    andlflags()   andlpowers()  config() 
    132   controls()    ctime()       elock()       findable()    flags() 
    133   fullalias()   fullname()    hasattr()     hasattrp()    hasflag() 
    134   haspower()    hastype()     iname()       lflags()      lock() 
    135   lstats()      money()       mtime()       mudname()     name() 
    136   nattr()       nearby()      objid()       objmem()      orflags() 
    137   orlflags()    orlpowers()   playermem()   poll()        powers() 
    138   quota()       restarts()    type()        version()     visible() 
     133  alias()        andflags()     andlflags()    andlpowers()   config() 
     134  controls()     ctime()        elock()        findable()     flags() 
     135  fullalias()    fullname()     hasattr()      hasattrp       hasflag() 
     136  haspower()     hastype()      iname()        lflags()       lock() 
     137  lstats()       money()        mtime()        mudname()      name() 
     138  nattr()        nearby()       objid()        objmem()       orflags() 
     139  orlflags()     orlpowers()    playermem()    poll()         powers() 
     140  quota()        restarts()     type()         version()      visible() 
     141 
    139142& 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. 
     143  List functions take at least one list of elements and return 
     144  transformed lists or one or more members of those lists. Most of 
     145  these functions can take an arbitrary <delimiter> argument to 
     146  specify what delimits list elements; if none is provided, a space is 
     147  used by default. 
    144148 
    145149  element()     elements()    extract()     filter()      filterbool() 
     
    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() 
     
    196200  string, parts of a string, or a value related to the string(s). 
    197201 
    198   accent()      after()       align()       alphamin()    alphamax() 
    199   art()         before()      brackets()    capstr()      case() 
    200   caseall()     cat()         center()      comp()        chr() 
    201   decode64()    decompose()   decrypt()     delete()      digest() 
    202   edit()        encode64()    encrypt()     escape()      if() 
    203   ifelse()      foreach()     lcstr()       left()        lit() 
    204   ljust()       merge()       mid()         ord()         ordinal() 
    205   pos()         regedit()     lpos()        regmatch()    repeat() 
    206   reverse()     right()       rjust()       scramble()    secure() 
    207   sha0()        space()       spellnum()    squish()      strcat() 
    208   strinsert()   stripaccents()stripansi()   strlen()      strmatch() 
    209   strreplace()  switch()      trim()        ucstr()       wrap() 
     202  accent()         after()          align()          alphamax() 
     203  alphamin()       art()            before()         brackets() 
     204  capstr()         case()           caseall()        cat() 
     205  center()         chr()            comp()           decode64() 
     206  decompose()      decrypt()        delete()         digest() 
     207  edit()           encode64()       encrypt()        escape() 
     208  foreach()        if()             ifelse()         lcstr() 
     209  left()           lit()            ljust()          lpos() 
     210  merge()          mid()            ord()            ordinal() 
     211  pos()            regedit()        regmatch()       repeat() 
     212  reverse()        right()          rjust()          scramble() 
     213  secure()         sha0()           space()          spellnum() 
     214  squish()         strcat()         strinsert()      stripaccents() 
     215  stripansi()      strlen()         strmatch()       strreplace() 
     216  switch()         trim()           ucstr()          wrap() 
    210217 
    211218See also: STRINGS 
     
    235242  null(<expression>[, ... , <expression>]) 
    236243 
    237   The @@() function does nothing and returns nothing. It could be 
    238   used for commenting, perhaps. It does not evaluate its argument. 
     244  The @@() function does nothing and returns nothing. It could be used 
     245  for commenting, perhaps. It does not evaluate its argument. 
    239246 
    240247  The null() function is similar, but does evaluate its argument(s),