Class: Mobile

Welcome Guest#2675 Login/register

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

dpserver-ini.php

dpuniverse-ini.php

dpuniverse_include

actions.php

events.php

mass.php

move.php

title_types.php

dpuniverse_npc

barkeeper.php: Barkeeper

drunk.php: Drunk

mobile.php: Mobile

shopkeeper.php: Shopkeeper

dpuniverse_obj

credits.php: Credits

note.php: Note

dpuniverse_page

about.php: About

alley.php: Alley

alley2.php: Alley2

bar.php: Bar

faq.php: FAQ

freemovement.php: Freemovement

house.php: House

index.php: Index

shop.php: Shop

showcases.php: Showcases

square.php: Square

store.php: Store

dpuniverse_std

DpDrink.php: DpDrink

DpHeap.php: DpHeap

DpLiving.php: DpLiving

DpNpc.php: DpNpc

DpObject.php: DpObject

DpPage.php: DpPage

DpProperties.php: DpProperties

DpUser.php: DpUser

mass.php: Mass

lib

dpclient.php

dpcurrentrequest.php

dpdb_mdb2.php

dpdb_mysql.php

dpfunctions.php

dpmbstring_disabled.php

dpmbstring_enabled.php

dpserver.php: DpServer

dptemplates.php

dptext.php

dpuniverse.php: DpUniverse

public

dpcaptcha.php

dpclient-js-src.php

dpclient-js.php

dpclient.php

script

make_captcha.php

start_dpserver.php

scripts

setupdb.php

Class: Mobile

SOURCE LOCATION: /dpuniverse/npc/mobile.php

Class Overview

A mobile computer generated character

Creates the following DutchPIPE properties:

boolean isSilent - Set to FALSE
boolean isNoCleanUp - Set to TRUE

DpProperties
   |
   --DpObject
      |
      --DpLiving
         |
         --DpNpc
            |
            --Mobile

LOCATED IN:	/dpuniverse/npc/mobile.php [line 49]
SEE:	DpNpc
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

Inherited Methods

INHERITED FROM: DpNpc

void	DpNpc::createDpNpc()	Sets this NPC up at the time it is created
void	DpNpc::eventDpLiving()
void	DpNpc::eventDpNpc()
void	DpNpc::resetDpNpc()	Resets this NPC
void	DpNpc::tell()	Tells data (message, window, location, ...) to this NPC

INHERITED FROM: DpLiving

boolean	DpLiving::actionCheer()	Makes this living object cheer wildly
boolean	DpLiving::actionDance()	Makes this living object take another living object for a dance
boolean	DpLiving::actionDrop()	Drops an object in the user's environment
boolean	DpLiving::actionEmote()	Makes this living object communicate a custom message to its environment
boolean	DpLiving::actionExamine()	Makes this living object examine an object
boolean	DpLiving::actionGive()	Makes this living object give an object to another living object
boolean	DpLiving::actionGrin()	Makes this living object grin evilly
boolean	DpLiving::actionHighFive()	Makes this living object slap a high-five with another living object
boolean	DpLiving::actionHug()	Makes this living object hug another living object
boolean	DpLiving::actionInventory()	Shows this living object a list of objects it is carrying
boolean	DpLiving::actionKiss()	Makes this living object give another living object a passionate kiss
boolean	DpLiving::actionLaugh()	Makes this living object fall down on the floor laughing
boolean	DpLiving::actionNod()	Makes this living object nod solemnly
boolean	DpLiving::actionPat()	Makes this living object pat another living object on the head
boolean	DpLiving::actionSay()	Makes this living object say something
boolean	DpLiving::actionShout()	Makes this living object shout something to everyone on the site
boolean	DpLiving::actionShrug()	Makes this living object shrug
boolean	DpLiving::actionSmile()	Makes this living object smile happily
boolean	DpLiving::actionTake()	Makes this living object take an object
boolean	DpLiving::actionTell()	Makes this living object tell something to another user object
void	DpLiving::createDpLiving()	Sets this living object up at the time it is created
void	DpLiving::eventDpLiving()	Reports an event
void	DpLiving::eventDpObject()	Reports an event
string	DpLiving::getActionOperantMenu()	Completes the give action performed by clicking on an object
void	DpLiving::getEmotionsMenu()
void	DpLiving::getMenuGiveAuth()
void	DpLiving::getMenuGiveLabel()
void	DpLiving::getMenuTellAuth()
string	DpLiving::getSessionAge()	Gets the livings's age since it was created as an object in a string
void	DpLiving::getTellOperant()
void	DpLiving::getVolumeCarry()
void	DpLiving::getWeightCarry()
boolean	DpLiving::performAction()	Tries to perform the action given by the living object
void	DpLiving::resetDpLiving()	Resets this living object
void	DpLiving::timeoutHeartBeat()	Calls itself every "heartbeat"

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

boolean	actionKick()	Gives the mobile a good hard kick!
boolean	actionSilence()	Toggles between silent/talking&moving mode, admininistators only
void	createDpNpc()	Sets up the NPC at object creation time
void	randomWalk()	Leaves through a random link
void	timeoutHeartBeat()	Called each 'heartbeat', randomly chat and wander
void	timeoutKicked()	Makes the mobile complain and take a random exit

Methods

actionKick [line 163]

boolean actionKick(
                string
    $verb        ,     string
    $noun         
    )

Gives the mobile a good hard kick!

PARAMETERS:	string	$verb	the action, "kick"
PARAMETERS:	string	$noun	who to kick, could be empty
RETURNS:	boolean	TRUE for action completed, FALSE otherwise

actionSilence [line 217]

boolean actionSilence(
                string
    $verb        ,     string
    $noun         
    )

Toggles between silent/talking&moving mode, admininistators only

PARAMETERS:	string	$verb	the action, "silence!"
PARAMETERS:	string	$noun	who to silence, could be empty
RETURNS:	boolean	TRUE for action completed, FALSE otherwise

createDpNpc [line 59]

void createDpNpc(
    )

Sets up the NPC at object creation time

ACCESS:	public
REDEFINITION OF:	DpNpc::createDpNpc(): Sets this NPC up at the time it is created

randomWalk [line 130]

void randomWalk(
    )

Leaves through a random link

timeoutHeartBeat [line 91]

void timeoutHeartBeat(
    )

Called each 'heartbeat', randomly chat and wander

REDEFINITION OF:

DpLiving::timeoutHeartBeat(): Calls itself every "heartbeat"

timeoutKicked [line 203]

void timeoutKicked(
    )

Makes the mobile complain and take a random exit

Documentation generated on Mon, 03 Sep 2007 22:22:06 +0200 by phpDocumentor 1.3.0RC6

Guest#2675