diff --git a/doc/doxygen/MainPage.h b/doc/doxygen/MainPage.h
index 6cfedb9ce1..fd1e97f2b7 100644
--- a/doc/doxygen/MainPage.h
+++ b/doc/doxygen/MainPage.h
@@ -8,8 +8,7 @@
*
* For reference manual, see module @ref ScriptSideAPIs.
*
- * Rigs of Rods supports scripting with AngelScript
- * and features an expanding @ref ScriptAPI "interface to the game". All developers are invited
+ * Rigs of Rods supports scripting with AngelScript. All developers are invited
* to try archieve their goal via scripting if possible. This documentation intentionally displays
* the AngelScript interface alongside code to highlight that they match very closely
* and it's worthwile for the reader gain further insight into things and make/suggest enhancements.
diff --git a/source/main/gfx/MovableText.cpp b/source/main/gfx/MovableText.cpp
index 237e00aacb..c381ddbe2d 100644
--- a/source/main/gfx/MovableText.cpp
+++ b/source/main/gfx/MovableText.cpp
@@ -21,7 +21,7 @@
/// @file
/// @brief This creates a billboarding object that displays a text.
/// @author 2003 by cTh see gavocanov@rambler.ru
-/// @update 2006 by barraq see nospam@barraquand.com
+/// @author 2006 by barraq see nospam@barraquand.com
#include "MovableText.h"
diff --git a/source/main/gfx/hydrax/CfgFileManager.h b/source/main/gfx/hydrax/CfgFileManager.h
index 6a9371a002..a3bf4fb712 100644
--- a/source/main/gfx/hydrax/CfgFileManager.h
+++ b/source/main/gfx/hydrax/CfgFileManager.h
@@ -39,143 +39,74 @@ namespace Hydrax
{
class Hydrax;
- /** Config file manager.
- Class to load/save all Hydrax options from/to a config file
+ /** Class to load/save all Hydrax options from/to a config file
*/
class CfgFileManager
{
public:
- /** Constructor
- @param h Hydrax parent pointer
- */
CfgFileManager(Hydrax *h);
-
- /** Destructor
- */
~CfgFileManager();
/** Load hydrax cfg file
- @param File File name
@return false if an error has been ocurred(Check the log file in this case).
*/
const bool load(const Ogre::String& File) const;
/** Save current hydrax config to a file
- @param File Destination file name
- @param Path File path
@return false if an error has been ocurred(Check the log file in this case).
*/
const bool save(const Ogre::String& File, const Ogre::String& Path = "") const;
- /** Get the cfg string
- @param Name Parameter name
- @param Value Parameter value
- @return int cfg string
- */
static Ogre::String _getCfgString(const Ogre::String& Name, const int& Value);
-
- /** Get the cfg string
- @param Name Parameter name
- @param Value Parameter value
- @return Ogre::Real cfg string
- */
static Ogre::String _getCfgString(const Ogre::String& Name, const Ogre::Real& Value);
-
- /** Get the cfg string
- @param Name Parameter name
- @param Value Parameter value
- @return bool cfg string
- */
static Ogre::String _getCfgString(const Ogre::String& Name, const bool& Value);
-
- /** Get the cfg string
- @param Name Parameter name
- @param Value Parameter value
- @return Ogre::Vector2 cfg string
- */
static Ogre::String _getCfgString(const Ogre::String& Name, const Ogre::Vector2& Value);
-
- /** Get the cfg string
- @param Name Parameter name
- @param Value Parameter value
- @return Ogre::Vector3 cfg string
- */
static Ogre::String _getCfgString(const Ogre::String& Name, const Ogre::Vector3& Value);
-
- /** Get the cfg string
- @param Name Parameter name
- @param Value Parameter value
- @return Hydrax::Size cfg string
- */
static Ogre::String _getCfgString(const Ogre::String& Name, const Size& Value);
/** Get int value
- @param CfgFile Config file
- @param Name Parameter name
- @return int value
@remarks if the parameter isn't found or the data type is not an int value, return 0 as default
*/
static int _getIntValue(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
/** Get float value
- @param CfgFile Config file
- @param Name Parameter name
- @return float value
@remarks if the parameter isn't found or the data type is not a float value, return 0 as default
*/
static Ogre::Real _getFloatValue(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
/** Get bool value
- @param CfgFile Config file
- @param Name Parameter name
- @return bool value
@remarks if the parameter isn't found or the data type is not a bool value, return false as default
*/
static bool _getBoolValue(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
/** Get vector2 value
- @param CfgFile Config file
- @param Name Parameter name
- @return vector2 value
@remarks if the parameter isn't found or the data type is not an int value, returns (0,0) as default
*/
static Ogre::Vector2 _getVector2Value(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
/** Get vector3 value
- @param CfgFile Config file
- @param Name Parameter name
- @return vector3 value
@remarks if the parameter isn't found or the data type is not an int value, returns (0,0,0) as default
*/
static Ogre::Vector3 _getVector3Value(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
/** Get size value
- @param CfgFile Config file
- @param Name Parameter name
- @return size value
@remarks if the parameter isn't found or the data type is not an int value, returns (0,0) as default
*/
static Size _getSizeValue(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
/** Check is a std::vector contains a specified Ogre::String
- @param List String list
- @param Find String to find
@return true if it's contained, false if not
*/
static bool _isStringInList(const Ogre::StringVector &List, const Ogre::String &Find);
private:
/** Save a string in file
- @param Data Data
- @param File Destination file
- @param Path File path
@return false if an error has ocurred
*/
const bool _saveToFile(const Ogre::String& Data, const Ogre::String& File, const Ogre::String& Path) const;
/** Load a cfg file in an Ogre::ConfigFile
- @param File File name
- @param Result, std::pair First: False if the file isn't in the Hydrax resource group, Second: Ogre::ConfigFile
+ @param Result, First: False if the file isn't in the Hydrax resource group, Second: Ogre::ConfigFile
*/
const void _loadCfgFile(const Ogre::String& File, std::pair &Result) const;
@@ -205,7 +136,6 @@ namespace Hydrax
const Ogre::String _getVersionCfgString() const;
/** Check hydrax version cfg file
- @param CfgFile Config file
@return true if it's the same version, false if not.
*/
const bool _checkVersion(Ogre::ConfigFile& CfgFile) const;
diff --git a/source/main/gfx/hydrax/FFT.h b/source/main/gfx/hydrax/FFT.h
index 4602f3317b..316946257b 100644
--- a/source/main/gfx/hydrax/FFT.h
+++ b/source/main/gfx/hydrax/FFT.h
@@ -191,7 +191,6 @@ namespace Hydrax{ namespace Noise
void saveCfg(Ogre::String &Data);
/** Load config
- @param CgfFile Ogre::ConfigFile reference
@return True if is the correct noise config
*/
bool loadCfg(Ogre::ConfigFile &CfgFile);
diff --git a/source/main/gfx/hydrax/Hydrax.h b/source/main/gfx/hydrax/Hydrax.h
index 38176e2946..95462d671a 100644
--- a/source/main/gfx/hydrax/Hydrax.h
+++ b/source/main/gfx/hydrax/Hydrax.h
@@ -159,19 +159,12 @@ namespace Hydrax
*/
void setFullReflectionDistance(const Ogre::Real &FullReflectionDistance);
- /** Set global transparency
- @param GlobalTransparency Global transparency distance
- */
- void setGlobalTransparency(const Ogre::Real &GlobalTransparency);
+ void setGlobalTransparency(const Ogre::Real &GlobalTransparencyDistance);
- /** Set water color
- @param DepthColor Water color
- */
void setWaterColor(const Ogre::Vector3 &WaterColor);
/** Set normal distortion
- @param NormalDistortion Normal distortion
- @remarks Value will bi very short, like 0.025
+ @param NormalDistortion use low value, like 0.025
*/
void setNormalDistortion(const Ogre::Real &NormalDistortion);
diff --git a/source/main/gfx/hydrax/MaterialManager.h b/source/main/gfx/hydrax/MaterialManager.h
index 3ed98e272f..1c272ecbdf 100644
--- a/source/main/gfx/hydrax/MaterialManager.h
+++ b/source/main/gfx/hydrax/MaterialManager.h
@@ -351,14 +351,7 @@ namespace Hydrax
*/
bool _createUnderwaterCompositor(const HydraxComponent &Components, const Options &Options);
- /** Create a simple color material
- @param Colour Material color
- @param MT Material type
- @param Name Material name
- @param DepthCheck Depth check enabled
- @param DepthWrite Depth write enabled
- */
- bool _createSimpleColorMaterial(const Ogre::ColourValue& Color, const MaterialType& MT, const Ogre::String& Name, const bool& DepthCheck = true, const bool& DepthWrite = true);
+ bool _createSimpleColorMaterial(const Ogre::ColourValue& MaterialColor, const MaterialType& MT, const Ogre::String& MaterialName, const bool& DepthCheck = true, const bool& DepthWrite = true);
/// Is createMaterials() already called?
bool mCreated;
diff --git a/source/main/gfx/hydrax/Module.h b/source/main/gfx/hydrax/Module.h
index d4064b26b3..c8a5b40b27 100644
--- a/source/main/gfx/hydrax/Module.h
+++ b/source/main/gfx/hydrax/Module.h
@@ -89,7 +89,6 @@ namespace Hydrax{ namespace Module
virtual void saveCfg(Ogre::String &Data);
/** Load config
- @param CgfFile Ogre::ConfigFile reference
@return True if is the correct module config
*/
virtual bool loadCfg(Ogre::ConfigFile &CfgFile);
diff --git a/source/main/gfx/hydrax/Noise.h b/source/main/gfx/hydrax/Noise.h
index 75f25a785c..e82e84dc2a 100644
--- a/source/main/gfx/hydrax/Noise.h
+++ b/source/main/gfx/hydrax/Noise.h
@@ -82,7 +82,6 @@ namespace Hydrax{ namespace Noise
virtual void saveCfg(Ogre::String &Data);
/** Load config
- @param CgfFile Ogre::ConfigFile reference
@return True if is the correct noise config
*/
virtual bool loadCfg(Ogre::ConfigFile &CfgFile);
diff --git a/source/main/gfx/hydrax/Perlin.h b/source/main/gfx/hydrax/Perlin.h
index d6478589f2..fdd759853e 100644
--- a/source/main/gfx/hydrax/Perlin.h
+++ b/source/main/gfx/hydrax/Perlin.h
@@ -202,7 +202,6 @@ namespace Hydrax{ namespace Noise
void saveCfg(Ogre::String &Data);
/** Load config
- @param CgfFile Ogre::ConfigFile reference
@return True if is the correct noise config
*/
bool loadCfg(Ogre::ConfigFile &CfgFile);
diff --git a/source/main/gfx/hydrax/ProjectedGrid.h b/source/main/gfx/hydrax/ProjectedGrid.h
index ce7c93cc34..b0577dbde2 100644
--- a/source/main/gfx/hydrax/ProjectedGrid.h
+++ b/source/main/gfx/hydrax/ProjectedGrid.h
@@ -188,7 +188,6 @@ namespace Hydrax{ namespace Module
void saveCfg(Ogre::String &Data);
/** Load config
- @param CgfFile Ogre::ConfigFile reference
@return True if is the correct module config
*/
bool loadCfg(Ogre::ConfigFile &CfgFile);
diff --git a/source/main/gfx/hydrax/RadialGrid.h b/source/main/gfx/hydrax/RadialGrid.h
index 8adaa61b1e..5a22274ce2 100644
--- a/source/main/gfx/hydrax/RadialGrid.h
+++ b/source/main/gfx/hydrax/RadialGrid.h
@@ -185,7 +185,6 @@ namespace Hydrax{ namespace Module
void saveCfg(Ogre::String &Data);
/** Load config
- @param CgfFile Ogre::ConfigFile reference
@return True if is the correct module config
*/
bool loadCfg(Ogre::ConfigFile &CfgFile);
diff --git a/source/main/gfx/hydrax/Real.h b/source/main/gfx/hydrax/Real.h
index 574e7ea51e..0d7b072d26 100644
--- a/source/main/gfx/hydrax/Real.h
+++ b/source/main/gfx/hydrax/Real.h
@@ -148,7 +148,6 @@ class Real : public Noise
void saveCfg(Ogre::String &Data);
/** Load config
- @param CgfFile Ogre::ConfigFile reference
@return True if is the correct noise config
*/
bool loadCfg(Ogre::ConfigFile &CfgFile);
diff --git a/source/main/gfx/hydrax/RttManager.h b/source/main/gfx/hydrax/RttManager.h
index 309c816879..ed70210721 100644
--- a/source/main/gfx/hydrax/RttManager.h
+++ b/source/main/gfx/hydrax/RttManager.h
@@ -134,8 +134,6 @@ namespace Hydrax
void removeAll();
/** Get RTT texture name
- @param Rtt Rtt type
- @return Rtt texture name
*/
inline const Ogre::String& getRttName(RttType Rtt) const
{
@@ -143,42 +141,30 @@ namespace Hydrax
}
/** Get Rtt texture
- @param Rtt Rtt type
- @return Rtt texture
*/
inline Ogre::TexturePtr getTexture(RttType Rtt)
{
return mTextures[static_cast(Rtt)];
}
- /** Get planes scene node
- @return Planes scene node
- */
inline Ogre::SceneNode* getPlanesSceneNode()
{
return mPlanesSceneNode;
}
/** Get Rtt plane
- @param Rtt Rtt type
- @return Rtt plane
*/
inline Ogre::MovablePlane* getPlane(RttType Rtt)
{
return mPlanes[static_cast(Rtt)];
}
- /** Get Rtt texture size
- @param Rtt Rtt type
- @return Rtt texture size
- */
inline const Size& getTextureSize(const RttType& Rtt) const
{
return mRttOptions[static_cast(Rtt)].Size_;
}
/** Set Rtt texture size
- @param Rtt Rtt type
@param S New texture size (0,0 -> get main viewport size)
*/
void setTextureSize(const RttType& Rtt, const Size& S);
@@ -188,16 +174,8 @@ namespace Hydrax
*/
void setTexturesSize(const Size& S);
- /** Get pixel format
- @param Rtt Rtt type
- @return Rtt pixel format
- */
const Ogre::PixelFormat getPixelFormat(const RttType& Rtt) const;
- /** Set number of channels
- @Rtt Rtt type
- @NOC Number of channels
- */
inline void setNumberOfChannels(const RttType& Rtt, const NumberOfChannels& NOC)
{
mRttOptions[Rtt].NumberOfChannels_ = NOC;
@@ -208,19 +186,11 @@ namespace Hydrax
}
}
- /** Get number of channels
- @Rtt Rtt type
- @return Number of channels
- */
inline const NumberOfChannels& getNumberOfChannels(const RttType& Rtt) const
{
return mRttOptions[Rtt].NumberOfChannels_;
}
- /** Set bits per channel
- @Rtt Rtt type
- @BPC Bits per channel
- */
inline void setBitsPerChannel(const RttType& Rtt, const BitsPerChannel& BPC)
{
mRttOptions[Rtt].BitsPerChannel_ = BPC;
@@ -231,74 +201,45 @@ namespace Hydrax
}
}
- /** Get bits per channels
- @Rtt Rtt type
- @return Bits per channel
- */
inline const BitsPerChannel& getBitsPerChannel(const RttType& Rtt) const
{
return mRttOptions[Rtt].BitsPerChannel_;
}
- /** Get Rtt options
- @Rtt Rtt type
- @return RttOptions
- */
inline const RttOptions& getRttOptions(const RttType& Rtt) const
{
return mRttOptions[Rtt];
}
- /** Set reflection displacement error
- @param ReflectionDisplacementError Range [0.05, ~2], increase if you experiment
- reflection issues when the camera is near to the water.
+ /** Range [0.05, ~2], increase if you experience reflection issues when the camera is near to the water.
*/
void setReflectionDisplacementError(const Ogre::Real& ReflectionDisplacementError)
{
mReflectionDisplacementError = ReflectionDisplacementError;
}
- /** Get reflection displacement error
- @return Reflection displacement error
- */
inline const Ogre::Real& getReflectionDisplacementError() const
{
return mReflectionDisplacementError;
}
- /** Set disable reflection custom near clip plane render queues
- @param DisableReflectionCustomNearClipPlaneRenderQueues Disable reflection custom near clip plane render queues
- */
inline void setDisableReflectionCustomNearCliplPlaneRenderQueues(const std::vector& DisableReflectionCustomNearClipPlaneRenderQueues)
{
mDisableReflectionCustomNearClipPlaneRenderQueues = DisableReflectionCustomNearClipPlaneRenderQueues;
}
- /** Get disable reflection custom near clip plane render queues
- @return Disable reflection custom near clip plane render queues
- */
inline const std::vector& getDisableReflectionCustomNearClipPlaneRenderQueues()
{
return mDisableReflectionCustomNearClipPlaneRenderQueues;
}
- /** Add Rtt listener
- @param l Rtt listener
- */
inline void addRttListener(RttListener *l)
{
mRttListeners.push_back(l);
}
- /** Remove Rtt listener
- @param l Rtt listener to be removed
- @param releaseMemory delete Rtt listener pointer?
- */
void removeRttListener(RttListener *l, const bool& releaseMemory = true);
- /** Remove all Rtt listeners
- @param releaseMemory delete Rtt listeners pointers?
- */
void removeAllRttListeners(const bool& releaseMemory = true);
private:
@@ -313,17 +254,8 @@ namespace Hydrax
/// Camera.y - Plane.y difference
Ogre::Real mCameraPlaneDiff;
- /** Funtion that is called before the Rtt will render
- @param evt Ogre RenderTargetEvent
- @remarks We've to override it
- */
- void preRenderTargetUpdate(const Ogre::RenderTargetEvent& evt);
-
- /** Funtion that is called after the Rtt will render
- @param evt Ogre RenderTargetEvent
- @remarks We've to override it
- */
- void postRenderTargetUpdate(const Ogre::RenderTargetEvent& evt);
+ void preRenderTargetUpdate(const Ogre::RenderTargetEvent& evt) override;
+ void postRenderTargetUpdate(const Ogre::RenderTargetEvent& evt) override;
};
/** RttManager::CReflectionListener class
@@ -331,21 +263,14 @@ namespace Hydrax
class CReflectionListener : public Ogre::RenderTargetListener
{
public:
- /** RttManager::CReflectionListener::CReflectionQueueListener class
- Used for avoid near clip plane clipping during the reflection Rtt
+ /** Used for avoid near clip plane clipping during the reflection Rtt
*/
class CReflectionQueueListener : public Ogre::RenderQueueListener
{
public:
- /** Called at the start of the queue
- */
- void renderQueueStarted(Ogre::uint8 queueGroupId, const Ogre::String &invocation, bool &skipThisInvocation);
+ void renderQueueStarted(Ogre::uint8 queueGroupId, const Ogre::String &invocation, bool &skipThisInvocation) override;
+ void renderQueueEnded(Ogre::uint8 queueGroupId, const Ogre::String &invocation, bool &skipThisInvocation) override;
- /** Called on the end of the queue
- */
- void renderQueueEnded(Ogre::uint8 queueGroupId, const Ogre::String &invocation, bool &skipThisInvocation) ;
-
- /// Rtt manager pointer
RttManager* mRttManager;
/// Is the reflection Rtt active?
bool mActive;
@@ -360,21 +285,10 @@ namespace Hydrax
/// Camera.y - Plane.y difference
Ogre::Real mCameraPlaneDiff;
- /** Funtion that is called before the Rtt will render
- @param evt Ogre RenderTargetEvent
- @remarks We've to override it
- */
- void preRenderTargetUpdate(const Ogre::RenderTargetEvent& evt);
-
- /** Funtion that is called after the Rtt will render
- @param evt Ogre RenderTargetEvent
- @remarks We've to override it
- */
- void postRenderTargetUpdate(const Ogre::RenderTargetEvent& evt);
+ void preRenderTargetUpdate(const Ogre::RenderTargetEvent& evt) override;
+ void postRenderTargetUpdate(const Ogre::RenderTargetEvent& evt) override;
};
- /** RttManager::CDepthListener class
- */
class CDepthListener : public Ogre::RenderTargetListener
{
public:
@@ -387,21 +301,10 @@ namespace Hydrax
/// Camera.y - Plane.y difference
Ogre::Real mCameraPlaneDiff;
- /** Funtion that is called before the Rtt will render
- @param evt Ogre RenderTargetEvent
- @remarks We've to override it
- */
- void preRenderTargetUpdate(const Ogre::RenderTargetEvent& evt);
-
- /** Funtion that is called after the Rtt will render
- @param evt Ogre RenderTargetEvent
- @remarks We've to override it
- */
- void postRenderTargetUpdate(const Ogre::RenderTargetEvent& evt);
+ void preRenderTargetUpdate(const Ogre::RenderTargetEvent& evt) override;
+ void postRenderTargetUpdate(const Ogre::RenderTargetEvent& evt) override;
};
- /** RttManager::CDepthReflectionListener class
- */
class CDepthReflectionListener : public Ogre::RenderTargetListener
{
public:
@@ -414,21 +317,10 @@ namespace Hydrax
/// Camera.y - Plane.y difference
Ogre::Real mCameraPlaneDiff;
- /** Funtion that is called before the Rtt will render
- @param evt Ogre RenderTargetEvent
- @remarks We've to override it
- */
- void preRenderTargetUpdate(const Ogre::RenderTargetEvent& evt);
-
- /** Funtion that is called after the Rtt will render
- @param evt Ogre RenderTargetEvent
- @remarks We've to override it
- */
- void postRenderTargetUpdate(const Ogre::RenderTargetEvent& evt);
+ void preRenderTargetUpdate(const Ogre::RenderTargetEvent& evt) override;
+ void postRenderTargetUpdate(const Ogre::RenderTargetEvent& evt) override;
};
- /** RttManager::CGPUNormalMapListener class
- */
class CGPUNormalMapListener : public Ogre::RenderTargetListener
{
public:
@@ -438,38 +330,16 @@ namespace Hydrax
/// Old Hydrax mesh material name
Ogre::String mOldMaterialName;
- /** Funtion that is called before the Rtt will render
- @param evt Ogre RenderTargetEvent
- @remarks We've to override it
- */
- void preRenderTargetUpdate(const Ogre::RenderTargetEvent& evt);
-
- /** Funtion that is called after the Rtt will render
- @param evt Ogre RenderTargetEvent
- @remarks We've to override it
- */
- void postRenderTargetUpdate(const Ogre::RenderTargetEvent& evt);
+ void preRenderTargetUpdate(const Ogre::RenderTargetEvent& evt) override;
+ void postRenderTargetUpdate(const Ogre::RenderTargetEvent& evt) override;
};
- /** Initialize the Rtt
- @param Rtt Rtt type
- @param PlaneNormal Rtt plane normal
- @param BackgroundColour Background colour
- @param RenderSky True for sky rendering and false for not
- @param RTListener Render target listener
- @param MaterialScheme Ogre::String("") for none
- @param ShadowsEnabled Enable shadows in this RTT
- */
- void _initializeRtt(const RttType& Rtt, const Ogre::Vector3& PlaneNormal,
+
+ void _initializeRtt(const RttType& Rtt, const Ogre::Vector3& RttPlaneNormal,
const Ogre::ColourValue& BackgroundColour, const bool& RenderSky,
Ogre::RenderTargetListener* RTListener, const Ogre::String& MaterialScheme = "",
const bool& ShadowsEnabled = true);
- /** Find a render queue in a render queue list
- @param l Render queue list
- @param rq Render queue to find
- @return true If the render queue to find is in the list, false if not
- */
inline const bool _isRenderQueueInList(const std::vector& l, const Ogre::RenderQueueGroupID& rq)
{
for (std::vector::const_iterator i = l.begin(); i != l.end(); i++)
diff --git a/source/main/gfx/hydrax/SimpleGrid.h b/source/main/gfx/hydrax/SimpleGrid.h
index 6786fee051..d3ef963ba8 100644
--- a/source/main/gfx/hydrax/SimpleGrid.h
+++ b/source/main/gfx/hydrax/SimpleGrid.h
@@ -155,7 +155,6 @@ namespace Hydrax{ namespace Module
void saveCfg(Ogre::String &Data);
/** Load config
- @param CgfFile Ogre::ConfigFile reference
@return True if is the correct module config
*/
bool loadCfg(Ogre::ConfigFile &CfgFile);
diff --git a/source/main/gfx/skyx/SCfgFileManager.h b/source/main/gfx/skyx/SCfgFileManager.h
index b8d4e4ec89..6526e402b3 100644
--- a/source/main/gfx/skyx/SCfgFileManager.h
+++ b/source/main/gfx/skyx/SCfgFileManager.h
@@ -62,81 +62,35 @@ namespace SkyX
*/
const bool save(const Ogre::String& File, const Ogre::String& Path = "") const;
- /** Get the cfg string
- @param Name Parameter name
- @param Value Parameter value
- @return int cfg string
- */
static Ogre::String _getCfgString(const Ogre::String& Name, const int& Value);
-
- /** Get the cfg string
- @param Name Parameter name
- @param Value Parameter value
- @return Ogre::Real cfg string
- */
static Ogre::String _getCfgString(const Ogre::String& Name, const Ogre::Real& Value);
-
- /** Get the cfg string
- @param Name Parameter name
- @param Value Parameter value
- @return bool cfg string
- */
static Ogre::String _getCfgString(const Ogre::String& Name, const bool& Value);
-
- /** Get the cfg string
- @param Name Parameter name
- @param Value Parameter value
- @return Ogre::Vector2 cfg string
- */
static Ogre::String _getCfgString(const Ogre::String& Name, const Ogre::Vector2& Value);
-
- /** Get the cfg string
- @param Name Parameter name
- @param Value Parameter value
- @return Ogre::Vector3 cfg string
- */
static Ogre::String _getCfgString(const Ogre::String& Name, const Ogre::Vector3& Value);
-
static Ogre::String _getCfgString(const Ogre::String &Name, const Ogre::Vector4 &Value);
-
static Ogre::String _getCfgString(const Ogre::String &Name, const Ogre::Degree &Value);
/** Get int value
- @param CfgFile Config file
- @param Name Parameter name
- @return int value
@remarks if the parameter isn't found or the data type is not an int value, return 0 as default
*/
static int _getIntValue(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
/** Get float value
- @param CfgFile Config file
- @param Name Parameter name
- @return float value
@remarks if the parameter isn't found or the data type is not a float value, return 0 as default
*/
static Ogre::Real _getFloatValue(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
/** Get bool value
- @param CfgFile Config file
- @param Name Parameter name
- @return bool value
@remarks if the parameter isn't found or the data type is not a bool value, return false as default
*/
static bool _getBoolValue(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
/** Get vector2 value
- @param CfgFile Config file
- @param Name Parameter name
- @return vector2 value
@remarks if the parameter isn't found or the data type is not an int value, returns (0,0) as default
*/
static Ogre::Vector2 _getVector2Value(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
/** Get vector3 value
- @param CfgFile Config file
- @param Name Parameter name
- @return vector3 value
@remarks if the parameter isn't found or the data type is not an int value, returns (0,0,0) as default
*/
static Ogre::Vector3 _getVector3Value(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
@@ -145,18 +99,10 @@ namespace SkyX
static Ogre::Degree _getDegreeValue(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
- /** Check is a std::vector contains a specified Ogre::String
- @param List String list
- @param Find String to find
- @return true if it's contained, false if not
- */
static bool _isStringInList(const Ogre::StringVector &List, const Ogre::String &Find);
private:
/** Save a string in file
- @param Data Data
- @param File Destination file
- @param Path File path
@return false if an error has ocurred
*/
const bool _saveToFile(const Ogre::String& Data, const Ogre::String& File, const Ogre::String& Path) const;
diff --git a/source/main/gfx/skyx/VCloudsManager.h b/source/main/gfx/skyx/VCloudsManager.h
index 2544c1422f..74b2a31ef7 100644
--- a/source/main/gfx/skyx/VCloudsManager.h
+++ b/source/main/gfx/skyx/VCloudsManager.h
@@ -116,8 +116,7 @@ namespace SkyX
return mHeight;
}
- /** Set autoupdate
- @Autoupdate true if you want to update volumetric clouds wind depending of the SkyX time multiplier
+ /** Autoupdate volumetric clouds wind depending of the SkyX time multiplier
@remarks You can use VClouds->setWindSpeed(..) for different winds speeds
*/
inline void setAutoupdate(const bool& Autoupdate)
diff --git a/source/main/gui/panels/GUI_GameControls.cpp b/source/main/gui/panels/GUI_GameControls.cpp
index 72cae3b1e2..df41c47862 100644
--- a/source/main/gui/panels/GUI_GameControls.cpp
+++ b/source/main/gui/panels/GUI_GameControls.cpp
@@ -394,11 +394,7 @@ void GameControls::ReloadMapFile()
void GameControls::SetVisible(bool vis)
{
m_is_visible = vis;
- if (vis)
- {
- m_text_all_active = _LC("GameSettings", "");
- }
- else
+ if (!vis)
{
this->CancelChanges();
App::GetGuiManager()->SetVisible_GameMainMenu(true);
diff --git a/source/main/gui/panels/GUI_GameControls.h b/source/main/gui/panels/GUI_GameControls.h
index b492ecd9ae..97080fe8af 100644
--- a/source/main/gui/panels/GUI_GameControls.h
+++ b/source/main/gui/panels/GUI_GameControls.h
@@ -65,9 +65,6 @@ class GameControls
Str<1000> m_active_buffer;
bool m_interactive_keybinding_active = false;
bool m_interactive_keybinding_expl = true;
-
- // Cached display strings
- std::string m_text_all_active; //!< file combobox
};
} // namespace GUI
diff --git a/source/main/utils/ErrorUtils.h b/source/main/utils/ErrorUtils.h
index 6bebc0c16b..8f82c4f218 100644
--- a/source/main/utils/ErrorUtils.h
+++ b/source/main/utils/ErrorUtils.h
@@ -38,24 +38,18 @@ struct ErrorUtils
{
/**
* shows a simple error message box
- * @param title very short summar of the error
- * @param msg error text
* @return 0 on success, everything else on error
*/
static int ShowError(Ogre::UTFString title, Ogre::UTFString message);
/**
* shows a simple info message box
- * @param title very short summar of the error
- * @param msg error text
* @return 0 on success, everything else on error
*/
static int ShowInfo(Ogre::UTFString title, Ogre::UTFString message);
/**
* shows a generic message box
- * @param title very short summar of the error
- * @param msg error text
* @param type 0 for error, 1 for info
* @return 0 on success, everything else on error
*/