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 >)
virtual void	OnSocketClose (std::shared_ptr< WorldSocket >)
virtual bool	CanPacketSend (WorldSession *, WorldPacket &)
	This hook called when a packet is sent to a client. The packet object is a copy of the original packet, so reading and modifying it is safe. More...
virtual bool	CanPacketReceive (WorldSession *, WorldPacket &)
	Called when a (valid) packet is received by a client. The packet object is a copy of the original packet, so reading and modifying it is safe. Make sure to check WorldSession pointer before usage, it might be null in case of auth packets. 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
	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 &    )

inlinevirtual

Called when a (valid) packet is received by a client. The packet object is a copy of the original packet, so reading and modifying it is safe. 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 receive the packet, false if you want to disallow receive the packet

{ return true; }

CanPacketSend()

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

inlinevirtual

This hook called when a packet is sent to a client. The packet object is a copy of the original packet, so reading and modifying it is safe.

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; }

OnNetworkStart()

virtual void ServerScript::OnNetworkStart ( )

inlinevirtual

{ }

OnNetworkStop()

virtual void ServerScript::OnNetworkStop ( )

inlinevirtual

{ }

OnSocketClose()

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

inlinevirtual

{ }

OnSocketOpen()

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

inlinevirtual

{ }