Games/lbreakout2/client/hint.h

   1 /***************************************************************************
   2                           hint.h  -  description
   3                              -------------------
   4     begin                : Sun Jan 6 2002
   5     copyright            : (C) 2001 by Michael Speck
   6     email                : kulkanie@gmx.net
   7  ***************************************************************************/
   8
   9 /***************************************************************************
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  ***************************************************************************/
  17
  18 #ifndef __HINT_H
  19 #define __HINT_H
  20
  21 typedef struct {
  22     Text *text; /* contents */
  23     int peek_x, peek_y;
  24     /* screen geometry -- computed when displaying hint */
  25     SDL_Rect rect;
  26 } Hint;
  27
  28 /*
  29 ====================================================================
  30 Load/delete hint resources.
  31 ====================================================================
  32 */
  33 void hint_load_res();
  34 void hint_delete_res();
  35
  36 /*
  37 ====================================================================
  38 Create a hint. The passed x,y position is where the end of the
  39 Sprechblasenspitze is. Contents is converted to lines (duplicated).
  40 ====================================================================
  41 */
  42 Hint* hint_create( int x, int y, char *contents );
  43 void hint_delete( Hint *hint );
  44
  45 /*
  46 ====================================================================
  47 Set the background on which the hints will be displayed.
  48 ====================================================================
  49 */
  50 void hint_set_bkgnd( SDL_Surface *bkgnd );
  51
  52 /*
  53 ====================================================================
  54 Set this hint as actual one. If NULL was passed no hint will be
  55 handled.
  56 ====================================================================
  57 */
  58 void hint_set( Hint *hint );
  59
  60 /*
  61 ====================================================================
  62 Set hint to this position.
  63 ====================================================================
  64 */
  65 void hint_set_pos( Hint *hint, int x, int y );
  66
  67 /*
  68 ====================================================================
  69 Update the contents of a hint.
  70 ====================================================================
  71 */
  72 void hint_set_contents( Hint *hint, char *contents );
  73
  74 /*
  75 ====================================================================
  76 Show/hide/update _current_ hint.
  77 ====================================================================
  78 */
  79 void hint_hide();
  80 void hint_show();
  81 void hint_update( int ms );
  82
  83 #endif