Your browser must have JavaScript enabled in order to view this page.
> >
 
Welcome Guest#213 Login/register    Go to Bottom


INSTALL | LICENSE | README | CHANGES | Class Tree | Index
Go to Top

Source for file actions.php

Documentation is available at actions.php

  1. <?php
  2. /**
  3.  * Constants for the action system
  4.  *
  5.  * Used by the {@link Dpobject::addAction} and {@link DpObject::getActions}
  6.  * methods.
  7.  *
  8.  * DutchPIPE version 0.4; PHP version 5
  9.  *
  10.  * LICENSE: This source file is subject to version 1.0 of the DutchPIPE license.
  11.  * If you did not receive a copy of the DutchPIPE license, you can obtain one at
  12.  * http://dutchpipe.org/license/1_0.txt or by sending a note to
  13.  * license@dutchpipe.org, in which case you will be mailed a copy immediately.
  14.  *
  15.  * @package    DutchPIPE
  16.  * @subpackage dpuniverse_include
  17.  * @author     Lennert Stock <ls@dutchpipe.org>
  18.  * @copyright  2006, 2007 Lennert Stock
  19.  * @license    http://dutchpipe.org/license/1_0.txt  DutchPIPE License
  20.  * @version    Subversion: $Id: actions.php 277 2007-08-19 18:15:10Z ls $
  21.  * @link       http://dutchpipe.org/manual/package/DutchPIPE
  22.  * @see        DpObject::addAction(), DpObject::getActionData()
  23.  */
  24.  
  25. /**
  26.  * Action operates on object carrying action menu
  27.  *
  28.  * The noun associated with the action verb becomes the object that carries the
  29.  * action in its action menu.
  30.  *
  31.  * @see        DpObject::addAction(), DpObject::getActionData(),
  32.  *              DP_ACTION_OPERANT_NONE, DP_ACTION_OPERANT_COMPLETE
  33.  */
  34. define('DP_ACTION_OPERANT_MENU', 1);
  35.  
  36. /**
  37.  * Action has no operant or operant is current living
  38.  *
  39.  * There is no noun associated with the action verb, for example "laugh".
  40.  *
  41.  * @see        DpObject::addAction(), DpObject::getActionData(),
  42.  *              DP_ACTION_OPERANT_MENU, DP_ACTION_OPERANT_COMPLETE
  43.  */
  44. define('DP_ACTION_OPERANT_NONE', 2);
  45.  
  46. /**
  47.  * Action operates on object carrying action menu and on to be given operant
  48.  *
  49.  * Can be used to ask the user on who or what the action must be performed, for
  50.  * example "give".
  51.  *
  52.  * @see        DpObject::addAction(), DpObject::getActionData(),
  53.  *              DP_ACTION_OPERANT_MENU, DP_ACTION_OPERANT_NONE
  54.  */
  55. define('DP_ACTION_OPERANT_COMPLETE', 4);
  56.  
  57. /**
  58.  * Not supported yet
  59.  *
  60.  * @ignore
  61.  */
  62. define('DP_ACTION_OPERANT_METHOD', 8);
  63.  
  64. /**
  65.  * Not supported yet
  66.  *
  67.  * @ignore
  68.  */
  69. define('DP_ACTION_OPERANT_METHOD_MENU', 16);
  70.  
  71. /**
  72.  * Action appears on this objects' action menu
  73.  *
  74.  * @see        DpObject::addAction(), DpObject::getActionData(),
  75.  *              DP_ACTION_TARGET_LIVING, DP_ACTION_TARGET_USER,
  76.  *              DP_ACTION_TARGET_OBJINV, DP_ACTION_TARGET_OBJENV,
  77.  *             DP_ACTION_TARGET_NONE
  78.  */
  79. define('DP_ACTION_TARGET_SELF', 1);
  80.  
  81. /**
  82.  * Action appears on livings' action menu in this objects environment or
  83.  * inventory
  84.  *
  85.  * @see        DpObject::addAction(), DpObject::getActionData(),
  86.  *              DP_ACTION_TARGET_SELF, DP_ACTION_TARGET_USER,
  87.  *              DP_ACTION_TARGET_OBJINV, DP_ACTION_TARGET_OBJENV,
  88.  *              DP_ACTION_TARGET_NONE
  89.  */
  90. define('DP_ACTION_TARGET_LIVING', 2);
  91.  
  92. /**
  93.  * Action appears on users' action menu in this objects environment or
  94.  * inventory
  95.  *
  96.  * @see        DpObject::addAction(), DpObject::getActionData(),
  97.  *              DP_ACTION_TARGET_SELF, DP_ACTION_TARGET_LIVING,
  98.  *              DP_ACTION_TARGET_OBJINV, DP_ACTION_TARGET_OBJENV,
  99.  *              DP_ACTION_TARGET_NONE
  100.  */
  101. define('DP_ACTION_TARGET_USER', 4);
  102.  
  103. /**
  104.  * Action appears on action menu of objects in inventory of this object
  105.  *
  106.  * @see        DpObject::addAction(), DpObject::getActionData(),
  107.  *              DP_ACTION_TARGET_SELF, DP_ACTION_TARGET_LIVING,
  108.  *              DP_ACTION_TARGET_USER, DP_ACTION_TARGET_OBJENV,
  109.  *              DP_ACTION_TARGET_NONE
  110.  */
  111. define('DP_ACTION_TARGET_OBJINV', 8);
  112.  
  113. /**
  114.  * Action appears on action menu of objects in environment of this object
  115.  *
  116.  * @see        DpObject::addAction(), DpObject::getActionData(),
  117.  *              DP_ACTION_TARGET_SELF, DP_ACTION_TARGET_LIVING,
  118.  *              DP_ACTION_TARGET_USER, DP_ACTION_TARGET_OBJINV,
  119.  8             DP_ACTION_TARGET_NONE
  120.  */
  121. define('DP_ACTION_TARGET_OBJENV', 16);
  122.  
  123. /**
  124.  * Action doesn't appear on any action menu
  125.  *
  126.  * @see        DpObject::addAction(), DpObject::getActionData(),
  127.  *              DP_ACTION_TARGET_SELF, DP_ACTION_TARGET_LIVING,
  128.  *              DP_ACTION_TARGET_USER,  DP_ACTION_TARGET_OBJINV,
  129.  *              DP_ACTION_TARGET_OBJENV
  130.  */
  131. define('DP_ACTION_TARGET_NONE', 32);
  132.  
  133. /**
  134.  * The action is restricted to guests only
  135.  *
  136.  * @see        DpObject::addAction(), DpObject::getActionData(),
  137.  *              DP_ACTION_AUTHORIZED_REGISTERED, DP_ACTION_AUTHORIZED_ADMIN,
  138.  *              DP_ACTION_AUTHORIZED_ALL, DP_ACTION_AUTHORIZED_DISABLED
  139.  */
  140. define('DP_ACTION_AUTHORIZED_GUEST', 1);
  141.  
  142. /**
  143.  * The action is restricted to registered users only
  144.  *
  145.  * @see        DpObject::addAction(), DpObject::getActionData(),
  146.  *              DP_ACTION_AUTHORIZED_GUEST, DP_ACTION_AUTHORIZED_ADMIN,
  147.  *              DP_ACTION_AUTHORIZED_ALL, DP_ACTION_AUTHORIZED_DISABLED
  148.  */
  149. define('DP_ACTION_AUTHORIZED_REGISTERED', 2);
  150.  
  151. /**
  152.  * The action is restricted to administrator users only
  153.  *
  154.  * @see        DpObject::addAction(), DpObject::getActionData(),
  155.  *              DP_ACTION_AUTHORIZED_GUEST, DP_ACTION_AUTHORIZED_REGISTERED,
  156.  *              DP_ACTION_AUTHORIZED_ALL, DP_ACTION_AUTHORIZED_DISABLED
  157.  */
  158. define('DP_ACTION_AUTHORIZED_ADMIN', 4);
  159.  
  160. /**
  161.  * The action is disabled (or "ghosted").
  162.  *
  163.  * @see        DpObject::addAction(), DpObject::getActionData(),
  164.  *              DP_ACTION_AUTHORIZED_GUEST, DP_ACTION_AUTHORIZED_REGISTERED,
  165.  *              DP_ACTION_AUTHORIZED_ALL, DP_ACTION_AUTHORIZED_ADMIN
  166.  */
  167. define('DP_ACTION_AUTHORIZED_DISABLED', 8);
  168.  
  169. /**
  170.  * Everybody may try to perform the action
  171.  *
  172.  * The method that is called may forbid it anyway though.
  173.  *
  174.  * @see        DpObject::addAction(), DpObject::getActionData(),
  175.  *              DP_ACTION_AUTHORIZED_GUEST, DP_ACTION_AUTHORIZED_REGISTERED,
  176.  *              DP_ACTION_AUTHORIZED_ADMIN, DP_ACTION_AUTHORIZED_DISABLED
  177.  */
  178. define('DP_ACTION_AUTHORIZED_ALL', 32);
  179.  
  180. /**
  181.  * Action is available to objects in this object's environment only
  182.  *
  183.  * @see        DpObject::addAction(), DpObject::getActionData(),
  184.  *              DP_ACTION_SCOPE_INVENTORY, DP_ACTION_SCOPE_SELF,
  185.  *              DP_ACTION_SCOPE_ALL
  186.  */
  187. define('DP_ACTION_SCOPE_ENVIRONMENT', 1);
  188.  
  189. /**
  190.  * Action is available to objects in this object's inventory only
  191.  *
  192.  * @see        DpObject::addAction(), DpObject::getActionData(),
  193.  *              DP_ACTION_SCOPE_ENVIRONMENT, DP_ACTION_SCOPE_SELF,
  194.  *              DP_ACTION_SCOPE_ALL
  195.  */
  196. define('DP_ACTION_SCOPE_INVENTORY', 2);
  197.  
  198. /**
  199.  * Action is available to this object only
  200.  *
  201.  * @see        DpObject::addAction(), DpObject::getActionData(),
  202.  *              DP_ACTION_SCOPE_ENVIRONMENT, DP_ACTION_SCOPE_INVENTORY,
  203.  *              DP_ACTION_SCOPE_ALL
  204.  */
  205. define('DP_ACTION_SCOPE_SELF', 4);
  206.  
  207. /**
  208.  * Action is available to this object, inventory and objects in environment
  209.  *
  210.  * @see        DpObject::addAction(), DpObject::getActionData(),
  211.  *              DP_ACTION_SCOPE_ENVIRONMENT, DP_ACTION_SCOPE_INVENTORY,
  212.  *              DP_ACTION_SCOPE_SELF
  213.  */
  214. define('DP_ACTION_SCOPE_ALL', 8);
  215. ?>
Documentation generated on Mon, 03 Sep 2007 22:18:18 +0200 by phpDocumentor 1.3.0RC6

Click me!
Guest#213
 
 
 
  Go to Top
 
 
 Input Field OptionsClose Input Field Go to Top
 
Legal Notices | Copyright © 2006, 2007 Lennert Stock. All rights reserved. Last update: Mon Sep 03 2007, 21:50 CET.