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.

Constructs the right HTML with <map> and <area> tags and onclick events. Returns an empty string of no map data was found. Used by getBody.

By default, a 'Home' link is always present.

Gets an array with actions which can be performed on this object, so we can make a menu when hovering over the object image with the mouse. This includes actions that are defined by other objects but appear in this object's action menu.

An array is returned, empty if there are no menu actions found, with key-value pairs. Each key is the (first) menu title associated with the action pair, each value an array of three elements: the verb, the "operant" as defined with addAction and a boolean indicating whether this menu item is ghosted.

Gets the title as set with setTitle, for example "barkeeper" if no $type is given.

If $type is DPUNIVERSE_TITLE_TYPE_INDEFINITE, "a ..." or "an ..." is put in front if the object's title type has been set to indefinite. So for a barkeeper this returns "a barkeeper", for me it returns "Lennert".

If $type is DPUNIVERSE_TITLE_TYPE_DEFINITE, "the" is put in front if the object's title type is not DPUNIVERSE_TITLE_TYPE_NAME. So for a barkeeper this returns "the barkeeper", for me it returns "Lennert".

To save some memory, the universe object will call this method in objects with no environment, which haven't been referenced for a while.

If no users or special object using the isNoCleanUp property are present, the object and all of its inventory is destroyed.

Experimental mouse dragging of objects.

For example, a barkeeper object was set up like this: $this->addId('barkeeper'); Now isId('barkeeper') called in this object will return TRUE, but 'the barkeeper' and 'a barkeeper' will also return TRUE. The disable the last behaviour, set $checkWithArticle to FALSE.

If $what is a string, searches for an object with that id. If $what is an object, searches for that object. Searches are done in the inventory of this object.

Replenishes this object's inventory up to $number instances of $what. This method is usually called from the reset method of pages and npc's.

If $what is a string, searches for an object with that id. If $what is an object, searches for that object. Searches are done in the inventory of this object.

A $number can be given to search for more objects instead of just one. For example, it could check for the presence of 5 roses, and if there are only 3, create another 2.

If $mustBeHere is FALSE (it is TRUE by default), it will not replenish objects which are still in another part of the universe, instead of having been destroyed. For example, the 2 missing roses could have been taken by a user who is now on another page, and with this argument set to FALSE, no extra objects will be created.

If $mustBeHere is TRUE, $moveHere can be set to TRUE (it is FALSE by default) to move objects which still exist but are located in another part of the universe, back to this object, its original location.

When a user doesn't use the action menu, but gives a command such as 'take beer', or when an NPC performs an action, the system doesn't know which object defines the action. Therefore, it calls this method in all objects which are eligable to perform this action. Objects are searched for, in this order, in the object performing the action, its inventory, in its environment, and the environment itself.

performActionSubject returns TRUE if the action was completed by this object, or FALSE if this action was not directed at this object, in which case the system will try the next object, if any.

Removes the action associated to the given $actionVerb. If the action was linked to an imagemap area, provide the area id with $mapAreaId to delete this information as well.

The object is destroyed and no longer part of the universe. Don't use unset to remove objects. Removes the object from browsers viewing the same environment. On a PHP level, __destruct will then be called in this object.

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

Either 1) the action menu title, 2) the executed action string when clicked (while the title is NULL) or 3) both can be given. Removes the first found match.

Called by the client-side dpclient-js.php script after an object was dragged by a user. Coordinates are passed as 'x' and 'y' in a GET request and passed on to other users in the same environment.

Called by this object at regular intervals as defined in dpuniverse-ini.php. An empty function which can be redefined by the class extending on DpObject. To be used to periodically do stuff such as alter the state of this object.

If this is a page, this defines the page content. For other objects, it defines what you see when examining the object or moving into the object (which makes the object behave like a page).

When a single argument is given, sets the HTML content to the given text.

Pairs of arguments can be given to set the content in other ways, with the second argument the type, and the first the data (what the data is depends on the type).

Types are: string (default, raw data) file (read content of given filename)

Examples: $this->setBody('Hello world'); $this->setBody('helloworld.html', 'file'); $this->setBody('Prefix', 'string', 'helloworld.html', 'file', 'Postfix', 'string')

When a file is read, the following strings are replaced by their corresponding constants: /dpclient.php, /page/ and /images/

Instead of text or a path, a method to call whenever the body property is requested can be given using an array two elements: an object and a method name. Depending on the type, the method should return text or a path.

Overwrites previous set ids. Ids are case insensitive and all turned into lowercase.

Creates an area for the imagemap $mapName. Make sure the right <map> and <area> HTML is included when this object is viewed. The image should have the following tag: usemap="#<map name>"

The id given with $mapAreaId can be used by others methods, such as addItem or addAction to refer to this area.

The shape of the imagemap given with $mapAreaShape is one of: circle, poly, rect See your HTML reference for a full explanation of these types.

The coordinates of the shape should be given with $mapAreaCoords, for example, the coordinates for a rectangle: 128,132,241,179 See your HTML reference for a full explanation about coordinates.

An optional tooltip can be shown when hovering over this area with the mouse with $mapAreaAlt.

Use this to perform delayed method calls in this object. Note that functions such as get_current_dpuser() can be totally different when the method is called. Also note that the actual delay is not exact science.

This title is used for object labels, page titles, messages, et cetera. Objects are visualized using two mechanisms: the object's "title" and the object's "body". The title is used when the object is nearby, for instance in the environment of a user that sees it. The body is used when we're in the object (a page) or examining the object. In other words, the object's title is a very abstract way to describe the object when looking at it from a greater distance.

In plain language, this function controls the avatar or object image, and the label under it.

The $title should be a short description like "beer" without "a" or "the" in front.

The $title_img should be a URL to the image shown to represent this object.

The second argument, $type, should be a constant as defined in include/title_types.php and is used by the framework to, for example, construct lines such as "Lennert takes a cool, fresh beer" instead of "A Lennert takes a cool fresh, beer" or "The Lennert takes a cool, fresh beer".

DPUNIVERSE_TITLE_TYPE_INDEFINITE - the title is indefinite, "a beer" DPUNIVERSE_TITLE_TYPE_DEFINITE - the title is definite, "the hulk" DPUNIVERSE_TITLE_TYPE_NAME - the title is a name, "Lennert" DPUNIVERSE_TITLE_TYPE_PLURAL - the title is plural, "sweets" (not yet implemented)

Tells a message to this object, for instance a chat line. Handled by by default.