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