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 events.php

Documentation is available at events.php

  1. <?php
  2. /**
  3.  * Constants for the events system
  4.  *
  5.  * For some events, the event() method is called in objects, if defined. The
  6.  * first argument is the type of event, as defined by the constants in this
  7.  * file. Other arguments depend on the type of event.
  8.  *
  9.  * DutchPIPE version 0.4; PHP version 5
  10.  *
  11.  * LICENSE: This source file is subject to version 1.0 of the DutchPIPE license.
  12.  * If you did not receive a copy of the DutchPIPE license, you can obtain one at
  13.  * http://dutchpipe.org/license/1_0.txt or by sending a note to
  14.  * license@dutchpipe.org, in which case you will be mailed a copy immediately.
  15.  *
  16.  * @package    DutchPIPE
  17.  * @subpackage dpuniverse_include
  18.  * @author     Lennert Stock <ls@dutchpipe.org>
  19.  * @copyright  2006, 2007 Lennert Stock
  20.  * @license    http://dutchpipe.org/license/1_0.txt  DutchPIPE License
  21.  * @version    Subversion: $Id: events.php 277 2007-08-19 18:15:10Z ls $
  22.  * @link       http://dutchpipe.org/manual/package/DutchPIPE
  23.  */
  24.  
  25. /**
  26.  * An object left this object's inventory
  27.  *
  28.  * When an objects leaves an inventory, the following call takes place:
  29.  * $old_environment->event(EVENT_LEFT_INV, $object, $new_environment);
  30.  *
  31.  * @see        EVENT_ENTERED_INV, EVENT_ENTERED_ENV, EVENT_CHANGED_ENV,
  32.  *              EVENT_DESTROYING_OBJ, DpObject::moveDpObject(),
  33.  *              DpObject::removeDpObject()
  34.  */
  35. define('EVENT_LEFT_INV', 1);
  36.  
  37. /**
  38.  * An object entered this object's inventory
  39.  *
  40.  * When an objects enters a new environment, the following call takes place:
  41.  * $new_environment->event(EVENT_ENTERED_INV, $object, $old_environment);
  42.  *
  43.  * @see        EVENT_LEFT_INV, EVENT_ENTERED_ENV, EVENT_CHANGED_ENV,
  44.  *              EVENT_DESTROYING_OBJ, DpObject::moveDpObject()
  45.  */
  46. define('EVENT_ENTERED_INV', 2);
  47.  
  48. /**
  49.  * An object entered this object's environment
  50.  *
  51.  * When an objects enters a new environment, the following call takes place in
  52.  * all objects in the new environment's inventory:
  53.  * $inventory_object->event(EVENT_ENTERED_ENV, $object, $old_environment);
  54.  *
  55.  * @see        EVENT_LEFT_INV, EVENT_ENTERED_INV, EVENT_CHANGED_ENV,
  56.  *              EVENT_DESTROYING_OBJ, DpObject::moveDpObject()
  57.  */
  58. define('EVENT_ENTERED_ENV', 3);
  59.  
  60. /**
  61.  * An object's environment changed
  62.  *
  63.  * When an objects enters a new environment, the following call takes place in
  64.  * the object:
  65.  * $object->event(EVENT_CHANGED_ENV, $old_environment, $new_environment);
  66.  *
  67.  * @see        EVENT_LEFT_INV, EVENT_ENTERED_INV, EVENT_ENTERED_ENV,
  68.  *              EVENT_DESTROYING_OBJ, DpObject::moveDpObject(),
  69.  *              DpObject::removeDpObject()
  70.  */
  71. define('EVENT_CHANGED_ENV', 4);
  72.  
  73. /**
  74.  * An object is being destroyed
  75.  *
  76.  * When an objects is being destroyed, the following call takes place in the
  77.  * object:
  78.  * $object->event(EVENT_DESTROYING_OBJ);
  79.  *
  80.  * @see        EVENT_LEFT_INV, EVENT_ENTERED_INV, EVENT_ENTERED_ENV,
  81.  *              EVENT_CHANGED_ENV, DpObject::removeDpObject()
  82.  */
  83. define('EVENT_DESTROYING_OBJ', 5);
  84. ?>
Documentation generated on Mon, 03 Sep 2007 22:21:32 +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.