src/gamedef.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2011 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef GAMEDEF_HEADER
  21 #define GAMEDEF_HEADER
  22
  23 #include <string>
  24 #include "irrlichttypes.h"
  25
  26 class IItemDefManager;
  27 class INodeDefManager;
  28 class ICraftDefManager;
  29 class ITextureSource;
  30 class ISoundManager;
  31 class MtEventManager;
  32
  33 /*
  34         An interface for fetching game-global definitions like tool and
  35         mapnode properties
  36 */
  37
  38 class IGameDef
  39 {
  40 public:
  41         // These are thread-safe IF they are not edited while running threads.
  42         // Thus, first they are set up and then they are only read.
  43         virtual IItemDefManager* getItemDefManager()=0;
  44         virtual INodeDefManager* getNodeDefManager()=0;
  45         virtual ICraftDefManager* getCraftDefManager()=0;
  46
  47         // This is always thread-safe, but referencing the irrlicht texture
  48         // pointers in other threads than main thread will make things explode.
  49         virtual ITextureSource* getTextureSource()=0;
  50
  51         // Used for keeping track of names/ids of unknown nodes
  52         virtual u16 allocateUnknownNodeId(const std::string &name)=0;
  53
  54         // Only usable on the client
  55         virtual ISoundManager* getSoundManager()=0;
  56         virtual MtEventManager* getEventManager()=0;
  57
  58         // Used on the client
  59         virtual bool checkLocalPrivilege(const std::string &priv)
  60         { return false; }
  61
  62         // Shorthands
  63         IItemDefManager* idef(){return getItemDefManager();}
  64         INodeDefManager* ndef(){return getNodeDefManager();}
  65         ICraftDefManager* cdef(){return getCraftDefManager();}
  66         ITextureSource* tsrc(){return getTextureSource();}
  67         ISoundManager* sound(){return getSoundManager();}
  68         MtEventManager* event(){return getEventManager();}
  69 };
  70
  71 #endif
  72