Door¶
-
class
gamelib.Structures.
Door
(**kwargs)¶ A Door is a
GenericStructure
that is not pickable, overlappable and restorable. It has a value of 0 and a size of 1 by default. It is an helper class that allows to focus on game design and mechanics instead of small building blocks.Parameters: - model (str) – The model that will represent the door on the map
- value (int) – The value of the door, it is useless in that case. The default value is 0.
- size (str) – The size of the door. Unless you make the door pickable (I have no idea why you would do that…), this parameter is not used.
- type (str) – The type of the door. It is often used as a type identifier for your game main loop. For example: unlocked_door or locked_door.
- pickable (Boolean) – Is this door pickable by the player? Default value is False.
- overlappable (Boolean) – Is this door overlappable by the player? Default value is True.
- restorable (Boolean) – Is this door restorable after being overlapped? Default value is True.
Note
All the options from
GenericStructure
are also available to this constructor.Example:
door1 = Door(model=Sprites.DOOR,type='locked_door')
-
__init__
(**kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__
(**kwargs)Initialize self. can_move
()Return the capability of moving of an item. debug_info
()Return a string with the list of the attributes and their current value. display
()Print the model WITHOUT carriage return. overlappable
()This represent the capacity for a BoardItem
to be overlapped by player or NPC.pickable
()This represent the capacity for a BoardItem to be picked-up by player or NPC. restorable
()This represent the capacity for an Immovable
BoardItem
(in this case a GenericStructure item) to be restored by the board if the item is overlappable and has been overlapped by anotherMovable
item.set_overlappable
(val)Make the structure overlappable or not. set_pickable
(val)Make the structure pickable or not. set_restorable
(val)Make the structure restorable or not. size
()Return the size of the Immovable Item. store_position
(row, column)Store the BoardItem position for self access.