src/player.h

   1 /***************************************
   2 ** Tsunagari Tile Engine              **
   3 ** player.h                           **
   4 ** Copyright 2011-2013 PariahSoft LLC **
   5 ***************************************/
   6
   7 // **********
   8 // Permission is hereby granted, free of charge, to any person obtaining a copy
   9 // of this software and associated documentation files (the "Software"), to
  10 // deal in the Software without restriction, including without limitation the
  11 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  12 // sell copies of the Software, and to permit persons to whom the Software is
  13 // furnished to do so, subject to the following conditions:
  14 //
  15 // The above copyright notice and this permission notice shall be included in
  16 // all copies or substantial portions of the Software.
  17 //
  18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  24 // IN THE SOFTWARE.
  25 // **********
  26
  27 #ifndef PLAYER_H
  28 #define PLAYER_H
  29
  30 #include <vector>
  31
  32 #include "character.h"
  33
  34 class Player : public Character
  35 {
  36 public:
  37         Player();
  38         bool init(const std::string& descriptor, const std::string& initialPhase);
  39         void destroy();
  40
  41         //! Smooth continuous movement.
  42         void startMovement(ivec2 delta);
  43         void stopMovement(ivec2 delta);
  44
  45         //! Move the player by dx, dy. Not guaranteed to be smooth if called
  46         //! on each update().
  47         void moveByTile(ivec2 delta);
  48
  49         //! Try to use an object in front of the player.
  50         void useTile();
  51
  52         void setFrozen(bool b);
  53
  54 protected:
  55         void postMove();
  56
  57         void takeExit(Exit* exit);
  58
  59 private:
  60         //! Stores intent to move continuously in some direction.
  61         ivec2 velocity;
  62
  63         //! Stack storing depressed keyboard keys in the form of movement
  64         //! vectors.
  65         std::vector<ivec2> movements;
  66 };
  67
  68 #endif
  69