Package parpg :: Package objects :: Module composed :: Class CarryableItem
[hide private]
[frames] | no frames]

Class CarryableItem

source code

     object --+            
              |            
base.BaseObject --+        
                  |        
 base.DynamicObject --+    
                      |    
        base.GameObject --+
                          |
     object --+           |
              |           |
base.BaseObject --+       |
                  |       |
 base.DynamicObject --+   |
                      |   |
         base.Carryable --+
                          |
         object --+       |
                  |       |
    base.BaseObject --+   |
                      |   |
            base.Usable --+
                          |
                         CarryableItem

Composite class that will be used for all carryable items

Instance Methods [hide private]
 
__init__(self, item_type, **kwargs)
Set the basic values that are shared by all game objects.
source code
 
prepareStateForSaving(self, state)
Prepares state for saving
source code
 
getStateForSaving(self)
Returns state for saving
source code

Inherited from base.GameObject: __repr__

Inherited from base.GameObject (private): _getCoords, _setCoords

Inherited from base.Carryable: getInventoryThumbnail

Inherited from base.DynamicObject: __getstate__, __setstate__, restoreState

Inherited from base.BaseObject: trueAttr

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]

Inherited from base.GameObject: coords

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, item_type, **kwargs)
(Constructor)

source code 

Set the basic values that are shared by all game objects.

Parameters:
  • ID - Unique object identifier. Must be present.
  • gfx - Dictionary with graphics for the different contexts @type coords 2-item tuple
  • coords - Initial coordinates of the object.
  • map_id - Identifier of the map where the object is located
  • blocking - Whether the object blocks character movement
  • name - The display name of this object (e.g. 'Dirty crate')
  • text - A longer description of the item
  • desc - A long description of the item that is displayed when it is examined
Overrides: object.__init__
(inherited documentation)

prepareStateForSaving(self, state)

source code 

Prepares state for saving

Parameters:
  • state (dictionary) - State of the object
Overrides: base.DynamicObject.prepareStateForSaving

getStateForSaving(self)

source code 

Returns state for saving

Parameters:
  • state (dictionary) - State of the object
Overrides: base.BaseObject.getStateForSaving