Botcraft::ConnectionClient Class Reference

The base client handling connection with a server. More...

#include <ConnectionClient.hpp>

Inheritance diagram for Botcraft::ConnectionClient:

Public Member Functions
	ConnectionClient ()
virtual	~ConnectionClient ()
void	Connect (const std::string &address, const std::string &login, const bool force_microsoft_account=false)
	Connect the client to the server at address.
virtual void	Disconnect ()
bool	GetShouldBeClosed () const
void	SetShouldBeClosed (const bool b)
std::shared_ptr< NetworkManager >	GetNetworkManager () const
void	SendChatMessage (const std::string &msg)
	Send a message in the game chat.
void	SendChatCommand (const std::string &command)
	Send a command in the game chat.
void	Respawn ()
	Ask to respawn when dead.

Protected Member Functions
virtual void	Handle (ProtocolCraft::ClientboundLoginDisconnectPacket &msg) override
virtual void	Handle (ProtocolCraft::ClientboundDisconnectPacket &msg) override
virtual void	Handle (ProtocolCraft::ClientboundPlayerPositionPacket &msg) override
virtual void	Handle (ProtocolCraft::ClientboundDisconnectConfigurationPacket &msg) override
virtual void	Handle (ProtocolCraft::ClientboundLoginPacket &msg) override
virtual void	Handle (ProtocolCraft::ClientboundRespawnPacket &msg) override

Protected Attributes
std::shared_ptr< NetworkManager >	network_manager
bool	should_be_closed

Detailed Description

The base client handling connection with a server.

Only processes packets required to maintain the connection.

Definition at line 11 of file ConnectionClient.hpp.

Constructor & Destructor Documentation

ConnectionClient()

Botcraft::ConnectionClient::ConnectionClient

(

)

Definition at line 9 of file ConnectionClient.cpp.

References network_manager, and should_be_closed.

~ConnectionClient()

Botcraft::ConnectionClient::~ConnectionClient ( )

virtual

Definition at line 15 of file ConnectionClient.cpp.

References Disconnect().

Member Function Documentation

Connect()

void Botcraft::ConnectionClient::Connect	(	const std::string &	address,
		const std::string &	login,
		const bool	force_microsoft_account = false
	)

Connect the client to the server at address.

Parameters

address	Address to connect to, as written in minecraft multiplayer window
login	If login is empty, will try to connect with a Microsoft account
force_microsoft_account	If true, then Microsoft auth flow will be used. In this case, login is used as key to cache the credentials

Definition at line 20 of file ConnectionClient.cpp.

References network_manager.

Disconnect()

void Botcraft::ConnectionClient::Disconnect ( )

virtual

Reimplemented in Botcraft::ManagersClient.

Definition at line 25 of file ConnectionClient.cpp.

References network_manager, and should_be_closed.

Referenced by Botcraft::ManagersClient::Disconnect(), and ~ConnectionClient().

GetNetworkManager()

std::shared_ptr< NetworkManager > Botcraft::ConnectionClient::GetNetworkManager

(

)

const

Definition at line 45 of file ConnectionClient.cpp.

Referenced by Botcraft::CloseContainerImpl(), Botcraft::DigImpl(), Botcraft::EatImpl(), Botcraft::GoToImpl(), Botcraft::InteractEntityImpl(), Botcraft::InteractWithBlockImpl(), Botcraft::PlaceBlockImpl(), Botcraft::TradeImpl(), and Botcraft::TemplatedBehaviourClient< TDerived >::TreeLoop().

GetShouldBeClosed()

bool Botcraft::ConnectionClient::GetShouldBeClosed

(

)

const

Definition at line 35 of file ConnectionClient.cpp.

References should_be_closed.

Handle() [1/6]

void Botcraft::ConnectionClient::Handle ( ProtocolCraft::ClientboundDisconnectConfigurationPacket &  msg )

overrideprotectedvirtual

Reimplemented in Botcraft::ManagersClient.

Definition at line 126 of file ConnectionClient.cpp.

References ProtocolCraft::Json::Value::Dump(), LOG_INFO, ProtocolCraft::NetworkType::Serialize(), and should_be_closed.

Handle() [2/6]

void Botcraft::ConnectionClient::Handle ( ProtocolCraft::ClientboundDisconnectPacket &  msg )

