ServerScript Class Reference

#include "ServerScript.h"

Inheritance diagram for ServerScript:

Public Member Functions
virtual void	OnNetworkStart ()
virtual void	OnNetworkStop ()
virtual void	OnSocketOpen (std::shared_ptr< WorldSocket > const &)
virtual void	OnSocketClose (std::shared_ptr< WorldSocket > const &)
virtual bool	CanPacketSend (WorldSession *, WorldPacket const &)
	This hook is called when a packet is sent to a client.
virtual bool	CanPacketReceive (WorldSession *, WorldPacket const &)
	Called when a (valid) packet is received by a client. Make sure to check WorldSession pointer before usage, it might be null in case of auth packets.
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
	ServerScript (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

ServerScript()

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

protected

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

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

Member Function Documentation

CanPacketReceive()

virtual bool ServerScript::CanPacketReceive ( WorldSession *  , WorldPacket const &    )

inlinevirtual

Called when a (valid) packet is received by a client. Make sure to check WorldSession pointer before usage, it might be null in case of auth packets.

Parameters

session	Contains information about the WorldSession
packet	Contains information about the WorldPacket

Returns

True if you want to continue receiving the packet, false if you want to disallow receiving the packet

{ return true; }

Referenced by ScriptMgr::CanPacketReceive().

CanPacketSend()

virtual bool ServerScript::CanPacketSend ( WorldSession *  , WorldPacket const &    )

inlinevirtual

This hook is called when a packet is sent to a client.

Parameters

session	Contains information about the WorldSession
packet	Contains information about the WorldPacket

Returns

True if you want to continue sending the packet, false if you want to disallow sending the packet

{ return true; }

Referenced by ScriptMgr::CanPacketSend().

OnNetworkStart()

virtual void ServerScript::OnNetworkStart ( )

inlinevirtual

{ }

Referenced by ScriptMgr::OnNetworkStart().

OnNetworkStop()

virtual void ServerScript::OnNetworkStop ( )

inlinevirtual

{ }

Referenced by ScriptMgr::OnNetworkStop().

OnSocketClose()

virtual void ServerScript::OnSocketClose ( std::shared_ptr< WorldSocket > const &  )

inlinevirtual

{ }

Referenced by ScriptMgr::OnSocketClose().

OnSocketOpen()

virtual void ServerScript::OnSocketOpen ( std::shared_ptr< WorldSocket > const &  )

inlinevirtual

{ }

Referenced by ScriptMgr::OnSocketOpen().

---

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

• azerothcore-wotlk/src/server/game/Scripting/ScriptDefines/ServerScript.h
• azerothcore-wotlk/src/server/game/Scripting/ScriptDefines/ServerScript.cpp