Class: DpObject

Called by PHP when this object is destroyed. removeDpObject should be called in this object to remove it from the universe. Don't use unset to remove objects. On a PHP level, __destruct will then be called in this object.

Calls the event method in this object and its environment, if any, when defined, using constants from events.php.

Triggers the EVENT_LEFT_INV event in the environment of this object with "from" ($this) and "to" (0) parameters: $environment->event(EVENT_LEFT_INV, $this, 0);

Triggers the EVENT_CHANGED_ENV event in this object with "from" (the environment) and "to" (0) parameters: $this->event(EVENT_CHANGED_ENV, $environment, 0);

If the object had no environment, the above two events are not called, instead the EVENT_CHANGED_ENV event is triggered in this object with only a "from" (0) parameter: $this->event(EVENT_CHANGED_ENV, 0);

Last, the EVENT_DESTROYING_OBJ event is triggered in this object: $this->event(EVENT_DESTROYING_OBJ);

Use this method to have actions added to the menus you get when clicking on items (the "action menu"), and at the same time to add actions you can type. See DpLiving.php for some good examples.

Because of the complexity of this method, it has its own manual page. See Action System for further information.

A single id can be added at a time, or an array with ids can be given, or multiple arguments can be given (strings or array of strings).

'Items' in objects allow you to perform some basic actions, such as examine, without making new objects.

For example, consider this page with the following description:
You are in front of a house. You see a sign.

The following call will make the house examinable:

1. add_item('house', 'It is a big, brick house.<br />');

The $item can be an identifier string or an array with strings with identifiers, for example array('house', 'brick house'). Such aliases can be used from the command line, for example 'examine brick house'.

The $description should be a string with the textual description.

The $method is optional and should be a string containing a method or an array with two elements: an object to call and a string with the method. This method is called at runtime to obtain the description. It should be defined like this:

1. function <methodName>($item)

1. add_item('door', 'A solid door. It is %s.', 'getOpenOrClosed');

The optional $mapArea can be given to make this item accessible on an imagemap, so people can click on it to examine it. Otherwise the item can only be examined by using the command line. It should be a map area id if you set one earlier with setMapArea, or an array with the arguments to setMapArea to define a new one (see setMapArea documentation for more information).

If a map area is used, the action on the imagemap is labelled 'examine'. This can be overruled by supplying $mapAreaActionMenu, which should be a string with an alternative label.

Creates a menu item labelled $actionMenuTitle on the imagemap area with id $mapAreaId. When clicked, executes $action for that user.

Can optionally be associated with an existing action by giving an $actionVerb and $actionVerbKey. Normal map area menu actions always appear. By associating it to a regular action, all its settings such as scope, target and authorization are used. Use addAction to set up such a map area action, as addAction will call addMapAreaAction with the right verb and verb key (a verb key is needed because there can be multiple indentical verbs).

An empty function which can be redefined by the class extending on DpObject. When the object is created, it has no title, HTML body, etc., so here methods such as $this->setTitle() are called. Building blocks extending on DpObject may define their own create function. For example, DpPage defines createDpPage.

Called when certain events occur, given with $name. The property lastEventTime is set to a unix time stamp. Calls eventDpObject.

Called when certain events occur, given with $name.

Without arguments, an array is returned with each element of pair consisting of: verb => array(menulabel, method, operant, target, authorized, scope) with operant one of DP_ACTION_OPERANT_, target one of DP_ACTION_TARGET_, authorized one of DP_ACTION_AUTHORIZED_ and scope one of DP_ACTION_SCOPE_ from dpuniverse/include/actions.php, for example: 'read' => array('read me!', 'actionRead', DP_ACTION_OPERANT_MENU, DP_ACTION_TARGET_SELF, DP_ACTION_AUTHORIZED_ALL, DP_ACTION_SCOPE_ALL)

You can narrow the result set down by supplying a verb, in which case an array with one or more results is returned, or FALSE if the given verb is not defined as an action.

Narrow it down further by giving a number, usually 0, to get the data at the index of the array you would get without supplying a number.

Gets HTML to represent the object to another objects. That is, other objects call this method in order to "see" it, and HTML is returned. How an object is seen depends on how the object is related to the object that is viewing it in terms of "physical" location.

In other words, a level of 0 means this object is seen by something in its inventory (a user sees a page). Level 1 means this object is seen by an object in its environment (a user sees another user). Level 2 means this object is in the inventory of the object that is seeing it.

Gets HTML to represents the all objects in this object's inventory using getAppearance.

Returns the HTML with the image and the title of the object. The method filterAppearance($level, &$from, $appearance, &$user) is called in the environments of the object if defined. $level is 1, $from is an array starting with this object, followed by elements defining a path to the current object being called, $appearance the default appearance HTML and $user the user for which we're getting the appearance of the object. If you define it, it should return a string with the HTML for the appearance, just like getAppearanceTitle does itself.

If this object contains no other objects, an empty array is returned.

An array is returned with two elements: the item description and the item method. Either can be NULL. If the item was not found, FALSE is returned.

Returns the description of the given item, or FALSE if no such item was found. Items can be added with a method to call (see addItem), here this method is processed.

If no arguments are given data of all imagemap areas is returned. If an imagemap name is given, all data for that map is returned, or FALSE if the imagemap is not defined. If both the map name and an id of the area in the map are given, data for that area is returned, or FALSE if not defined.