AllCommandScript Class Reference

#include "AllCommandScript.h"

Inheritance diagram for AllCommandScript:

Public Member Functions
bool	IsDatabaseBound () const override
virtual void	OnHandleDevCommand (Player *, bool &)
virtual bool	OnTryExecuteCommand (ChatHandler &, std::string_view)
	This hook is triggered when a command is parsed, but before it is executed. More...
Public Member Functions inherited from ScriptObject
virtual bool	IsDatabaseBound () const
virtual bool	isAfterLoadScript () const
virtual void	checkValidity ()
const std::string &	GetName () const
uint16	GetTotalAvailableHooks ()

Protected Member Functions
	AllCommandScript (const char *name, std::vector< uint16 > enabledHooks=std::vector< uint16 >())
Protected Member Functions inherited from ScriptObject
	ScriptObject (const char *name, uint16 totalAvailableHooks=0)
virtual	~ScriptObject ()=default

Detailed Description

Constructor & Destructor Documentation

AllCommandScript()

AllCommandScript::AllCommandScript ( const char *  name, std::vector< uint16 >  enabledHooks = std::vector<uint16>()  )

protected

    : ScriptObject(name, ALLCOMMANDHOOK_END)
{
    // If empty - enable all available hooks.
    if (enabledHooks.empty())
        for (uint16 i = 0; i < ALLCOMMANDHOOK_END; ++i)
            enabledHooks.emplace_back(i);
 
    ScriptRegistry<AllCommandScript>::AddScript(this, std::move(enabledHooks));
}

References ScriptRegistry< TScript >::AddScript(), and ALLCOMMANDHOOK_END.

Member Function Documentation

IsDatabaseBound()

bool AllCommandScript::IsDatabaseBound ( ) const

inlineoverridevirtual

Reimplemented from ScriptObject.

{ return false; }

OnHandleDevCommand()

virtual void AllCommandScript::OnHandleDevCommand ( Player *  , bool &    )

inlinevirtual

{ }

OnTryExecuteCommand()

virtual bool AllCommandScript::OnTryExecuteCommand ( ChatHandler &  , std::string_view    )

inlinevirtual

This hook is triggered when a command is parsed, but before it is executed.

Parameters

handler	Contains information about the ChatHandler
cmdStr	Contains information about the command name

{ return true; }