deserter_commandscript Class Reference

Public Member Functions
	deserter_commandscript ()
std::vector< ChatCommand >	GetCommands () const override
	Returns the command structure for the system. More...
Public Member Functions inherited from ScriptObject
const std::string &	GetName () const

Static Public Member Functions
static bool	HandleDeserterAdd (ChatHandler *handler, char const *args, bool isInstance)
	Applies the Deserter Debuff to a player. More...
static bool	HandleDeserterRemove (ChatHandler *handler, char const *, bool isInstance)
	Removes the Deserter Debuff from a player. More...
static bool	HandleDeserterInstanceAdd (ChatHandler *handler, char const *args)
static bool	HandleDeserterBGAdd (ChatHandler *handler, char const *args)
static bool	HandleDeserterInstanceRemove (ChatHandler *handler, char const *args)
static bool	HandleDeserterBGRemove (ChatHandler *handler, char const *args)

Additional Inherited Members
Protected Member Functions inherited from CommandScript
	CommandScript (const char *name)
Protected Member Functions inherited from ScriptObject
	ScriptObject (const char *name)
virtual	~ScriptObject ()

Constructor & Destructor Documentation

deserter_commandscript::deserter_commandscript ( )

inline

: CommandScript("deserter_commandscript") { }

Member Function Documentation

std::vector<ChatCommand> deserter_commandscript::GetCommands ( ) const

inlineoverridevirtual

Returns the command structure for the system.

Implements CommandScript.

 {
 static std::vector<ChatCommand> deserterInstanceCommandTable =
 {
 { "add", rbac::RBAC_PERM_COMMAND_DESERTER_INSTANCE_ADD, false, &HandleDeserterInstanceAdd, "" },
 { "remove", rbac::RBAC_PERM_COMMAND_DESERTER_INSTANCE_REMOVE, false, &HandleDeserterInstanceRemove, "" },
 };
 static std::vector<ChatCommand> deserterBGCommandTable =
 {
 { "add", rbac::RBAC_PERM_COMMAND_DESERTER_BG_ADD, false, &HandleDeserterBGAdd, "" },
 { "remove", rbac::RBAC_PERM_COMMAND_DESERTER_BG_REMOVE, false, &HandleDeserterBGRemove, "" },
 };

 static std::vector<ChatCommand> deserterCommandTable =
 {
 { "instance", rbac::RBAC_PERM_COMMAND_DESERTER_INSTANCE, false, NULL, "", deserterInstanceCommandTable },
 { "bg", rbac::RBAC_PERM_COMMAND_DESERTER_BG, false, NULL, "", deserterBGCommandTable },
 };
 static std::vector<ChatCommand> commandTable =
 {
 { "deserter", rbac::RBAC_PERM_COMMAND_DESERTER, false, NULL, "", deserterCommandTable },
 };
 return commandTable;
 }

Here is the call graph for this function:

static bool deserter_commandscript::HandleDeserterAdd ( ChatHandler *  handler, char const *  args, bool  isInstance  )

inlinestatic

Applies the Deserter Debuff to a player.

This function applies a Deserter Debuff of the given type (Instance or BG) to the selected player, with the provided duration in seconds.

Parameters

handler	The ChatHandler, passed by the system.
args	The provided duration in seconds.
isInstance	provided by the relaying functions, so we don't have to write that much code :)

Returns

true if everything was correct, false if an error occured.

Example Usage:

.deserter instance add 3600 (one hour)
-or-
.deserter bg add 3600 (one hour)

 {
 if (!*args)
 return false;

 Player* player = handler->getSelectedPlayer();
 if (!player)
 {
 handler->SendSysMessage(LANG_NO_CHAR_SELECTED);
 handler->SetSentErrorMessage(true);
 return false;
 }
 char* timeStr = strtok((char*)args, " ");
 if (!timeStr)
 {
 handler->SendSysMessage(LANG_BAD_VALUE);
 handler->SetSentErrorMessage(true);
 return false;
 }
 uint32 time = atoi(timeStr);

 if (!time)
 {
 handler->SendSysMessage(LANG_BAD_VALUE);
 handler->SetSentErrorMessage(true);
 return false;
 }

 Aura* aura = player->AddAura(isInstance ? LFG_SPELL_DUNGEON_DESERTER : BG_SPELL_DESERTER, player);

 if (!aura)
 {
 handler->SendSysMessage(LANG_BAD_VALUE);
 handler->SetSentErrorMessage(true);
 return false;
 }
 aura->SetDuration(time * IN_MILLISECONDS);

 return true;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

static bool deserter_commandscript::HandleDeserterBGAdd ( ChatHandler *  handler, char const *  args  )

inlinestatic

See also

HandleDeserterAdd()

 {
 return HandleDeserterAdd(handler, args, false);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

static bool deserter_commandscript::HandleDeserterBGRemove ( ChatHandler *  handler, char const *  args  )

inlinestatic

See also

HandleDeserterRemove()

 {
 return HandleDeserterRemove(handler, args, false);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

static bool deserter_commandscript::HandleDeserterInstanceAdd ( ChatHandler *  handler, char const *  args  )

inlinestatic

See also

HandleDeserterAdd()

 {
 return HandleDeserterAdd(handler, args, true);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

static bool deserter_commandscript::HandleDeserterInstanceRemove ( ChatHandler *  handler, char const *  args  )

inlinestatic

See also

HandleDeserterRemove()

 {
 return HandleDeserterRemove(handler, args, true);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

static bool deserter_commandscript::HandleDeserterRemove ( ChatHandler *  handler, char const *  , bool  isInstance  )

inlinestatic

Removes the Deserter Debuff from a player.

This function removes a Deserter Debuff of the given type (Instance or BG) from the selected player.

Parameters

handler	The ChatHandler, passed by the system.
args	Should be nothing.
isInstance	provided by the relaying functions, so we don't have to write that much code :)

Returns

true if everything was correct, false if an error occured.

Example Usage:

.deserter instance remove
-or-
.deserter bg remove

 {
 Player* player = handler->getSelectedPlayer();
 if (!player)
 {
 handler->SendSysMessage(LANG_NO_CHAR_SELECTED);
 handler->SetSentErrorMessage(true);
 return false;
 }

 player->RemoveAura(isInstance ? LFG_SPELL_DUNGEON_DESERTER : BG_SPELL_DESERTER);

 return true;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• src/server/scripts/Commands/cs_deserter.cpp