Menu
▾
▴
[PlaneShift-svn] SF.net SVN: planeshift:[8561] trunk/src
|
From: <ma...@us...> - 2013-01-20 22:24:54
|
Revision: 8561
http://planeshift.svn.sourceforge.net/planeshift/?rev=8561&view=rev
Author: magodra
Date: 2013-01-20 22:24:46 +0000 (Sun, 20 Jan 2013)
Log Message:
-----------
- Fixed a few more doxygen warnings.
Modified Paths:
--------------
trunk/src/common/net/msghandler.h
trunk/src/server/spellmanager.h
trunk/src/server/tutorialmanager.h
trunk/src/server/usermanager.h
Modified: trunk/src/common/net/msghandler.h
===================================================================
--- trunk/src/common/net/msghandler.h 2013-01-20 21:14:56 UTC (rev 8560)
+++ trunk/src/common/net/msghandler.h 2013-01-20 22:24:46 UTC (rev 8561)
@@ -45,12 +45,11 @@
uint32_t flags; /**< Additional flags for detecting if the subscriber should be notified */
iNetSubscriber* subscriber; /**< The actual subscriber that wants to be notified */
- /**@brief Constructor without a callback
+ /**
+ * Constructor without a callback
*
- * \ref callback is set to NULL
- *
* @param nSubscriber Sets \ref subscriber
- * @param nFlags Sets \ref flags
+ * @param nFlags Sets \ref flags
*/
Subscription(iNetSubscriber *nSubscriber, uint32_t nFlags = 0x01/*REQUIRE_READY_CLIENT*/)
: flags(nFlags), subscriber(nSubscriber)
Modified: trunk/src/server/spellmanager.h
===================================================================
--- trunk/src/server/spellmanager.h 2013-01-20 21:14:56 UTC (rev 8560)
+++ trunk/src/server/spellmanager.h 2013-01-20 22:24:46 UTC (rev 8561)
@@ -43,9 +43,11 @@
class ClientConnectionSet;
class psSpell;
-/** Manager class that handles loading/searching/casting spells.
- * This class also manages a number of psSpell Events.
- */
+/**
+ * Manager class that handles loading/searching/casting spells.
+ *
+ * This class also manages a number of psSpell Events.
+ */
class SpellManager : public MessageManager<SpellManager>
{
public:
@@ -55,85 +57,104 @@
CacheManager *cachemanager);
virtual ~SpellManager();
- /** Purifying on a glyph has been complete.
- * This will send out a network message to the client and update it's inventory
- * with the new purified glyph.
- *
- * @param character The character this is for.
- * @param glyphUID The unique ID for this item instance of the glyph.
- */
+ /**
+ * Purifying on a glyph has been complete.
+ *
+ * This will send out a network message to the client and update it's inventory
+ * with the new purified glyph.
+ *
+ * @param character The character this is for.
+ * @param glyphUID The unique ID for this item instance of the glyph.
+ */
void EndPurifying(psCharacter * character, uint32 glyphUID);
- /** Sends out the glyphs to a client.
- * Builds and sends psRequestGlyphsMessage for the client.
- *
- * @param client The client that will be sent it's current glyphs.
- */
+ /**
+ * Sends out the glyphs to a client.
+ *
+ * Builds and sends psRequestGlyphsMessage for the client.
+ *
+ * @param notused A not used message entry.
+ * @param client The client that will be sent it's current glyphs.
+ */
void SendGlyphs(MsgEntry *notused, Client * client);
- /** Handles a glyph request from a client.
+ /**
+ * Handles a glyph request from a client.
*
+ * @param notused A not used message entry.
+ * @param client The client that requested glyphs.
*/
void HandleGlyphRequest(MsgEntry *notused, Client * client);
protected:
- /** Save a spell to the database for when a player has researched it.
- *
- * @param client The client that this is for.
- * @param spellName The name of the spell to save for that player.
- */
+ /**
+ * Save a spell to the database for when a player has researched it.
+ *
+ * @param client The client that this is for.
+ * @param spellName The name of the spell to save for that player.
+ */
void SaveSpell(Client * client, csString spellName);
- /** Case a particular spell.
- *
- * @param me message entry for the client spell caster message.
- * @param client the clien that cast the spell.
- */
+ /**
+ * Case a particular spell.
+ *
+ * @param me message entry for the client spell caster message.
+ * @param client the clien that cast the spell.
+ */
void Cast(MsgEntry *me, Client *client);
public:
- /** Case a particular spell.
- *
- * @param client The client that is casting the spell.
- * @param spellName The name of the spell to cast.
- * @param kFactor The power factor that the spell is cast with.
- */
+ /**
+ * Case a particular spell.
+ *
+ * @param caster The caster of the spell.
+ * @param spellName The name of the spell to cast.
+ * @param kFactor The power factor that the spell is cast with.
+ * @param client The client that is casting the spell.
+ */
void Cast(gemActor* caster, const csString& spellName, float kFactor, Client *client);
protected:
void HandleCancelSpell(MsgEntry* notused, Client* client);
- /** Send the player's spell book.
- *
- * @param client The client that will be sent the spell book.
- */
+ /**
+ * Send the player's spell book.
+ *
+ * @param notused A not used message entry.
+ * @param client The client that will be sent the spell book.
+ */
void SendSpellBook(MsgEntry *notused, Client * client);
- /** Start to purify a glyph.
- * This will also send out notifications to the client about the start of operation.
- *
- * @param client The client that this data is for.
- * @param The stat ID of the glyph that the player wants to purify.
- */
+ /**
+ * Start to purify a glyph.
+ *
+ * This will also send out notifications to the client about the start of operation.
+ *
+ * @param me The inncomming message.
+ * @param client The client that this data is for.
+ */
void StartPurifying(MsgEntry *me, Client * client);
- /** Find a spell in the assorted glyphs.
- * This checks ths list of glyphs and see if it matches any
- * known spell. This is for when players are researching spells.
- *
- * @param client The client this data is for.
- * @param assembler A list of glyphs to check for spell match.
- *
- * @return A spell if a match found, NULL otherwise.
- */
+ /**
+ * Find a spell in the assorted glyphs.
+ *
+ * This checks ths list of glyphs and see if it matches any
+ * known spell. This is for when players are researching spells.
+ *
+ * @param client The client this data is for.
+ * @param assembler A list of glyphs to check for spell match.
+ *
+ * @return A spell if a match found, NULL otherwise.
+ */
psSpell* FindSpell(Client * client, const glyphList_t & assembler);
- /** Handles a command when player tries to research.
- *
- * @param client The client this is for.
- * @param me The message from that client.
- */
+ /**
+ * Handles a command when player tries to research.
+ *
+ * @param client The client this is for.
+ * @param me The message from that client.
+ */
void HandleAssembler(MsgEntry* me,Client* client);
ClientConnectionSet *clients;
Modified: trunk/src/server/tutorialmanager.h
===================================================================
--- trunk/src/server/tutorialmanager.h 2013-01-20 21:14:56 UTC (rev 8560)
+++ trunk/src/server/tutorialmanager.h 2013-01-20 22:24:46 UTC (rev 8561)
@@ -64,8 +64,9 @@
/**
* Specifically handle the message sent by a script
+ *
* @param client The client where the message has to be sent.
- * @param The ID of the tip from the database
+ * @param which The ID of the tip from the database
*/
void HandleScriptMessage(uint32_t client, unsigned int which);
Modified: trunk/src/server/usermanager.h
===================================================================
--- trunk/src/server/usermanager.h 2013-01-20 21:14:56 UTC (rev 8560)
+++ trunk/src/server/usermanager.h 2013-01-20 22:24:46 UTC (rev 8561)
@@ -59,36 +59,41 @@
virtual bool Initialize(GEMSupervisor* gemsupervisor) {gem = gemsupervisor; return true; }
- /** @brief Send a notification to all clients on a person buddy list if they log on/off.
+ /**
+ * Send a notification to all clients on a person buddy list if they log on/off.
*
- * This does a database hit.
+ * This does a database hit.
*
- * @param client The client that has logged in/out.
- * @param loggedon True if the player has logged on. False if logged off.
+ * @param client The client that has logged in/out.
+ * @param loggedon True if the player has logged on. False if logged off.
*/
void NotifyBuddies(Client * client, bool loggedon);
- /** @brief Send a notification to all player (non GM/Dev) clients on a person buddy list that they have logged on/off.
+ /**
+ * Send a notification to all player (non GM/Dev) clients on a person buddy list that they have logged on/off.
*
- * This does a database hit.
+ * This does a database hit.
*
- * @param client The client that has logged in/out.
- * @param loggedon True if the player has logged on. False if logged off.
+ * @param client The client that has logged in/out.
+ * @param loggedon True if the player has logged on. False if logged off.
*/
void NotifyPlayerBuddies(Client * client, bool loggedon);
- /** @brief Send a notification to all clients on a person guild if they log on/off.
+ /**
+ * Send a notification to all clients on a person guild if they log on/off.
*
- * @param client The client that has logged in/out.
- * @param loggedon True if the player has logged on. False if logged off.
+ * @param client The client that has logged in/out.
+ * @param loggedon True if the player has logged on. False if logged off.
*/
void NotifyGuildBuddies(Client * client, bool loggedon);
- /** @brief Send a notification to all clients on a person alliance if they log on/off.
- * @note This function excludes the same guild to avoid repetitions with notifyGuildBuddies.
+ /**
+ * @brief Send a notification to all clients on a person alliance if they log on/off.
*
- * @param client The client that has logged in/out.
- * @param loggedon True if the player has logged on. False if logged off.
+ * @note This function excludes the same guild to avoid repetitions with notifyGuildBuddies.
+ *
+ * @param client The client that has logged in/out.
+ * @param loggedon True if the player has logged on. False if logged off.
*/
void NotifyAllianceBuddies(Client * client, bool loggedon);
@@ -98,36 +103,40 @@
LOGGED_ON = 1
};
- /** @brief Send a buddy list to a player.
- *
- * Sends a list of all the players that are currently on a player's buddy list.
- *
- * @param client The client that request the command..
- * @param clientnum The client id number of the requesting client.
- * @param filter True if show only buddies online. Else show all buddies.
- */
- void BuddyList(Client *client,int clientnum,bool filter);
+ /**
+ * Send a buddy list to a player.
+ *
+ * Sends a list of all the players that are currently on a player's buddy list.
+ *
+ * @param client The client that request the command..
+ * @param clientnum The client id number of the requesting client.
+ * @param filter True if show only buddies online. Else show all buddies.
+ */
+ void BuddyList(Client *client, int clientnum, bool filter);
void UserStatRegeneration();
void Ready();
- /** @brief This is called by the Pending Invite if the duel is accepted.
- *
- * @param invite This is the invitemanager structure used to invoke the invitation.
- */
+ /**
+ * This is called by the Pending Invite if the duel is accepted.
+ *
+ * @param invite This is the invitemanager structure used to invoke the invitation.
+ */
void AcceptDuel(PendingDuelInvite *invite);
- /** Calcualte a comarative difference between two characters for physical, magical, and overall level.
+ /**
+ * Calcualte a comarative difference between two characters for physical, magical, and overall level.
*
*/
void CalculateComparativeDifference(psCharacter* myCharData, psCharacter* theirCharData,
int& theirPhysicalLevel, int& theirMagicalLevel,
int& physicalDiff, int& magicalDiff, int& overallLevelComparison );
- /** @brief Sends detail information about 'charData' to 'client'.
- *
- * If 'full' is true, it contains info about HP and basic stats like Strength.
- */
+ /**
+ * Sends detail information about 'charData' to 'client'.
+ *
+ * If 'full' is true, it contains info about HP and basic stats like Strength.
+ */
void SendCharacterDescription(Client *client, gemActor *actor, bool full, bool simple, const csString & requestor);
void Attack(Stance stance, Client *client);
@@ -135,86 +144,98 @@
void SendPlayerMoney(Client *client);
- /** @brief Handles a /loot command from a player to loot something.
- *
- * @param msg The incoming user command message
- * @param client The client that request the /who
- */
- void HandleLoot(psUserCmdMessage& msg,Client *client);
+ /**
+ * Handles a /loot command from a player to loot something.
+ *
+ * @param msg The incoming user command message
+ * @param client The client that request the /who
+ */
+ void HandleLoot(psUserCmdMessage& msg, Client *client);
- /** @brief Attempt to loot the target
- *
- * Sends the lootable item to the client and splits any loot money across
- * a group ( if present ).
- *
- * @param msg The incoming user command message
- * @param client The client where the loot command came from.
- */
+ /**
+ * Attempt to loot the target
+ *
+ * Sends the lootable item to the client and splits any loot money across
+ * a group ( if present ).
+ *
+ * @param client The client where the loot command came from.
+ */
void Loot(Client *client);
- /** Load emotes from xml.
- * @param xmlfile A point to a string containing the xml file.
- * @param vfs A pointer to an iVFS object.
- * @return bool FALSE if there were problems with the passed xml file.
+ /**
+ * Load emotes from xml.
+ *
+ * @param xmlfile A point to a string containing the xml file.
+ * @param vfs A pointer to an iVFS object.
+ * @return bool FALSE if there were problems with the passed xml file.
*/
bool LoadEmotes(const char *xmlfile, iVFS *vfs);
- /** @brief Check to see if command is an emote.
+ /**
+ * Check to see if command is an emote.
*
- * @param command The command in question.
- * @param execute Execute the emote or not.
+ * @param command The command in question.
+ * @param execute Execute the emote or not.
+ * @param actor The actor.
*/
bool CheckForEmote(csString command, bool execute, gemActor *actor);
- /** @brief Process an emote command.
+ /**
+ * Process an emote command.
*
- * @param general The phrase to broadcast if no target is selected.
- * @param specific The phrase to broadcast if a target is selected.
- * @param animation The animation for the emote. If there isn't one pass "noanim".
+ * @param general The phrase to broadcast if no target is selected.
+ * @param specific The phrase to broadcast if a target is selected.
+ * @param animation The animation for the emote. If there isn't one pass "noanim".
+ * @param actor The actor.
*/
void Emote(csString general, csString specific, csString animation, gemActor *actor);
- /** Handles the /mount command
- * @param rider The actor which is going to mount
- * @param mount The actor which is going to be mounted.
+ /**
+ * Handles the /mount command
+ * @param rider The actor which is going to mount
+ * @param mount The actor which is going to be mounted.
*/
void Mount(gemActor *rider, gemActor *mount);
protected:
- /** @brief Send a list of the players that are online to a client.
- *
- * Sends the name/guild/rank of all players in the world.
- *
- * @param msg The incoming user command message
- * @param client The client that request the /who
- */
+ /**
+ * Send a list of the players that are online to a client.
+ *
+ * Sends the name/guild/rank of all players in the world.
+ *
+ * @param msg The incoming user command message
+ * @param client The client that request the /who
+ */
void Who(psUserCmdMessage& msg, Client* client);
- /** @brief Formats output of a player and adds it to a message.
- *
- * @param client The client that is to be formated
- * @param guildId The guildId of the caller
- * @param message The target csString object
- * @param filter What clients
- * @param check If a check against filter should be done
- * @param count COunter to be increased in case of a successfull match
- */
+ /**
+ * Formats output of a player and adds it to a message.
+ *
+ * @param curr The client that is to be formated
+ * @param guildId The guildId of the caller
+ * @param message The target csString object
+ * @param filter What clients
+ * @param check If a check against filter should be done
+ * @param count COunter to be increased in case of a successfull match
+ */
bool WhoProcessClient(Client *curr, int guildId, csString* message, csString filter, bool check, unsigned * count);
- /** @brief Converts a string to lowercase.
- *
- * @param str The string.
- */
+ /**
+ * Converts a string to lowercase.
+ *
+ * @param str The string.
+ */
void StrToLowerCase(csString& str);
- /** @brief Adds/removes a person to a player's buddy list.
- *
- * This does a database hit to add/remove to the buddy table.
- *
- * @param msg The incoming user command message.
- * @param client The client that request the /buddy.
- */
+ /**
+ * Adds/removes a person to a player's buddy list.
+ *
+ * This does a database hit to add/remove to the buddy table.
+ *
+ * @param msg The incoming user command message.
+ * @param client The client that request the /buddy.
+ */
void Buddy(psUserCmdMessage& msg,Client *client);
enum
@@ -224,273 +245,340 @@
};
- /** @brief Calculates a dice roll from a player based on number of die and sides.
- *
- * @param msg The incoming user command message.
- * @param client The client that request the command.
- */
- void RollDice(psUserCmdMessage& msg,Client *client);
+ /**
+ * Calculates a dice roll from a player based on number of die and sides.
+ *
+ * @param msg The incoming user command message.
+ * @param client The client that request the command.
+ */
+ void RollDice(psUserCmdMessage& msg, Client *client);
- /** @brief Sends the player their current position and sector.
- *
- * @param msg The incoming user command message.
- * @param client The client that request the command.
- */
- void ReportPosition(psUserCmdMessage& msg,Client *client);
+ /**
+ * Sends the player their current position and sector.
+ *
+ * @param msg The incoming user command message.
+ * @param client The client that request the command.
+ */
+ void ReportPosition(psUserCmdMessage& msg, Client *client);
- /* @brief Moves a player back to the default start point for their race.
- *
- * @param msg The incoming user command message.
- * @param client The client that request the command..
- *
+ /*
+ * Moves a player back to the default start point for their race.
+ *
+ * @param msg The incoming user command message.
+ * @param client The client that request the command..
+ *
void MoveToSpawnPos(psUserCmdMessage& msg,Client *client,int clientnum); */
- /** @brief Moves a player back to his last valid position.
- *
- * @param msg The incoming user command message.
- * @param client The client that request the command.
- */
+ /**
+ * Moves a player back to his last valid position.
+ *
+ * @param msg The incoming user command message.
+ * @param client The client that request the command.
+ */
void HandleUnstick(psUserCmdMessage& msg,Client *client);
- /** @brief Helper function to log a stuck character's details.
+ /**
+ * Helper function to log a stuck character's details.
*
- * @param The client that requested to be unstuck.
+ * @param client The client that requested to be unstuck.
*/
void LogStuck(Client* client);
- /** @brief Helper function to make the character stop attacking.
+ /**
+ * Helper function to make the character stop attacking.
*
* @param client The client that needs to stop attacking.
*/
void StopAllCombat(Client* client);
- /** @brief Command to start attacking something. Starts the combat manager
- * working.
- *
- * @param msg The incoming user command message.
- * @param client The client that request the command.
- */
- void HandleAttack(psUserCmdMessage& msg,Client *client);
+ /**
+ * Command to start attacking something. Starts the combat manager
+ * working.
+ *
+ * @param msg The incoming user command message.
+ * @param client The client that request the command.
+ */
+ void HandleAttack(psUserCmdMessage& msg, Client *client);
- /** @brief Command to stop attacking your target
- *
- * @param msg The incoming user command message.
- * @param client The client that request the command.
- */
- void HandleStopAttack(psUserCmdMessage& msg,Client *client);
+ /**
+ * Command to stop attacking your target.
+ *
+ * @param msg The incoming user command message.
+ * @param client The client that request the command.
+ */
+ void HandleStopAttack(psUserCmdMessage& msg, Client *client);
- /** @brief Command to challenge someone to a duel.
- *
- * @param msg The incoming user command message.
- * @param client The client that request the command..
- */
- void ChallengeToDuel(psUserCmdMessage& msg,Client *client);
+ /**
+ * Command to challenge someone to a duel.
+ *
+ * @param msg The incoming user command message.
+ * @param client The client that request the command..
+ */
+ void ChallengeToDuel(psUserCmdMessage& msg, Client *client);
- /** @brief Command to surrender to someone in a duel.
- *
- * @param client The client that request the command..
- */
+ /**
+ * Command to surrender to someone in a duel.
+ *
+ * @param client The client that request the command..
+ */
void YieldDuel(Client *client);
- /** @brief Handle the yield command
- *
- * @param msg The incoming user command message.
- * @param client The client that request the command..
- */
- void HandleYield(psUserCmdMessage& msg,Client *client);
+ /**
+ * Handle the yield command
+ *
+ * @param msg The incoming user command message.
+ * @param client The client that request the command..
+ */
+ void HandleYield(psUserCmdMessage& msg, Client *client);
- /// Handle the /starttrading command
- void StartTrading(psUserCmdMessage& msg,Client *client);
+ /**
+ * Handle the /starttrading command.
+ */
+ void StartTrading(psUserCmdMessage& msg, Client *client);
- /// Handle the /stoptrading command
- void StopTrading(psUserCmdMessage& msg,Client *client);
+ /**
+ * Handle the /stoptrading command.
+ */
+ void StopTrading(psUserCmdMessage& msg, Client *client);
- /** @brief Command to marry/divorce someone
+ /**
+ * Command to marry/divorce someone
*
* @param msg The incoming user command message.
* @param client The client that request the command..
*/
void HandleMarriage(psUserCmdMessage& msg,Client *client);
- /** @brief Sends a client a list of their current assigned quests.
+ /**
+ * Sends a client a list of their current assigned quests.
*
- * @param client The requesting client.
+ * @param client The requesting client.
*/
void HandleQuests(Client *client);
- /** @brief Sends a client a list of their current assigned quests and events
+ /**
+ * Sends a client a list of their current assigned quests and events
*
- * @param msg The incoming user command message.
- * @param client The requesting client.
+ * @param msg The incoming user command message.
+ * @param client The requesting client.
*/
void HandleQuestsCommand(psUserCmdMessage& msg,Client *client);
- /** @brief Sends a client a list of their current assigned event.
- * @param client: the requesting client.
+ /**
+ * Sends a client a list of their current assigned event.
+ *
+ * @param client The requesting client.
*/
void HandleGMEvents(Client* client);
- /** @brief Give a tip from the database to the client
+ /**
+ * Give a tip from the database to the client
*
- * @param msg The incoming user command message
- * @param the client who sit
+ * @param msg The incoming user command message
+ * @param client The client who sit
*/
void GiveTip(psUserCmdMessage& msg, Client *client);
- /** @brief Sends the MOTD to the client
- *
- * @param msg The incoming user command message
- * @param the client who sit
- */
+ /**
+ * Sends the MOTD to the client
+ *
+ * @param msg The incoming user command message
+ * @param client the client who sit
+ */
void GiveMOTD(psUserCmdMessage& msg, Client *client);
- /** @brief Handles a player command to show the popup dialog menu of the currently targeted NPC, if any.
- *
- * @param msg The incoming user command message
- * @param client The client that issued the command.
- */
+ /**
+ * Handles a player command to show the popup dialog menu of the currently targeted NPC, if any.
+ *
+ * @param msg The incoming user command message
+ * @param client The client that issued the command.
+ */
void ShowNpcMenu(psUserCmdMessage& msg, Client *client);
/**
* @brief Handles a player command to sit down
*
* @param msg The incoming user command message
- * @param the client who sit
+ * @param client The client who sit
*/
void HandleSit(psUserCmdMessage& msg, Client *client);
- /** @brief Handles the /admin command
- *
- * @param msg The incoming user command message
- * @param the client who sit
- */
+ /**
+ * Handles the /admin command
+ *
+ * @param msg The incoming user command message.
+ * @param client The client who issues the admin command.
+ */
void HandleAdminCommand(psUserCmdMessage& msg, Client *client);
/**
- * @brief Handles a player command to stand up
+ * Handles a player command to stand up.
*
- * @param msg The incoming user command message
- * @param the client who stand
+ * @param msg The incoming user command message.
+ * @param client The client who stand.
*/
void HandleStand(psUserCmdMessage& msg, Client *client);
- /** @brief Handles a player command to die
+ /**
+ * Handles a player command to die
*
- * @param msg The incoming user command message
- * @param the client who stand
+ * @param msg The incoming user command message
+ * @param client The client who die
*/
void HandleDie(psUserCmdMessage& msg, Client *client);
- /** @brief Handles a player command to start training with targeted entity.
- *
- * @param the user command message
- * @param client The client that issued the command.
- */
+ /**
+ * Handles a player command to start training with targeted entity.
+ *
+ * @param msg The user command message
+ * @param client The client that issued the command.
+ */
void HandleTraining(psUserCmdMessage& msg, Client *client);
- /** @brief Handles a player command to start banking with the targeted entity.
+ /**
+ * Handles a player command to start banking with the targeted entity.
*
* @param msg The incoming user command message
* @param client The client that issued the command.
*/
void HandleBanking(psUserCmdMessage& msg, Client *client);
- /// Handle the /pickup command, send it to Pickup()
+ /**
+ * Handle the /pickup command, send it to Pickup()
+ */
void HandlePickup(psUserCmdMessage& msg, Client *client);
- /** @brief Handles a player command to pickup an item.
- *
- * @param client The client that issued the command.
- * @param target description of the item to be picked up.
- */
+ /**
+ * Handles a player command to pickup an item.
+ *
+ * @param client The client that issued the command.
+ * @param target description of the item to be picked up.
+ */
void Pickup(Client *client, csString target);
- /** @brief Handles a player command to mount.
- *
- * @param msg the user command message
- * @param client The client that issued the command.
- */
+ /**
+ *Handles a player command to mount.
+ *
+ * @param msg the user command message
+ * @param client The client that issued the command.
+ */
void HandleMount(psUserCmdMessage& msg, Client *client);
- /** @brief Handles a player command to unmount.
- *
- * @param msg the user command message
- * @param client The client that issued the command.
- */
+ /**
+ * Handles a player command to unmount.
+ *
+ * @param msg the user command message
+ * @param client The client that issued the command.
+ */
void HandleUnmount(psUserCmdMessage& msg, Client *client);
- /// Handle the /guard command, send it to Guard()
+ /**
+ * Handle the /guard command, send it to Guard()
+ */
void HandleGuard(psUserCmdMessage& msg, Client *client);
- /** @brief Handles a player command to guard/unguard an item.
- *
- * If the action parameter is empty, the guarding status
- * of the item will be toggled.
- *
- * @param client The client that issued the command.
- * @param object pointer to the item to be guarded/unguarded.
- * @param action value can be "on" or "off"
- */
+ /**
+ * Handles a player command to guard/unguard an item.
+ *
+ * If the action parameter is empty, the guarding status
+ * of the item will be toggled.
+ *
+ * @param client The client that issued the command.
+ * @param object pointer to the item to be guarded/unguarded.
+ * @param action value can be "on" or "off"
+ */
void Guard(Client *client, gemObject *object, csString action);
- /// Handle the /rotate command, send it to Rotate()
+ /**
+ * Handle the /rotate command, send it to Rotate()
+ */
void HandleRotate(psUserCmdMessage& msg, Client *client);
- /** @brief Handles a player command to rotate an item.
- *
- * @param client The client that issued the command.
- * @param target pointer to the item to be rotated.
- * @param action rotation data
- */
+ /**
+ * Handles a player command to rotate an item.
+ *
+ * @param client The client that issued the command.
+ * @param target pointer to the item to be rotated.
+ * @param action rotation data
+ */
void Rotate(Client *client, gemObject* target, csString action);
- /** @brief Handles a player request to 'use' the targeted item.
- *
- * @param client The client that issued the command.
- * @param on Toggle for start/stop using.
- */
+ /**
+ * Handles a player request to 'use' the targeted item.
+ *
+ * @param client The client that issued the command.
+ * @param on Toggle for start/stop using.
+ */
void HandleUse(Client *client, bool on);
- /** @brief Handles an /Assist command comming from the client.
+ /**
+ * Handles an /Assist command comming from the client.
*
- * @param msg The incoming command message
- * @param client A pointer to the client struct.
+ * @param msg The incoming command message
+ * @param client A pointer to the client struct.
*/
void Assist( psUserCmdMessage& msg, Client* client);
- /** @brief Sends to client the MOTD and tip, and his guild's MOTD if needed
+ /**
+ * Sends to client the MOTD and tip, and his guild's MOTD if needed
*
* @param me The incoming message
* @param client the client to send the message to
*/
void HandleMOTDRequest(MsgEntry *me,Client *client);
- /// Take a user command from a client, and send it to be handled by a function
+ /**
+ * Take a user command from a client, and send it to be handled by a function.
+ */
void HandleUserCommand(MsgEntry *me,Client *client);
- /// Handle a message to update a character's description
+ /**
+ * Handle a message to update a character's description.
+ */
void HandleCharDescUpdate(MsgEntry *me,Client *client);
- /// Handle a request to send a character description
+ /**
+ * Handle a request to send a character description.
+ */
void HandleCharDetailsRequest(MsgEntry *me,Client *client);
+
+ /**
+ *
+ */
void HandleTargetEvent(MsgEntry *me,Client *client);
+
+ /**
+ *
+ */
void HandleEntranceMessage( MsgEntry* me, Client *client );
+
+ /**
+ *
+ */
void HandleClientReady( MsgEntry* me, Client *client );
- /** Handle taking all items from a container.
- * @param me The message from the client which will be analyzed.
- * @param client The client which sent the message.
+ /**
+ * Handle taking all items from a container.
+ *
+ * @param me The message from the client which will be analyzed.
+ * @param client The client which sent the message.
*/
void HandleTakeAll(psUserCmdMessage& me, Client *client);
- /** Handle taking all items from a container ignoring some qualities when stacking.
- * @param me The message from the client which will be analyzed.
- * @param client The client which sent the message.
+
+ /**
+ * Handle taking all items from a container ignoring some qualities when stacking.
+ *
+ * @param me The message from the client which will be analyzed.
+ * @param client The client which sent the message.
*/
void HandleTakeStackAll(psUserCmdMessage& me, Client *client);
+ /**
+ *
+ */
void SwitchAttackTarget(Client *targeter, Client *targeted);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|