parpg-source: bGrease/impl/mode.py annotate

annotate bGrease/impl/mode.py @ 119:2399a8c3da0c

Modified EquipmentSlot to display an image instead of a text. Added EquipmentGui class, which handles the equipment slots of the player screen. An EquipmentGui instance will be created in the InventoryGUI constructor. The initializeInventory method of the Hud class supplies the players inventory and equipment to the InventoryGUI constructor.

author	KarstenBock@gmx.net
date	Wed, 05 Oct 2011 11:04:39 +0200
parents	e856b604b650
children

rev	line source
65 e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	1 #############################################################################
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	2 #
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	3 # Copyright (c) 2010 by Casey Duncan and contributors
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	4 # All Rights Reserved.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	5 #
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	6 # This software is subject to the provisions of the MIT License
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	7 # A copy of the license should accompany this distribution.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	8 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	9 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	10 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	11 #
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	12 #############################################################################
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	13 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	14 Modes manage the state and transition between different application modes.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	15 Typically such modes are presented as different screens that the user can
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	16 navigate between, similar to the way a browser navigates web pages. Individual
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	17 modes may be things like:
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	18
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	19 - Title screen
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	20 - Options dialog
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	21 - About screen
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	22 - In-progress game
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	23 - Inventory interface
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	24
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	25 The modal framework provides a simple mechanism to ensure that modes are
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	26 activated and deactivated properly. An activated mode is running and receives
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	27 events. A deactivated mode is paused and does not receive events.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	28
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	29 Modes may be managed as a last-in-first-out stack, or as a list, or ring
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	30 of modes in sequence, or some combination of all.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	31
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	32 For example usage see: :ref:`the mode section of the tutorial <tut-mode-section>`.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	33 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	34
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	35 __version__ = '$Id$'
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	36
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	37 import abc
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	38 import pyglet
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	39 from parpg.bGrease.mode import *
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	40
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	41 class PygletManager(BaseManager):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	42 """Mode manager abstract base class using pyglet.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	43
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	44 The mode manager keeps a stack of modes where a single mode
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	45 is active at one time. As modes are pushed on and popped from
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	46 the stack, the mode at the top is always active. The current
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	47 active mode receives events from the manager's event dispatcher.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	48 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	49
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	50 event_dispatcher = None
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	51 """:class:`pyglet.event.EventDispatcher` object that the
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	52 active mode receive events from.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	53 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	54
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	55 def activate_mode(self, mode):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	56 """Perform actions to activate a node
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	57
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	58 :param mode: The :class: 'Mode' object to activate
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	59 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	60 BaseManager.activate_mode(self, mode)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	61 self.event_dispatcher.push_handlers(mode)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	62
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	63 def deactivate_mode(self, mode):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	64 """Perform actions to deactivate a node
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	65
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	66 :param mode: The :class: 'Mode' object to deactivate
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	67 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	68 BaseManager.deactivate_mode(self, mode)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	69 self.event_dispatcher.remove_handlers(mode)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	70
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	71 class Manager(PygletManager):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	72 """A basic mode manager that wraps a single
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	73 :class:`pyglet.event.EventDispatcher` object for use by its modes.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	74 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	75
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	76 def __init__(self, event_dispatcher):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	77 self.modes = []
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	78 self.event_dispatcher = event_dispatcher
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	79
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	80
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	81 class ManagerWindow(PygletManager, pyglet.window.Window):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	82 """An integrated mode manager and pyglet window for convenience.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	83 The window is the event dispatcher used by modes pushed to
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	84 this manager.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	85
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	86 Constructor arguments are identical to :class:`pyglet.window.Window`
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	87 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	88
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	89 def __init__(self, args, *kw):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	90 super(ManagerWindow, self).__init__(args, *kw)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	91 self.modes = []
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	92 self.event_dispatcher = self
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	93
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	94 def on_key_press(self, symbol, modifiers):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	95 """Default :meth:`on_key_press handler`, pops the current mode on ``ESC``"""
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	96 if symbol == pyglet.window.key.ESCAPE:
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	97 self.pop_mode()
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	98
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	99 def on_last_mode_pop(self, mode):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	100 """Hook executed when the last mode is popped from the manager.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	101 When the last mode is popped from a window, an :meth:`on_close` event
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	102 is dispatched.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	103
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	104 :param mode: The :class:`Mode` object just popped from the manager
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	105 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	106 self.dispatch_event('on_close')
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	107
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	108
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	109 class Mode(BaseMode):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	110 """Application mode abstract base class using pyglet
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	111
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	112 Subclasses must implement the :meth:`step` method
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	113
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	114 :param step_rate: The rate of :meth:`step()` calls per second.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	115
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	116 :param master_clock: The :class:`pyglet.clock.Clock` interface used
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	117 as the master clock that ticks the world's clock. This
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	118 defaults to the main pyglet clock.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	119 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	120 clock = None
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	121 """The :class:`pyglet.clock.Clock` instance used as this mode's clock.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	122 You should use this clock to schedule tasks for this mode, so they
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	123 properly respect when the mode is active or inactive
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	124
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	125 Example::
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	126
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	127 my_mode.clock.schedule_once(my_cool_function, 4)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	128 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	129
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	130 def __init__(self, step_rate=60, master_clock=pyglet.clock,
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	131 clock_factory=pyglet.clock.Clock):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	132 BaseMode.__init__(self)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	133 self.step_rate = step_rate
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	134 self.time = 0.0
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	135 self.master_clock = master_clock
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	136 self.clock = clock_factory(time_function=lambda: self.time)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	137 self.clock.schedule_interval(self.step, 1.0 / step_rate)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	138
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	139 def on_activate(self):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	140 """Being called when the Mode is activated"""
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	141 self.master_clock.schedule(self.tick)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	142
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	143 def on_deactivate(self):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	144 """Being called when the Mode is deactivated"""
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	145 self.master_clock.unschedule(self.tick)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	146
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	147 def tick(self, dt):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	148 """Tick the mode's clock.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	149
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	150 :param dt: The time delta since the last tick
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	151 :type dt: float
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	152 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	153 self.time += dt
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	154 self.clock.tick(poll=False)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	155
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	156 @abc.abstractmethod
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	157 def step(self, dt):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	158 """Execute a timestep for this mode. Must be defined by subclasses.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	159
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	160 :param dt: The time delta since the last time step
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	161 :type dt: float
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	162 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	163
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	164 class Multi(BaseMulti, Mode):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	165 """A mode with multiple submodes. One submode is active at one time.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	166 Submodes can be switched to directly or switched in sequence. If
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	167 the Multi is active, then one submode is always active.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	168
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	169 Multis are useful when modes can switch in an order other than
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	170 a LIFO stack, such as in "hotseat" multiplayer games, a
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	171 "wizard" style ui, or a sequence of slides.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	172
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	173 Note unlike a normal :class:`Mode`, a :class:`Multi` doesn't have it's own
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	174 :attr:`clock` and :attr:`step_rate`. The active submode's are used
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	175 instead.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	176 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	177
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	178 def __init__(self, submodes):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	179 BaseMulti.__init__(self, submodes)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	180 self.time = 0.0
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	181
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	182
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	183 def _set_active_submode(self, submode):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	184 BaseMulti._set_active_submode(self, submode)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	185 self.master_clock = submode.master_clock
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	186 self.clock = submode.clock
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	187
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	188 def clear_subnode(self):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	189 """Clear any subnmode data"""
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	190 BaseMulti.clear_subnode(self)
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	191 self.master_clock = None
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	192 self.clock = None
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	193
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	194 def tick(self, dt):
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	195 """Tick the active submode's clock.
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	196
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	197 :param dt: The time delta since the last tick
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	198 :type dt: float
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	199 """
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	200 self.time += dt
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	201 if self.active_submode is not None:
e856b604b650 Changed "import bGrease" to "import parpg.bGrease". KarstenBock@gmx.net parents: 41 diff changeset	202 self.active_submode.clock.tick(poll=False)

Mercurial > parpg-source

annotate bGrease/impl/mode.py @ 119:2399a8c3da0c