PennMUSH Community

Changeset 1182 for 1.8.3/trunk/game

Show
Ignore:
Timestamp:
01/01/08 21:45:21 (1 year ago)
Author:
shawnw
Message:

#7488: *powers() documentation

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r1167 r1182  
    129129  Information functions return values related to objects or the game. 
    130130 
    131   alias()       andflags()    andlflags()   config()      controls() 
    132   ctime()       elock()       findable()    flags()       fullalias() 
    133   fullname()    hasattr()     hasattrp()    hasflag()     haspower() 
    134   hastype()     iname()       lflags()      lock()        lstats() 
    135   money()       mtime()       mudname()     name()        nattr() 
    136   nearby()      objid()       objmem()      orflags()     orlflags() 
    137   playermem()   poll()        powers()      quota()       restarts() 
    138   type()        version()     visible() 
    139  
     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() 
    140139& List functions 
    141140  List functions take at least one list of elements and return transformed 
    …… 
    467466  If a name does not correspond to any flag, <object> doesn't have it, 
    468467  so the function returns 0. There can be an arbitrary number of flags. 
     468& ANDLPOWERS() 
     469  andlpowers(<object>, <list of powers>) 
     470 
     471  This function returns 1 if <object> has all the powers in a 
     472  specified list, and 0 if it does not. The list is a space-separated 
     473  list of power names.  A '!' preceding a flag name means "not power". 
     474 
     475  Thus, ANDLPOWERS(me, no_quota no_pay) would return 1 if I was 
     476  powered no_quota and no_pay.  ANDLPOWERS(me, poll !guest) would 
     477  return 1 if I could change the poll and was not a guest. 
     478 
     479  If a name does not correspond to any power, <object> doesn't have 
     480  it, so the function returns 0. There can be an arbitrary number of 
     481  powers. 
    469482& ANSI() 
    470483  ansi(<codes>, <string>) 
    …… 
    30093022  If a name does not correspond to any flag, <object> doesn't have it, 
    30103023  so it is simply ignored. There can be an arbitrary number of flags. 
     3024& ORLPOWERS() 
     3025  orlpowers(<object>, <list of powers>) 
     3026 
     3027  This function returns 1 if <object> has at least one of the powers 
     3028  in a specified list, and 0 if it does not. The list is a 
     3029  space-separated list of power names.  A '!' preceding a flag name 
     3030  means "not power". 
     3031 
     3032  Thus, ORLPOWERS(me, poll login) would return 1 if I have the poll 
     3033  and login powers.  ORLFLAGS(me, functions !guest) would return 1 if I 
     3034  have the functions power or are not a guest. 
     3035 
     3036  If a name does not correspond to any power, <object> doesn't have 
     3037  it, so it is simply ignored. There can be an arbitrary number of 
     3038  powers. 
    30113039& OWNER() 
    30123040  owner(<object>[/<attribute>])