parpg :: objects :: containers :: Footlocker :: Class Footlocker
[hide private]
[frames] | no frames]

Class Footlocker

source code

         object --+                
                  |                
    base.BaseObject --+            
                      |            
     base.DynamicObject --+        
                          |        
            base.GameObject --+    
                              |    
         object --+           |    
                  |           |    
    base.BaseObject --+       |    
                      |       |    
     base.DynamicObject --+   |    
                          |   |    
         object --+       |   |    
                  |       |   |    
    base.BaseObject --+   |   |    
                      |   |   |    
        base.Scriptable --+   |    
                          |   |    
             base.Container --+    
                              |    
     object --+               |    
              |               |    
base.BaseObject --+           |    
                  |           |    
 base.DynamicObject --+       |    
                      |       |    
     object --+       |       |    
              |       |       |    
base.BaseObject --+   |       |    
                  |   |       |    
    base.Scriptable --+       |    
                      |       |    
          base.Openable --+   |    
                          |   |    
              base.Lockable --+    
                              |    
             object --+       |    
                      |       |    
        base.BaseObject --+   |    
                          |   |    
            base.Scriptable --+    
                              |    
             object --+       |    
                      |       |    
        base.BaseObject --+   |    
                          |   |    
              base.Trapable --+    
                              |    
             object --+       |    
                      |       |    
        base.BaseObject --+   |    
                          |   |    
          base.Destructable --+    
                              |    
    composed.ImmovableContainer --+
                                  |
                                 Footlocker

Nested Classes [hide private]

Inherited from base.Container: ItemSelf, SlotBusy, TooBig

Instance Methods [hide private]
 
__init__(self, object_id, agent_layer=None, name='Footlocker', text='A Footlocker', gfx='lock_box_metal01', **kwargs)
Set the basic values that are shared by all game objects.
source code
 
prepareStateForSaving(self, state)
Prepares state for saving
source code
 
createBehaviour(self, layer) source code
 
setup(self)
Returns: None
source code
 
open(self)
Adds a check to see if the object is unlocked before running the .open() function of the parent class
source code
 
close(self)
Opens the object, and runs an 'onClose' script, if present
source code

Inherited from base.GameObject: __repr__, getStateForSaving

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

Inherited from base.Container: count, findItem, findItemByID, findItemByItemType, getContentsBulk, getItemAt, indexOf, placeItem, removeItem, replaceItem, serializeItems, takeItem

Inherited from base.Container (private): _placeAtVacant

Inherited from base.Lockable: lock, unlock

Inherited from base.DynamicObject: __getstate__, __setstate__, restoreState

Inherited from base.Scriptable: runScript, setScript

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, object_id, agent_layer=None, name='Footlocker', text='A Footlocker', gfx='lock_box_metal01', **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

setup(self)

source code 
Returns:
None

open(self)

source code 

Adds a check to see if the object is unlocked before running the .open() function of the parent class

Overrides: base.Openable.open
(inherited documentation)

close(self)

source code 

Opens the object, and runs an 'onClose' script, if present

Overrides: base.Openable.close
(inherited documentation)