RakNet::Clans_Leave Struct Reference
[Lobby2Commands]
Remove user identified by myPrimaryKey from clan identified by clanHandle.
More...
#include <Lobby2Message.h>
Public Member Functions | |
| virtual bool | RequiresAdmin (void) const |
| virtual bool | RequiresRankingPermission (void) const |
| virtual bool | CancelOnDisconnect (void) const |
| virtual bool | RequiresLogin (void) const |
| virtual void | Serialize (bool writeToBitstream, bool serializeOutput, RakNet::BitStream *bitStream) |
| Overridable serialization of the contents of this message. Defaults to SerializeBase(). | |
| virtual bool | PrevalidateInput (void) |
Detailed Description
Remove user identified by myPrimaryKey from clan identified by clanHandle.If this user is the leader of the clan, and dissolveIfClanLeader is true, then also destroy the clan and remove all members from the clan, as well as all data associated with the clan (clan boards, join requests, etc). If the clan is automatically destroyed in this way, use Emails_Send() to each clan member with clanDissolvedSubject and clanDissolvedBody. The sender of the email should be the clan leader. If the clan is not destroyed, then leadership passes to the oldest subleader. If no subleaders exist, leadership passes to the oldest member. If no other members exist, the clan is destroyed.
Member Function Documentation
| virtual bool RakNet::Clans_Leave::CancelOnDisconnect | ( | void | ) | const [inline, virtual] |
Should this message not be processed on the server if the requesting user disconnects before it completes? This should be true for functions that only return data. False for functions that affect other users, or change the database
Implements RakNet::Lobby2Message.
| virtual bool RakNet::Clans_Leave::PrevalidateInput | ( | void | ) | [virtual] |
If data members can be validated for correctness in the server's main thread, override this function and do those checks here.
- Returns:
- True for input OK. False if the input is bad and does not need to be further processed in the database threads.
Reimplemented from RakNet::Lobby2Message.
| virtual bool RakNet::Clans_Leave::RequiresAdmin | ( | void | ) | const [inline, virtual] |
Is this message something that should only be run by a system with admin privileges? Set admin privileges with Lobby2Server::AddAdminAddress()
Implements RakNet::Lobby2Message.
| virtual bool RakNet::Clans_Leave::RequiresLogin | ( | void | ) | const [inline, virtual] |
Does this function require logging into the server before it can be executed? If true, the user id and user handle will be automatically inferred by the last login by looking up the sender's system address. If false, the message should include the username so the database query can lookup which user is performing this operation.
Implements RakNet::Lobby2Message.
| virtual bool RakNet::Clans_Leave::RequiresRankingPermission | ( | void | ) | const [inline, virtual] |
Is this message something that should only be run by a system with ranking upload priviledges? Set ranking privileges with Lobby2Server::AddRankingAddress()
Implements RakNet::Lobby2Message.
The documentation for this struct was generated from the following file:
- d:/temp/RakNet_PC/DependentExtensions/Lobby2/Lobby2Message.h
