parpg-core: src/parpg/objects/base.py annotate

annotate src/parpg/objects/base.py @ 127:90b49fda0340

saveable_fields property of components is now a List.

author	KarstenBock@gmx.net
date	Tue, 27 Sep 2011 16:27:36 +0200
parents	1fd2201f5c36
children

rev	line source
0 1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	1 # This file is part of PARPG.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	2
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	3 # PARPG is free software: you can redistribute it and/or modify
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	4 # it under the terms of the GNU General Public License as published by
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	5 # the Free Software Foundation, either version 3 of the License, or
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	6 # (at your option) any later version.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	7
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	8 # PARPG is distributed in the hope that it will be useful,
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	11 # GNU General Public License for more details.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	12
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	13 # You should have received a copy of the GNU General Public License
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	14 # along with PARPG. If not, see <http://www.gnu.org/licenses/>.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	15
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	16 """Containes classes defining the base properties of all interactable in-game
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	17 objects (such as Carryable, Openable, etc. These are generally independent
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	18 classes, which can be combined in almost any way and order.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	19
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	20 Some rules that should be followed when CREATING base property classes:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	21
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	22 1. If you want to support some custom initialization arguments,
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	23 always define them as keyword ones. Only GameObject would use
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	24 positional arguments.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	25 2. In __init__() ALWAYS call the parent's __init__(**kwargs), preferably
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	26 at the end of your __init__() (makes it easier to follow)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	27 3. There should always be an attributes.append(x) call on __init__
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	28 (where X is the name of the class)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	29
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	30 EXAMPLE:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	31
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	32 class Openable(object):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	33 def __init__ (self, is_open = True, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	34 self.attribbutes.append("openable")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	35 self.is_open = is_open
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	36 super(Openable,self).__init__ (**kwargs)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	37
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	38
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	39 Some rules are to be followed when USING the base classes to make composed
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	40 ones:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	41
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	42 1. The first parent should always be the base GameObject class
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	43 2. Base classes other than GameObject can be inherited in any order
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	44 3. The __init__ functoin of the composed class should always invoke the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	45 parent's __init__() before it starts customizing any variables.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	46
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	47 EXAMPLE:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	48
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	49 class TinCan (GameObject, Container, Scriptable, Destructable, Carryable):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	50 def __init__ (self, args, *kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	51 super(TinCan,self).__init__ (args, *kwargs)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	52 self.name = 'Tin Can'"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	53
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	54 class BaseObject(object):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	55 """A base class that supports dynamic attributes functionality"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	56 def __init__ (self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	57 if not self.__dict__.has_key("attributes"):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	58 self.attributes = []
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	59
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	60 def trueAttr(self, attr):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	61 """Method that checks if the instance has an attribute"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	62 return attr in self.attributes
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	63
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	64 def getStateForSaving(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	65 """Returns state for saving
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	66 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	67 state = {}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	68 state["attributes"] = self.attributes
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	69 return state
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	70
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	71 class DynamicObject (BaseObject):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	72 """Class with basic attributes"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	73 def __init__ (self, name="Dynamic object", real_name=None, image=None, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	74 """Initialise minimalistic set of data
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	75 @type name: String
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	76 @param name: Object display name
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	77 @type image: String or None
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	78 @param name: Filename of image to use in inventory"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	79 BaseObject.__init__(self)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	80 self.name = name
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	81 self.real_name = real_name or name
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	82 self.image = image
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	83
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	84 def prepareStateForSaving(self, state):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	85 """Prepares state for saving
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	86 @type state: dictionary
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	87 @param state: State of the object
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	88 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	89 pass
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	90
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	91 def restoreState(self, state):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	92 """Restores a state from a saved state
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	93 @type state: dictionary
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	94 @param state: Saved state
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	95 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	96 self.__dict__.update(state)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	97
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	98 def __getstate__(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	99 odict = self.__dict__.copy()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	100 self.prepareStateForSaving(odict)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	101 return odict
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	102
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	103 def __setstate__(self, state):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	104 self.restoreState(state)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	105
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	106 def getStateForSaving(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	107 """Returns state for saving
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	108 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	109 state = BaseObject.getStateForSaving(self)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	110 state["Name"] = self.name
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	111 state["RealName"] = self.real_name
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	112 state["Image"] = self.image
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	113 return state
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	114
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	115 class GameObject (DynamicObject):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	116 """A base class to be inherited by all game objects. This must be the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	117 first class (left to right) inherited by any game object."""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	118 def __init__ (self, ID, gfx = None, xpos = 0.0, ypos = 0.0, map_id = None,
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	119 blocking=True, name="Generic object", real_name="Generic object", text="Item description",
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	120 desc="Detailed description", **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	121 """Set the basic values that are shared by all game objects.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	122 @type ID: String
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	123 @param ID: Unique object identifier. Must be present.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	124 @type gfx: Dictionary
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	125 @param gfx: Dictionary with graphics for the different contexts
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	126 @type coords 2-item tuple
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	127 @param coords: Initial coordinates of the object.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	128 @type map_id: String
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	129 @param map_id: Identifier of the map where the object is located
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	130 @type blocking: Boolean
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	131 @param blocking: Whether the object blocks character movement
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	132 @type name: String
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	133 @param name: The display name of this object (e.g. 'Dirty crate')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	134 @type text: String
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	135 @param text: A longer description of the item
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	136 @type desc: String
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	137 @param desc: A long description of the item that is displayed when it is examined
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	138 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	139 DynamicObject.__init__(self, name, real_name, **kwargs)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	140 self.ID = ID
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	141 self.gfx = gfx or {}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	142 self.X = xpos
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	143 self.Y = ypos
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	144 self.map_id = map_id
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	145 self.blocking = True
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	146 self.text = text
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	147 self.desc = desc
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	148
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	149 def _getCoords(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	150 """Get-er property function"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	151 return (self.X, self.Y)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	152
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	153 def _setCoords(self, coords):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	154 """Set-er property function"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	155 self.X, self.Y = float(coords[0]), float (coords[1])
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	156
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	157 coords = property (_getCoords, _setCoords,
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	158 doc = "Property allowing you to get and set the object's \
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	159 coordinates via tuples")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	160
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	161 def __repr__(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	162 """A debugging string representation of the object"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	163 return "<%s:%s>" % (self.name, self.ID)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	164
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	165 def getStateForSaving(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	166 """Returns state for saving
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	167 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	168 state = super(GameObject, self).getStateForSaving()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	169 state["ObjectModel"] = self.gfx
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	170 state["Text"] = self.text
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	171 state["Desc"] = self.desc
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	172 state["Position"] = list(self.coords)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	173 return state
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	174
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	175
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	176 class Scriptable (BaseObject):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	177 """Allows objects to have predefined parpg executed on certain events"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	178 def __init__ (self, parpg = None, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	179 """Init operation for scriptable objects
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	180 @type parpg: Dictionary
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	181 @param parpg: Dictionary where the event strings are keys. The
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	182 values are 3-item tuples (function, positional_args, keyword_args)"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	183 BaseObject.__init__(self)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	184 self.attributes.append("scriptable")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	185 self.parpg = parpg or {}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	186
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	187 def runScript (self, event):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	188 """Runs the script for the given event"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	189 if event in self.parpg and self.parpg[event]:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	190 func, args, kwargs = self.parpg[event]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	191 func (args, *kwargs)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	192
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	193 def setScript (self, event, func, args = None , kwargs = None):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	194 """Sets a script to be executed for the given event."""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	195 args = args or {}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	196 kwargs = kwargs or {}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	197 self.parpg[event] = (func, args, kwargs)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	198
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	199 class Openable(DynamicObject, Scriptable):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	200 """Adds open() and .close() capabilities to game objects
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	201 The current state is tracked by the .is_open variable"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	202 def __init__(self, is_open = True, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	203 """Init operation for openable objects
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	204 @type is_open: Boolean
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	205 @param is_open: Keyword boolean argument sets the initial state."""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	206 DynamicObject.__init__(self, **kwargs)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	207 Scriptable.__init__(self, **kwargs)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	208 self.attributes.append("openable")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	209 self.is_open = is_open
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	210
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	211 def open(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	212 """Opens the object, and runs an 'onOpen' script, if present"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	213 self.is_open = True
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	214 try:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	215 if self.trueAttr ('scriptable'):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	216 self.runScript('onOpen')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	217 except AttributeError :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	218 pass
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	219
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	220 def close(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	221 """Opens the object, and runs an 'onClose' script, if present"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	222 self.is_open = False
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	223 try:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	224 if self.trueAttr ('scriptable'):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	225 self.runScript('onClose')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	226 except AttributeError :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	227 pass
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	228
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	229 class Lockable (Openable):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	230 """Allows objects to be locked"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	231 def __init__ (self, locked = False, is_open = True, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	232 """Init operation for lockable objects
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	233 @type locked: Boolean
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	234 @param locked: Keyword boolen argument sets the initial locked state.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	235 @type is_open: Boolean
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	236 @param is_open: Keyword boolean argument sets the initial open state.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	237 It is ignored if locked is True -- locked objects
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	238 are always closed."""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	239 self.attributes.append("lockable")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	240 self.locked = locked
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	241 if locked :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	242 is_open = False
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	243 Openable.__init__( self, is_open, **kwargs )
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	244
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	245 def unlock (self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	246 """Handles unlocking functionality"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	247 self.locked = False
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	248
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	249 def lock (self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	250 """Handles locking functionality"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	251 self.close()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	252 self.locked = True
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	253
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	254 def open (self, args, *kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	255 """Adds a check to see if the object is unlocked before running the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	256 .open() function of the parent class"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	257 if self.locked:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	258 raise ValueError ("Open failed: object locked")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	259 super (Lockable, self).open(args, *kwargs)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	260
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	261 class Carryable (DynamicObject):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	262 """Allows objects to be stored in containers"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	263 def __init__ (self, weight=0.0, bulk=0.0, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	264 DynamicObject.__init__(self, **kwargs)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	265 self.attributes.append("carryable")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	266 self.in_container = None
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	267 self.on_map = None
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	268 self.agent = None
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	269 self.weight = weight
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	270 self.bulk = bulk
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	271
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	272 def getInventoryThumbnail(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	273 """Returns the inventory thumbnail of the object"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	274 # TODO: Implement properly after the objects database is in place
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	275 if self.image == None:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	276 return "gui/inv_images/inv_litem.png"
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	277 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	278 return self.image
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	279
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	280 class Container (DynamicObject, Scriptable):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	281 """Gives objects the capability to hold other objects"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	282 class TooBig(Exception):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	283 """Exception to be raised when the object is too big
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	284 to fit into container"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	285 pass
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	286
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	287 class SlotBusy(Exception):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	288 """Exception to be raised when the requested slot is occupied"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	289 pass
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	290
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	291 class ItemSelf(Exception):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	292 """Exception to be raised when trying to add the container as an item"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	293 pass
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	294
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	295 def __init__ (self, capacity = 0, items = None, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	296 DynamicObject.__init__(self, **kwargs)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	297 Scriptable.__init__(self, **kwargs)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	298 self.attributes.append("container")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	299 self.items = {}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	300 self.capacity = capacity
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	301 if items:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	302 for item in items:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	303 self.placeItem(item)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	304
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	305 def placeItem (self, item, index=None):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	306 """Adds the provided carryable item to the inventory.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	307 Runs an 'onStoreItem' script, if present"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	308 if item is self:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	309 raise self.ItemSelf("Paradox: Can't contain myself")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	310 if not item.trueAttr ('carryable'):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	311 raise TypeError ('%s is not carryable!' % item)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	312 if self.capacity and self.getContentsBulk()+item.bulk > self.capacity:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	313 raise self.TooBig ('%s is too big to fit into %s' % (item, self))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	314 item.in_container = self
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	315 if index == None:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	316 self._placeAtVacant(item)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	317 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	318 if index in self.items :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	319 raise self.SlotBusy('Slot %d is busy in %s' % (index,
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	320 self.name))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	321 self.items[index] = item
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	322
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	323 # Run any parpg associated with storing an item in the container
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	324 try:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	325 if self.trueAttr ('scriptable'):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	326 self.runScript('onPlaceItem')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	327 except AttributeError :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	328 pass
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	329
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	330 def _placeAtVacant(self, item):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	331 """Places an item at a vacant slot"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	332 vacant = None
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	333 for i in range(len(self.items)):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	334 if i not in self.items :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	335 vacant = i
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	336 if vacant == None :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	337 vacant = len(self.items)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	338 self.items[vacant] = item
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	339
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	340 def takeItem (self, item):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	341 """Takes the listed item out of the inventory.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	342 Runs an 'onTakeItem' script"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	343 if not item in self.items.values():
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	344 raise ValueError ('I do not contain this item: %s' % item)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	345 del self.items[self.items.keys()[self.items.values().index(item)]]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	346
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	347 # Run any parpg associated with popping an item out of the container
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	348 try:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	349 if self.trueAttr ('scriptable'):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	350 self.runScript('onTakeItem')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	351 except AttributeError :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	352 pass
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	353
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	354 def replaceItem(self, old_item, new_item):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	355 """Replaces the old item with the new one
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	356 @param old_item: Old item which is removed
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	357 @type old_item: Carryable
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	358 @param new_item: New item which is added
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	359 @type new_item: Carryable
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	360 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	361 old_index = self.indexOf(old_item.ID)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	362 self.removeItem(old_item)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	363 self.placeItem(new_item, old_index)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	364
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	365 def removeItem(self, item):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	366 """Removes an item from the container, basically the same as 'takeItem'
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	367 but does run a different script. This should be used when an item is
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	368 destroyed rather than moved out.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	369 Runs 'onRemoveItem' script
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	370 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	371 if not item in self.items.values():
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	372 raise ValueError ('I do not contain this item: %s' % item)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	373 del self.items[self.items.keys()[self.items.values().index(item)]]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	374
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	375 # Run any parpg associated with popping an item out of the container
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	376 try:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	377 if self.trueAttr ('scriptable'):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	378 self.runScript('onRemoveItem')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	379 except AttributeError :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	380 pass
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	381
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	382 def count (self, item_type = ""):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	383 """Returns the number of items"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	384 if item_type:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	385 ret_count = 0
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	386 for index in self.items :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	387 if self.items[index].item_type == item_type:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	388 ret_count += 1
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	389 return ret_count
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	390 return len(self.items)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	391
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	392 def getContentsBulk(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	393 """Bulk of the container contents"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	394 return sum((item.bulk for item in self.items.values()))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	395
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	396 def getItemAt(self, index):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	397 return self.items[index]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	398
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	399 def indexOf(self, ID):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	400 """Returns the index of the item with the passed ID"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	401 for index in self.items :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	402 if self.items[index].ID == ID:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	403 return index
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	404 return None
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	405
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	406 def findItemByID(self, ID):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	407 """Returns the item with the passed ID"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	408 for i in self.items :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	409 if self.items[i].ID == ID:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	410 return self.items[i]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	411 return None
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	412
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	413 def findItemByItemType(self, item_type):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	414 """Returns the item with the passed item_type"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	415 for index in self.items :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	416 if self.items[index].item_type == item_type:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	417 return self.items[index]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	418 return None
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	419
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	420 def findItem(self, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	421 """Find an item in container by attributes. All params are optional.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	422 @type name: String
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	423 @param name: If the name is non-unique, return first matching object
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	424 @type kind: String
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	425 @param kind: One of the possible object types
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	426 @return: The item matching criteria or None if none was found"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	427 for index in self.items :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	428 if "name" in kwargs and self.items[index].name != kwargs["name"]:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	429 continue
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	430 if "ID" in kwargs and self.items[index].ID != kwargs["ID"]:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	431 continue
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	432 if "kind" in kwargs and not self.items[index].trueAttr(kwargs["kind"]):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	433 continue
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	434 if "item_type" in kwargs and self.items[index].item_type != kwargs["item_type"]:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	435 continue
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	436 return self.items[index]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	437 return None
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	438
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	439 def serializeItems(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	440 """Returns the items as a list"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	441 items = []
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	442 for index, item in self.items.iteritems():
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	443 item_dict = item.getStateForSaving()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	444 item_dict["index"] = index
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	445 item_dict["type"] = item.item_type
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	446 items.append(item_dict)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	447 return items
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	448
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	449 def getStateForSaving(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	450 """Returns state for saving
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	451 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	452 ret_state = DynamicObject.getStateForSaving(self)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	453 ret_state["Items"] = self.serializeItems()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	454 return ret_state
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	455
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	456 class Living (BaseObject):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	457 """Objects that 'live'"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	458 def __init__ (self, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	459 BaseObject.__init__(self)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	460 self.attributes.append("living")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	461 self.lives = True
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	462
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	463 def die(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	464 """Kills the object"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	465 self.lives = False
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	466
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	467 class CharStats (BaseObject):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	468 """Provides the object with character statistics"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	469 def __init__ (self, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	470 BaseObject.__init__(self)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	471 self.attributes.append("charstats")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	472
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	473 class Wearable (BaseObject):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	474 """Objects than can be weared"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	475 def __init__ (self, slots, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	476 """Allows the object to be worn somewhere on the body (e.g. pants)"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	477 BaseObject.__init__(self)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	478 self.attributes.append("wearable")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	479 if isinstance(slots, tuple) :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	480 self.slots = slots
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	481 else :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	482 self.slots = (slots,)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	483
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	484 class Usable (BaseObject):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	485 """Allows the object to be used in some way (e.g. a Zippo lighter
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	486 to make a fire)"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	487 def __init__ (self, actions = None, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	488 BaseObject.__init__(self)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	489 self.attributes.append("usable")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	490 self.actions = actions or {}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	491
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	492 class Weapon (BaseObject):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	493 """Allows the object to be used as a weapon"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	494 def __init__ (self, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	495 BaseObject.__init__(self)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	496 self.attributes.append("weapon")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	497
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	498 class Destructable (BaseObject):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	499 """Allows the object to be destroyed"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	500 def __init__ (self, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	501 BaseObject.__init__(self)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	502 self.attributes.append("destructable")
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	503
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	504 class Trapable (BaseObject):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	505 """Provides trap slots to the object"""
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	506 def __init__ (self, **kwargs):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	507 BaseObject.__init__(self)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	508 self.attributes.append("trapable")

Mercurial > parpg-core

annotate src/parpg/objects/base.py @ 127:90b49fda0340