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