summaryrefslogtreecommitdiffstats
path: root/src/Root.h
diff options
context:
space:
mode:
authorJulian Laubstein <julianlaubstein@yahoo.de>2015-07-31 19:26:33 +0200
committerJulian Laubstein <julianlaubstein@yahoo.de>2015-07-31 19:26:33 +0200
commitd19cde93fa3344f318fb0d4ffbf5bb0397a51a75 (patch)
treeb5ee221d8a8e63c7d3b7868da1db19bf717a6ffd /src/Root.h
parentMerge pull request #2400 from cuberite/OffloadBadChunks (diff)
parentUnified the doxy-comment format. (diff)
downloadcuberite-d19cde93fa3344f318fb0d4ffbf5bb0397a51a75.tar
cuberite-d19cde93fa3344f318fb0d4ffbf5bb0397a51a75.tar.gz
cuberite-d19cde93fa3344f318fb0d4ffbf5bb0397a51a75.tar.bz2
cuberite-d19cde93fa3344f318fb0d4ffbf5bb0397a51a75.tar.lz
cuberite-d19cde93fa3344f318fb0d4ffbf5bb0397a51a75.tar.xz
cuberite-d19cde93fa3344f318fb0d4ffbf5bb0397a51a75.tar.zst
cuberite-d19cde93fa3344f318fb0d4ffbf5bb0397a51a75.zip
Diffstat (limited to 'src/Root.h')
-rw-r--r--src/Root.h40
1 files changed, 20 insertions, 20 deletions
diff --git a/src/Root.h b/src/Root.h
index 0eae21384..b29fe0a5e 100644
--- a/src/Root.h
+++ b/src/Root.h
@@ -78,10 +78,10 @@ public:
}
// tolua_end
- /// Calls the callback for each world; returns true if the callback didn't abort (return true)
+ /** Calls the callback for each world; returns true if the callback didn't abort (return true) */
bool ForEachWorld(cWorldListCallback & a_Callback); // >> Exported in ManualBindings <<
- /// Writes chunkstats, for each world and totals, to the output callback
+ /** Writes chunkstats, for each world and totals, to the output callback */
void LogChunkStats(cCommandOutputCallback & a_Output);
cMonsterConfig * GetMonsterConfig(void) { return m_MonsterConfig; }
@@ -89,7 +89,7 @@ public:
cCraftingRecipes * GetCraftingRecipes(void) { return m_CraftingRecipes; } // tolua_export
cFurnaceRecipe * GetFurnaceRecipe (void) { return m_FurnaceRecipe; } // Exported in ManualBindings.cpp with quite a different signature
- /// Returns the number of ticks for how long the item would fuel a furnace. Returns zero if not a fuel
+ /** Returns the number of ticks for how long the item would fuel a furnace. Returns zero if not a fuel */
static int GetFurnaceFuelBurnTime(const cItem & a_Fuel); // tolua_export
/** The current time where the startup of the server has been completed */
@@ -115,28 +115,28 @@ public:
*/
void QueueExecuteConsoleCommand(const AString & a_Cmd); // tolua_export
- /// Executes a console command through the cServer class; does special handling for "stop" and "restart".
+ /** Executes a console command through the cServer class; does special handling for "stop" and "restart". */
void ExecuteConsoleCommand(const AString & a_Cmd, cCommandOutputCallback & a_Output);
- /// Kicks the user, no matter in what world they are. Used from cAuthenticator
+ /** Kicks the user, no matter in what world they are. Used from cAuthenticator */
void KickUser(int a_ClientID, const AString & a_Reason);
- /// Called by cAuthenticator to auth the specified user
+ /** Called by cAuthenticator to auth the specified user */
void AuthenticateUser(int a_ClientID, const AString & a_Name, const AString & a_UUID, const Json::Value & a_Properties);
- /// Executes commands queued in the command queue
+ /** Executes commands queued in the command queue */
void TickCommands(void);
- /// Returns the number of chunks loaded
+ /** Returns the number of chunks loaded */
int GetTotalChunkCount(void); // tolua_export
- /// Saves all chunks in all worlds
+ /** Saves all chunks in all worlds */
void SaveAllChunks(void); // tolua_export
- /// Calls the callback for each player in all worlds
+ /** Calls the callback for each player in all worlds */
bool ForEachPlayer(cPlayerListCallback & a_Callback); // >> EXPORTED IN MANUALBINDINGS <<
- /// Finds a player from a partial or complete player name and calls the callback - case-insensitive
+ /** Finds a player from a partial or complete player name and calls the callback - case-insensitive */
bool FindAndDoWithPlayer(const AString & a_PlayerName, cPlayerListCallback & a_Callback); // >> EXPORTED IN MANUALBINDINGS <<
/** Finds the player over his uuid and calls the callback */
@@ -153,7 +153,7 @@ public:
// tolua_begin
- /// Sends a chat message to all connected clients (in all worlds)
+ /** Sends a chat message to all connected clients (in all worlds) */
void BroadcastChat (const AString & a_Message, eMessageType a_ChatPrefix = mtCustom);
void BroadcastChat (const cCompositeChat & a_Message);
void BroadcastChatDeath (const AString & a_Message) { BroadcastChat(a_Message, mtDeath); }
@@ -165,13 +165,13 @@ public:
void BroadcastChatSuccess(const AString & a_Message) { BroadcastChat(a_Message, mtSuccess); }
void BroadcastChatWarning(const AString & a_Message) { BroadcastChat(a_Message, mtWarning); }
- /// Returns the textual description of the protocol version: 49 -> "1.4.4". Provided specifically for Lua API
+ /** Returns the textual description of the protocol version: 49 -> "1.4.4". Provided specifically for Lua API */
static AString GetProtocolVersionTextFromInt(int a_ProtocolVersionNum);
- /// Returns the amount of virtual RAM used, in KiB. Returns a negative number on error
+ /** Returns the amount of virtual RAM used, in KiB. Returns a negative number on error */
static int GetVirtualRAMUsage(void);
- /// Returns the amount of virtual RAM used, in KiB. Returns a negative number on error
+ /** Returns the amount of virtual RAM used, in KiB. Returns a negative number on error */
static int GetPhysicalRAMUsage(void);
// tolua_end
@@ -220,19 +220,19 @@ private:
void LoadGlobalSettings();
- /// Loads the worlds from settings.ini, creates the worldmap
+ /** Loads the worlds from settings.ini, creates the worldmap */
void LoadWorlds(cSettingsRepositoryInterface & a_Settings);
- /// Starts each world's life
+ /** Starts each world's life */
void StartWorlds(void);
- /// Stops each world's threads, so that it's safe to unload them
+ /** Stops each world's threads, so that it's safe to unload them */
void StopWorlds(void);
- /// Unloads all worlds from memory
+ /** Unloads all worlds from memory */
void UnloadWorlds(void);
- /// Does the actual work of executing a command
+ /** Does the actual work of executing a command */
void DoExecuteConsoleCommand(const AString & a_Cmd);
static cRoot * s_Root;