src/gamedef.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 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 IShaderSource;
  32 class MtEventManager;
  33 class IRollbackReportSink;
  34
  35 /*
  36         An interface for fetching game-global definitions like tool and
  37         mapnode properties
  38 */
  39
  40 class IGameDef
  41 {
  42 public:
  43         // These are thread-safe IF they are not edited while running threads.
  44         // Thus, first they are set up and then they are only read.
  45         virtual IItemDefManager* getItemDefManager()=0;
  46         virtual INodeDefManager* getNodeDefManager()=0;
  47         virtual ICraftDefManager* getCraftDefManager()=0;
  48
  49         // This is always thread-safe, but referencing the irrlicht texture
  50         // pointers in other threads than main thread will make things explode.
  51         virtual ITextureSource* getTextureSource()=0;
  52
  53         virtual IShaderSource* getShaderSource()=0;
  54
  55         // Used for keeping track of names/ids of unknown nodes
  56         virtual u16 allocateUnknownNodeId(const std::string &name)=0;
  57
  58         // Only usable on the client
  59         virtual ISoundManager* getSoundManager()=0;
  60         virtual MtEventManager* getEventManager()=0;
  61
  62         // Only usable on the server, and NOT thread-safe. It is usable from the
  63         // environment thread.
  64         virtual IRollbackReportSink* getRollbackReportSink(){return NULL;}
  65
  66         // Used on the client
  67         virtual bool checkLocalPrivilege(const std::string &priv)
  68         { return false; }
  69
  70         // Shorthands
  71         IItemDefManager* idef(){return getItemDefManager();}
  72         INodeDefManager* ndef(){return getNodeDefManager();}
  73         ICraftDefManager* cdef(){return getCraftDefManager();}
  74         ITextureSource* tsrc(){return getTextureSource();}
  75         ISoundManager* sound(){return getSoundManager();}
  76         IShaderSource* shsrc(){return getShaderSource();}
  77         MtEventManager* event(){return getEventManager();}
  78         IRollbackReportSink* rollback(){return getRollbackReportSink();}
  79 };
  80
  81 #endif
  82