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

Chapters
Introduction
Installation - Requirements
Installation - *NIX
Installation - Windows
A world populated with objects
Inner workings of DutchPIPE
Important Concepts
DutchPIPE Jargon
Message System
Property System
Action System
Translations
DutchPIPE Issues

Class Tutorials
DpNpc
DpPage
DpUniverse
DpObject

File/Class Source Reference
config
dpuniverse_include
dpuniverse_npc
dpuniverse_obj
dpuniverse_page
dpuniverse_std
lib
public
script
scripts


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

Class: DpDrink

SOURCE LOCATION:  /dpuniverse/std/DpDrink.php

Class Overview
Class Overview | Inherits | Methods Summary | Methods Detail

A common drink which can be turned into beers, wine, etc.

Creates the following DutchPIPE properties:

  • boolean isFull - Set to TRUE
  • boolean isDrink - Set to TRUE
  • boolean isNoSell - Set to TRUE
  • string emptyTitle - Title for empty drink
  • string emptyTitleDefinite - Definite title for empty drink
  • string emptyTitleIndefinite - Indefinite title for empty drink
  • string emptyTitleImg - Image for empty drink
  • array emptyIds - Id strings for empty drink
  • array origIds - Id strings for filled drink
  • string origTitle - Title for filled drink
  • string origTitleImg - Image for filled drink
  • string origBody - Body for filled drink

DpProperties
   |
   --DpObject
      |
      --DpDrink
LOCATED IN:  /dpuniverse/std/DpDrink.php [line 54]
SEE:  DpObject
AUTHOR(S):   Lennert Stock <ls@dutchpipe.org>
LINK:  http://dutchpipe.org/manual/package/DutchPIPE
VERSION:  Release: 0.2.1
LICENSE:  DutchPIPE License
COPYRIGHT:  2006, 2007 Lennert Stock
 METHODS:

Inherits
Class Overview | | Inherits | Methods Summary | Methods Detail

Inherited Methods

INHERITED FROM:  DpObject
void   DpObject::addAction()   Adds an action to the object
void   DpObject::addId()   Adds one or more ids for this object
void   DpObject::addItem()   Adds an examinable 'item' to this object
void   DpObject::addMapAreaAction()   Adds an action to a map area so it becomes clickable there
void   DpObject::addValidClientCall()   Makes the given method callable from the DutchPIPE client
void   DpObject::createDpObject()   Sets this object up at the time it is created
void   DpObject::event()   Reports an event
void   DpObject::eventDpObject()   Reports an event
array   DpObject::getActionData()   Gets data of one, multiple or all actions
void   DpObject::getActionsMenu()   Tells the current user the HTML with the action menu for this object
string   DpObject::getAppearance()   Gets the HTML "appearance" of this object
string   DpObject::getAppearanceInventory()   Gets the HTML "appearance" of all objects in this object's inventory
string   DpObject::getAppearanceTitle()   Gets the graphical appearance in HTML for this object
string   DpObject::getBody()   Gets the HTML content of this object
int|float   DpObject::getCredits()   Gets the amount of credits in the inventory of this object
mixed   DpObject::getEnvironment()   Gets the object reference to the environment of this object
int|float   DpObject::getHeapAmount()   Gets the amount of a given heap object
array   DpObject::getIds()   Gets the array of ids for this object, or an empty array for no ids
array   DpObject::getInventory()   Gets an array with object references to all objects in our inventory
array   DpObject::getItem()   Gets an array with data about an item
mixed   DpObject::getItemDescription()   Gets the description of a given item
array   DpObject::getItems()   Gets an array with all item data added to this object
mixed   DpObject::getMapArea()   Gets data of one, multiple or all imagemap areas
array   DpObject::getMapAreaActions()   Gets all map area actions for all areas or for a given area
string   DpObject::getMapAreaHtml()   Gets HTML for all imagemaps or the given imagemap for inclusion in page
string   DpObject::getNavigationTrailHtml()   Gets a HTML navigation trail for this object
array   DpObject::getTargettedActions()   Gets actions which can be performed on this object, for action menu
string   DpObject::getTitle()   Gets the object's title with optional prefixes such as 'a' and 'the'
mixed   DpObject::getTitleImgHeight()   Gets the height in pixels of the title image
mixed   DpObject::getTitleImgWidth()   Gets the width in pixels of the title image
void   DpObject::handleCleanUp()   Called by the universe object, checks if this object can be removed.
boolean   DpObject::isDraggable()   Can we be dragged on the screen by the given user?
boolean   DpObject::isId()   Checks if the given id is a valid id for this object
boolean   DpObject::isPresent()   Checks if an object is present in this object's inventory
boolean   DpObject::isValidClientCall()   May the given method be called in this object from the DutchPIPE client?
void   DpObject::makePresent()   Makes sure an object is present in this object's inventory
int   DpObject::moveDpObject()   Moves this object into the inventory of another object
boolean   DpObject::performActionSubject()   Tries if a user action can be performed on this object
void   DpObject::removeAction()   Removes the given action.
void   DpObject::removeDpObject()   Removes this object from the universe
void   DpObject::removeId()   Removes one or more ids for this object
void   DpObject::removeMapAreaAction()   Removes a map area action
void   DpObject::removeValidClientCall()   Removes the given method from callable methods from the DutchPIPE client
void   DpObject::reportMove()   Reports graphical movement of this object to other objects
void   DpObject::resetDpObject()   Resets this object
void   DpObject::setBody()   Sets the HTML content of this object
boolean   DpObject::setCredits()   Sets the amount of credits in the inventory of this object
boolean   DpObject::setHeapAmount()   Sets a heap object of a given amount in this object
void   DpObject::setIds()   Sets an array of names used to refer to this object
void   DpObject::setMapArea()   Creates a new imagemap area which can be used by actions
void   DpObject::setTimeout()   Calls the given method after the given number of seconds
void   DpObject::setTitle()   Sets the title for this object, "beer", used for object labels, etc.
void   DpObject::tell()   Tells data (message, window, location, ...) to this object
void   DpObject::__destruct()   Called by PHP when this object is destroyed, handles events