overrideprotectedvirtual

Reimplemented in Botcraft::ManagersClient.

Definition at line 105 of file ConnectionClient.cpp.

References ProtocolCraft::Json::Value::Dump(), LOG_INFO, ProtocolCraft::NetworkType::Serialize(), and should_be_closed.

Handle() [3/6]

void Botcraft::ConnectionClient::Handle ( ProtocolCraft::ClientboundLoginDisconnectPacket &  msg )

overrideprotectedvirtual

Reimplemented in Botcraft::ManagersClient.

Definition at line 77 of file ConnectionClient.cpp.

References LOG_INFO, and should_be_closed.

Referenced by Botcraft::ManagersClient::Handle(), and Botcraft::ManagersClient::Handle().

Handle() [4/6]

void Botcraft::ConnectionClient::Handle ( ProtocolCraft::ClientboundLoginPacket &  msg )

overrideprotectedvirtual

Reimplemented in Botcraft::ManagersClient, and Botcraft::ManagersClient.

Definition at line 139 of file ConnectionClient.cpp.

References network_manager.

Handle() [5/6]

void Botcraft::ConnectionClient::Handle ( ProtocolCraft::ClientboundPlayerPositionPacket &  msg )

overrideprotectedvirtual

Reimplemented in Botcraft::ManagersClient, and Botcraft::ManagersClient.

Definition at line 116 of file ConnectionClient.cpp.

References network_manager.

Handle() [6/6]

void Botcraft::ConnectionClient::Handle ( ProtocolCraft::ClientboundRespawnPacket &  msg )

overrideprotectedvirtual

Reimplemented in Botcraft::ManagersClient, and Botcraft::ManagersClient.

Definition at line 144 of file ConnectionClient.cpp.

References network_manager.

Respawn()

void Botcraft::ConnectionClient::Respawn

(

)

Ask to respawn when dead.

Definition at line 66 of file ConnectionClient.cpp.

References network_manager.

Referenced by Botcraft::ManagersClient::Handle().

SendChatCommand()

void Botcraft::ConnectionClient::SendChatCommand

(

const std::string &

command

)

Send a command in the game chat.

Parameters

command

The command to send (with no / at start)

Definition at line 58 of file ConnectionClient.cpp.

References network_manager.

SendChatMessage()

void Botcraft::ConnectionClient::SendChatMessage

(

const std::string &

msg

)

Send a message in the game chat.

Parameters

msg	The message to send

Definition at line 50 of file ConnectionClient.cpp.

Referenced by Botcraft::SayImpl().

SetShouldBeClosed()

void Botcraft::ConnectionClient::SetShouldBeClosed

(

const bool

b

)

Definition at line 40 of file ConnectionClient.cpp.

Referenced by Botcraft::Disconnect().

Member Data Documentation

network_manager

std::shared_ptr<NetworkManager> Botcraft::ConnectionClient::network_manager

protected

Definition at line 57 of file ConnectionClient.hpp.

Referenced by Botcraft::TemplatedBehaviourClient< TDerived >::BehaviourStep(), Connect(), ConnectionClient(), Disconnect(), Botcraft::ManagersClient::Disconnect(), Botcraft::ManagersClient::GetPlayerName(), Handle(), Botcraft::ManagersClient::Handle(), Handle(), Handle(), Botcraft::ManagersClient::Handle(), Respawn(), SendChatCommand(), and Botcraft::ManagersClient::SendInventoryTransaction().

should_be_closed

bool Botcraft::ConnectionClient::should_be_closed

protected

Definition at line 59 of file ConnectionClient.hpp.

Referenced by Botcraft::TemplatedBehaviourClient< TDerived >::BehaviourStep(), ConnectionClient(), Disconnect(), GetShouldBeClosed(), Handle(), Handle(), Handle(), Botcraft::TemplatedBehaviourClient< TDerived >::RunBehaviourUntilClosed(), Botcraft::TemplatedBehaviourClient< TDerived >::SyncAction(), Botcraft::TemplatedBehaviourClient< TDerived >::Yield(), and Botcraft::TemplatedBehaviourClient< TDerived >::~TemplatedBehaviourClient().

---

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

• botcraft/include/botcraft/Game/ConnectionClient.hpp
• botcraft/src/Game/ConnectionClient.cpp