snowballs2/client/src/animation.h

   1 // NeL - MMORPG Framework <http://dev.ryzom.com/projects/nel/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef ANIMATION_H
  18 #define ANIMATION_H
  19
  20 namespace SBCLIENT {
  21
  22 //
  23 // External definitions
  24 //
  25
  26 class CEntity;
  27
  28 //
  29 // External variables
  30 //
  31
  32 // Animation id used by playAnimation()
  33 enum EAnim { NoAnim = -1, PrepareWalkAnim, WalkAnim, IdleAnim, LogInAnim, LogOffAnim, ThrowSnowball, PrepareSnowBall, PrepareSnowBallCycle, HitAnim };
  34
  35 //
  36 // External functions
  37 //
  38
  39 // This function is automatically called by playAnimation() the first time
  40 void    createAnimation (CEntity &entity);
  41
  42 // Change the animation of an entity. You have to give the animation id
  43 void    playAnimation (CEntity &entity, EAnim anim,  bool force = false);
  44
  45 // This function must be called before releasing the entity to delete the entity animation
  46 void    deleteAnimation (CEntity &entity);
  47
  48 void    initAnimation ();
  49 void    updateAnimation ();
  50 void    releaseAnimation ();
  51
  52 } /* namespace SBCLIENT */
  53
  54 #endif // ANIMATION_H
  55
  56 /* End of animation.h */