Ca3DE/ConDefs.cpp

   1 /*
   2 Cafu Engine, http://www.cafu.de/
   3 Copyright (c) Carsten Fuchs and other contributors.
   4 This project is licensed under the terms of the MIT license.
   5 */
   6
   7 #include "ConDefs.hpp"
   8 #include "ConsoleCommands/Console.hpp"
   9 #include "ConsoleCommands/ConVar.hpp"
  10 #include "ConsoleCommands/ConFunc.hpp"
  11 #include "MaterialSystem/MaterialManager.hpp"
  12 #include "MaterialSystem/Renderer.hpp"
  13 #include "SoundSystem/Sound.hpp"
  14 #include "SoundSystem/SoundSys.hpp"
  15 #include "SoundSystem/SoundShaderManager.hpp"
  16 #include "TextParser/TextParser.hpp"
  17
  18 extern "C"
  19 {
  20     #include <lua.h>
  21     #include <lualib.h>
  22     #include <lauxlib.h>
  23 }
  24
  25 #include <fstream>
  26 #include <map>
  27
  28
  29 static const int CLIENT_RUNMODE=1;
  30 static const int SERVER_RUNMODE=2;
  31 static const int DefaultRunMode=CLIENT_RUNMODE | SERVER_RUNMODE;
  32
  33 /*static*/ ConVarT Options_RunMode                 ("dlg_RunMode",     DefaultRunMode, ConVarT::FLAG_MAIN_EXE,                            "1 is client-only, 2 is server-only, 3 is both.", 1, 3);
  34 /*static*/ ConVarT Options_PlayerName              ("dlg_dmPlayerName",      "Player", ConVarT::FLAG_MAIN_EXE | ConVarT::FLAG_PERSISTENT, "Player name.");
  35 /*static*/ ConVarT Options_PlayerModelName         ("dlg_dmModelName",        "James", ConVarT::FLAG_MAIN_EXE | ConVarT::FLAG_PERSISTENT, "Name of the player model.");
  36 /*static*/ ConVarT Options_ClientFullScreen        ("dlg_clFullScreen",          true, ConVarT::FLAG_MAIN_EXE | ConVarT::FLAG_PERSISTENT, "When true, the video mode is changed on startup and fullscreen display is used. Otherwise, Cafu runs in an application window on the desktop.");
  37 /*static*/ ConVarT Options_ClientWindowSizeX       ("dlg_clWindowSizeX",         1024, ConVarT::FLAG_MAIN_EXE | ConVarT::FLAG_PERSISTENT, "The size of the client window in X direction.");
  38 /*static*/ ConVarT Options_ClientWindowSizeY       ("dlg_clWindowSizeY",          768, ConVarT::FLAG_MAIN_EXE | ConVarT::FLAG_PERSISTENT, "The size of the client window in Y direction.");
  39 /*static*/ ConVarT Options_ClientDesiredRenderer   ("dlg_clDesiredRenderer",       "", ConVarT::FLAG_MAIN_EXE,                            "If set, overrides the auto-selection of the renderer and determines which renderer is to be used instead.");
  40 /*static*/ ConVarT Options_ClientDesiredSoundSystem("dlg_clDesiredSoundSystem",    "", ConVarT::FLAG_MAIN_EXE,                            "If set, overrides the auto-selection of the sound system and determines which sound system is to be used instead.");
  41 /*static*/ ConVarT Options_ClientPortNr            ("dlg_clPortNr",             33000, ConVarT::FLAG_MAIN_EXE,                            "The client port number.", 0, 0xFFFF);
  42 /*static*/ ConVarT Options_ClientRemoteName        ("dlg_clRemoteName", "192.168.1.1", ConVarT::FLAG_MAIN_EXE | ConVarT::FLAG_PERSISTENT, "Name or IP of the server the client connects to.");
  43 /*static*/ ConVarT Options_ClientRemotePortNr      ("dlg_clRemotePort",         30000, ConVarT::FLAG_MAIN_EXE | ConVarT::FLAG_PERSISTENT, "Port number of the remote server.", 0, 0xFFFF);
  44 /*static*/ ConVarT Options_ClientDisplayBPP        ("dlg_clDisplayBPP",            32, ConVarT::FLAG_MAIN_EXE | ConVarT::FLAG_PERSISTENT, "The display depth in bits-per-pixel. Normally use 32, or 0 for system default.", 0, 64);
  45 /*static*/ ConVarT Options_ClientDisplayRefresh    ("dlg_clDisplayRefresh",         0, ConVarT::FLAG_MAIN_EXE | ConVarT::FLAG_PERSISTENT, "The display refresh rate. Use 0 for system default, check with your monitor specs for any other value.");
  46 /*static*/ ConVarT Options_ClientTextureDetail     ("dlg_clTextureDetail",          0, ConVarT::FLAG_MAIN_EXE | ConVarT::FLAG_PERSISTENT, "0 high detail, 1 medium detail, 2 low detail", 0, 2);
  47 /*static*/ ConVarT Options_ServerWorldName         ("dlg_svWorldName",     "TechDemo", ConVarT::FLAG_MAIN_EXE,                            "Name of the world to load.");
  48 /*static*/ ConVarT Options_ServerPortNr            ("dlg_svPortNr",             30000, ConVarT::FLAG_MAIN_EXE,                            "Server port number.", 0, 0xFFFF);
  49
  50
  51 // Notes about the GlobalTime convar:
  52 // 1) It's declared for use with "extern ConVarT GlobalTime;" elsewhere, so we don't use "static" here.
  53 // 2) It's intentionally not defined very precisely (except for that it is in seconds and ever increases),
  54 //    because I especially don't want to define where "0" is (at program start, at start of first frame, at new map start, ...?).
  55 ConVarT GlobalTime("time", 0.0, ConVarT::FLAG_MAIN_EXE | ConVarT::FLAG_READ_ONLY, "The ever proceeding time, in seconds.");
  56
  57
  58 static int ConFunc_CleanupPersistentConfig_Callback(lua_State* LuaState)
  59 {
  60     const char*                        CfgFileName=luaL_checkstring(LuaState, 1);
  61     TextParserT                        TP(CfgFileName, "=");
  62     std::map<std::string, std::string> Pairs;
  63
  64     if (TP.IsAtEOF())
  65     {
  66         // This function must not cause a Lua error, or otherwise the calling config.lua script is aborted early!
  67         Console->Warning(cf::va("Unable to open file %s.\n", CfgFileName));
  68         return 0;
  69     }
  70
  71     try
  72     {
  73         while (!TP.IsAtEOF())
  74         {
  75             std::string Key  =TP.GetNextToken(); TP.AssertAndSkipToken("=");
  76             std::string Value=TP.GetNextToken();
  77
  78             if (TP.WasLastTokenQuoted()) Value="\""+Value+"\"";
  79
  80             Pairs[Key]=Value;
  81         }
  82     }
  83     catch (const TextParserT::ParseError&)
  84     {
  85         // This function must not cause a Lua error, or otherwise the calling config.lua script is aborted early!
  86         Console->Warning(cf::va("Problem parsing the config file near byte %lu (%.3f%%).", TP.GetReadPosByte(), TP.GetReadPosPercent()*100.0));
  87         return 0;
  88     }
  89
  90
  91     // Ok, all the right keys and values are now in Pairs, now rewrite the config file.
  92     std::ofstream CfgFile(CfgFileName, std::ios::out);
  93
  94     if (!CfgFile.bad())
  95     {
  96         for (std::map<std::string, std::string>::const_iterator It=Pairs.begin(); It!=Pairs.end(); ++It)
  97         {
  98             CfgFile << It->first << " = " << It->second << "\n";
  99         }
 100
 101         CfgFile << "\n";
 102     }
 103
 104     return 0;
 105 }
 106
 107 static ConFuncT ConFunc_CleanupPersistentConfig("CleanupPersistentConfig", ConFunc_CleanupPersistentConfig_Callback, ConFuncT::FLAG_MAIN_EXE, "");
 108
 109
 110 static int ConFunc_VideoInfo_Callback(lua_State* LuaState)
 111 {
 112     // Console->Print(GetVideoModes());
 113     Console->Print(cf::va("Renderer Info: %s\n", MatSys::Renderer ? MatSys::Renderer->GetDescription() : "[No renderer active.]"));
 114     return 0;
 115 }
 116
 117 static ConFuncT ConFunc_VideoInfo("VideoInfo", ConFunc_VideoInfo_Callback, ConFuncT::FLAG_MAIN_EXE, "Prints some information about the OpenGL window and renderer.");
 118
 119
 120 static int ConFunc_forceRM_Callback(lua_State* LuaState)
 121 {
 122     static MatSys::RenderMaterialT* ForceRM=NULL;
 123
 124     // First check if the MatSys::Renderer is available, we need it below in all usage-cases of this function.
 125     if (MatSys::Renderer==NULL)
 126     {
 127         ForceRM=NULL;   // The ForceRM was either never assigned, or automatically freed when the MatSys::Renderer last went down.
 128         return luaL_error(LuaState, "MatSys::Renderer is not available.");
 129     }
 130
 131     // If a ForceRM was set in a previous call to this function, free it.
 132     if (ForceRM!=NULL)
 133     {
 134         if (MatSys::Renderer->GetCurrentMaterial()==ForceRM)
 135         {
 136             MatSys::Renderer->FreeMaterial(ForceRM);
 137         }
 138         else
 139         {
 140             // Getting here is highly unusual, because either there is code somewhere else that improperly broke our material lock,
 141             // or the MatSys::Renderer was shutdown and re-instantiated since the previous call to this function.
 142             // In the latter case, we must not try to free the ForceRM, so the above if-test is a nice protection.
 143             Console->Warning("The previously forced material has been unforced elsewhere!\n");
 144         }
 145
 146         ForceRM=NULL;
 147     }
 148
 149     // If no parameters were given, remove any lock to restore normal operation.
 150     if (lua_gettop(LuaState)==0)
 151     {
 152         MatSys::Renderer->LockCurrentMaterial(false);
 153         return 0;
 154     }
 155
 156     // Establish the lock for the given material name.
 157     if (MaterialManager==NULL) return luaL_error(LuaState, "The MaterialManager is not available.");
 158
 159     const char* MatName=luaL_checkstring(LuaState, 1);
 160     MaterialT*  Mat    =MaterialManager->GetMaterial(MatName);
 161
 162     if (Mat==NULL) return luaL_error(LuaState, "Unknown material \"%s\".", MatName);
 163
 164     ForceRM=MatSys::Renderer->RegisterMaterial(Mat);
 165
 166     if (ForceRM==NULL) return luaL_error(LuaState, "Could not register material \"%s\".", MatName);
 167
 168     MatSys::Renderer->SetCurrentMaterial(ForceRM);
 169     MatSys::Renderer->LockCurrentMaterial(true);
 170
 171     return 0;
 172 }
 173
 174 static ConFuncT ConFunc_forceRM("forceRM", ConFunc_forceRM_Callback, ConFuncT::FLAG_MAIN_EXE,
 175     "Enforces the use of the given material for all rendering. Restores normal rendering when no parameter is given.");
 176
 177
 178 static SoundI* ConMusic=NULL;   // For playing background music from the console.
 179
 180 static int ConFunc_MusicLoad_Callback(lua_State* LuaState)
 181 {
 182     if (SoundSystem==NULL)
 183     {
 184         return luaL_error(LuaState, "SoundSystem is not available.");
 185     }
 186
 187     if (ConMusic!=NULL)
 188     {
 189         SoundSystem->DeleteSound(ConMusic);
 190         ConMusic=NULL;
 191     }
 192
 193     ConMusic=SoundSystem->CreateSound2D(SoundShaderManager->GetSoundShader(luaL_checkstring(LuaState, 1)));
 194     return 0;
 195 }
 196
 197 static ConFuncT ConFunc_MusicLoad("MusicLoad", ConFunc_MusicLoad_Callback, ConFuncT::FLAG_MAIN_EXE, "");
 198
 199
 200 static int ConFunc_MusicPlay_Callback(lua_State* LuaState)
 201 {
 202     if (SoundSystem==NULL) return luaL_error(LuaState, "SoundSystem is not available.");
 203     if (ConMusic   ==NULL) return luaL_error(LuaState, "No sound shader loaded.");
 204
 205     ConMusic->Play();
 206     return 0;
 207 }
 208
 209 static ConFuncT ConFunc_MusicPlay("MusicPlay", ConFunc_MusicPlay_Callback, ConFuncT::FLAG_MAIN_EXE, "");
 210
 211
 212 static int ConFunc_MusicIsPlaying_Callback(lua_State* LuaState)
 213 {
 214     if (SoundSystem==NULL) return luaL_error(LuaState, "SoundSystem is not available.");
 215
 216     lua_pushboolean(LuaState, ConMusic!=NULL && ConMusic->IsPlaying());
 217     return 1;
 218 }
 219
 220 static ConFuncT ConFunc_MusicIsPlaying("MusicIsPlaying", ConFunc_MusicIsPlaying_Callback, ConFuncT::FLAG_MAIN_EXE, "");
 221
 222
 223 static int ConFunc_MusicStop_Callback(lua_State* LuaState)
 224 {
 225     if (SoundSystem==NULL) return luaL_error(LuaState, "SoundSystem is not available.");
 226     if (ConMusic   ==NULL) return luaL_error(LuaState, "No sound shader loaded.");
 227
 228     ConMusic->Stop();
 229     return 0;
 230 }
 231
 232 static ConFuncT ConFunc_MusicStop("MusicStop", ConFunc_MusicStop_Callback, ConFuncT::FLAG_MAIN_EXE, "");
 233
 234
 235 static int ConFunc_MusicSetVol_Callback(lua_State* LuaState)
 236 {
 237     if (SoundSystem==NULL) return luaL_error(LuaState, "SoundSystem is not available.");
 238     if (ConMusic   ==NULL) return luaL_error(LuaState, "No sound shader loaded.");
 239
 240     ConMusic->SetInnerVolume(float(lua_tonumber(LuaState, 1)));
 241     return 0;
 242 }
 243
 244 static ConFuncT ConFunc_MusicSetVol("MusicSetVolume", ConFunc_MusicSetVol_Callback, ConFuncT::FLAG_MAIN_EXE, "");
 245
 246
 247 static int ConFunc_GetMasterVolume_Callback(lua_State* LuaState)
 248 {
 249     if (SoundSystem==NULL) return luaL_error(LuaState, "SoundSystem is not available.");
 250
 251     lua_pushnumber(LuaState, SoundSystem->GetMasterVolume());
 252     return 1;
 253 }
 254
 255 static ConFuncT ConFunc_GetMasterVolume("GetMasterVolume", ConFunc_GetMasterVolume_Callback, ConFuncT::FLAG_MAIN_EXE, "");
 256
 257
 258 static int ConFunc_SetMasterVolume_Callback(lua_State* LuaState)
 259 {
 260     if (SoundSystem==NULL) return luaL_error(LuaState, "SoundSystem is not available.");
 261
 262     SoundSystem->SetMasterVolume(float(lua_tonumber(LuaState, 1)));
 263     return 0;
 264 }
 265
 266 static ConFuncT ConFunc_SetMasterVolume("SetMasterVolume", ConFunc_SetMasterVolume_Callback, ConFuncT::FLAG_MAIN_EXE, "");