INHERITED FROM:  DpProperties
void   DpProperties::coinherit()   "Coinherit" a class located at the given pathname
mixed   DpProperties::getDpProperty()   Directly retrieve the value of an existing DutchPIPE property
boolean   DpProperties::isDpProperty()   Determines if a property is defined in this object
void   DpProperties::removeDpProperties()   Removes properties and coinherits
void   DpProperties::setDpProperty()   Directly set the value of an existing DutchPIPE property
void   DpProperties::__call()   Handles set and get methods for properties using PHP member overloading
mixed   DpProperties::__get()   Gets the value of a DutchPIPE property using PHP member overloading
boolean   DpProperties::__isset()   Determines if a property is defined in this object using PHP member overloading
void   DpProperties::__set()   Sets the value of a DutchPIPE property using PHP member overloading
void   DpProperties::__unset()   Unsets the given DutchPIPE property using PHP member overloading

Methods Summary
Class Overview | Inherits | Methods Summary | Methods Detail

boolean   actionDrink()   Makes a living object drink this object
void   createDpDrink()   Sets this drink object up at the time it is created
void   resetDpDrink()   Resets this drink object
void   setFull()   Fill or empty the drink

Methods
Class Overview | Inherits | | Methods Summary | Methods Detail

actionDrink  [line 208]
boolean actionDrink( string $verb , string $noun   )

Makes a living object drink this object

Drinks the drink if $noun is a valid id for this drink and the drink is "full".


PARAMETERS: string   $verb  the action, "drink"
string   $noun  what to drink, could be empty
RETURNS:  boolean  TRUE for action completed, FALSE otherwise
ACCESS:  public
createDpDrink  [line 129]
void createDpDrink( )

Sets this drink object up at the time it is created

An empty function which can be redefined by the drink object extending on DpDrink. When the object is created, it has no title, HTML body, et cetera, so in this method methods like DpObject::setTitle() are called.


resetDpDrink  [line 159]
void resetDpDrink( )

Resets this drink object

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


setFull  [line 175]
void setFull( [string $isFull = TRUE]   )

Fill or empty the drink

Adjusts the drink's appearance and behaviour. Without an argument, fills the drink. Drink objects are filled by default after being created.

Drink objects which are filled have the property "isFull" set to TRUE in them.


PARAMETERS: string   $isFull  TRUE to fill, FALSE to empty drink
ACCESS:  public
Documentation generated on Mon, 03 Sep 2007 22:19:14 +0200 by phpDocumentor 1.3.0RC6

Click me!
Guest#1800
 
 
 
  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.