ryzom/client/src/interfaces_manager/interf_script.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   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
  18
  19 #ifndef CL_INTERF_SCRIPT_H
  20 #define CL_INTERF_SCRIPT_H
  21
  22
  23 /////////////
  24 // Include //
  25 /////////////
  26 #include "nel/misc/types_nl.h"
  27 #include "nel/misc/rgba.h"
  28 // Client.
  29 #include "control.h"
  30 #include "osd.h"
  31 #include "button_base.h"
  32 // std
  33 #include <vector>
  34
  35 #define _MAX_LINE_SIZE 512
  36
  37 ///////////
  38 // Using //
  39 ///////////
  40 using NLMISC::CRGBA;
  41
  42
  43 //////////////
  44 // Function //
  45 //////////////
  46 /// Get a "float" in the script.
  47 float getFloat();
  48 /// Get an "int" in the script.
  49 sint getInt();
  50 /// Get all value for a RGBA in the script.
  51 CRGBA getRGBA();
  52 /// Get a vector of float of size (nbCol) from the script
  53 std::vector<float> getVectorOfFloat(uint8 nbCol);
  54
  55 /// Get the Hot Spot of a control.
  56 CControl::THotSpot getHotSpot();
  57 /// Get the display mode for the background.
  58 COSD::TBG getBGMode();
  59 /// Get the display mode for the background.
  60 CButtonBase::TBG getBGMode2();
  61 /// Get the display mode for the Title Bar.
  62 COSD::TTB getTBMode();
  63
  64 #endif // CL_INTERF_SCRIPT_H
  65
  66 /* End of interf_script.h */