minetest/src/client.h

315 lines
7.2 KiB
C
Raw Normal View History

/*
Minetest-c55
Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
2010-11-27 00:02:21 +01:00
#ifndef CLIENT_HEADER
#define CLIENT_HEADER
#ifndef SERVER
2010-11-27 00:02:21 +01:00
#include "connection.h"
#include "environment.h"
#include "common_irrlicht.h"
#include "jmutex.h"
#include <ostream>
class ClientNotReadyException : public BaseException
{
public:
ClientNotReadyException(const char *s):
BaseException(s)
{}
};
class Client;
2010-12-19 15:51:45 +01:00
class ClientUpdateThread : public SimpleThread
2010-11-27 00:02:21 +01:00
{
Client *m_client;
public:
2010-12-19 15:51:45 +01:00
ClientUpdateThread(Client *client):
SimpleThread(),
m_client(client)
2010-11-27 00:02:21 +01:00
{
}
void * Thread();
};
struct IncomingPacket
{
IncomingPacket()
{
m_data = NULL;
m_datalen = 0;
m_refcount = NULL;
}
IncomingPacket(const IncomingPacket &a)
{
m_data = a.m_data;
m_datalen = a.m_datalen;
m_refcount = a.m_refcount;
if(m_refcount != NULL)
(*m_refcount)++;
}
IncomingPacket(u8 *data, u32 datalen)
{
m_data = new u8[datalen];
memcpy(m_data, data, datalen);
m_datalen = datalen;
m_refcount = new s32(1);
}
~IncomingPacket()
{
if(m_refcount != NULL){
assert(*m_refcount > 0);
(*m_refcount)--;
if(*m_refcount == 0){
if(m_data != NULL)
delete[] m_data;
2010-12-19 15:51:45 +01:00
delete m_refcount;
2010-11-27 00:02:21 +01:00
}
}
}
/*IncomingPacket & operator=(IncomingPacket a)
{
m_data = a.m_data;
m_datalen = a.m_datalen;
m_refcount = a.m_refcount;
(*m_refcount)++;
return *this;
}*/
u8 *m_data;
u32 m_datalen;
s32 *m_refcount;
};
class Client : public con::PeerHandler
{
public:
/*
NOTE: Every public method should be thread-safe
*/
Client(
IrrlichtDevice *device,
const char *playername,
JMutex &range_mutex,
2010-12-26 02:58:19 +01:00
float &viewing_range_nodes,
bool &viewing_range_all
);
2010-11-27 00:02:21 +01:00
~Client();
/*
The name of the local player should already be set when
calling this, as it is sent in the initialization.
*/
void connect(Address address);
/*
returns true when
m_con.Connected() == true
AND m_server_ser_ver != SER_FMT_VER_INVALID
throws con::PeerNotFoundException if connection has been deleted,
eg. timed out.
*/
bool connectedAndInitialized();
/*
Stuff that references the environment is valid only as
long as this is not called. (eg. Players)
If this throws a PeerNotFoundException, the connection has
timed out.
*/
void step(float dtime);
// Called from updater thread
// Returns dtime
float asyncStep();
void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
// Returns true if something was received
2010-12-24 02:08:05 +01:00
bool AsyncProcessPacket();
2010-11-27 00:02:21 +01:00
bool AsyncProcessData();
void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
//TODO: Remove
bool isFetchingBlocks();
// Pops out a packet from the packet queue
IncomingPacket getPacket();
2010-12-21 01:25:47 +01:00
void groundAction(u8 action, v3s16 nodepos_undersurface,
2010-11-27 00:02:21 +01:00
v3s16 nodepos_oversurface, u16 item);
void clickObject(u8 button, v3s16 blockpos, s16 id, u16 item);
void sendSignText(v3s16 blockpos, s16 id, std::string text);
2010-12-22 15:30:23 +01:00
void sendInventoryAction(InventoryAction *a);
void sendChatMessage(const std::wstring &message);
// locks envlock
void removeNode(v3s16 p);
// locks envlock
void addNode(v3s16 p, MapNode n);
2010-11-27 00:02:21 +01:00
void updateCamera(v3f pos, v3f dir);
// Returns InvalidPositionException if not found
MapNode getNode(v3s16 p);
2010-12-21 01:25:47 +01:00
// Returns InvalidPositionException if not found
//void setNode(v3s16 p, MapNode n);
2010-11-27 00:02:21 +01:00
// Returns InvalidPositionException if not found
//f32 getGroundHeight(v2s16 p);
v3f getPlayerPosition();
void setPlayerControl(PlayerControl &control);
// Returns true if the inventory of the local player has been
// updated from the server. If it is true, it is set to false.
bool getLocalInventoryUpdated();
// Copies the inventory of the local player to parameter
void getLocalInventory(Inventory &dst);
// Gets closest object pointed by the shootline
// Returns NULL if not found
MapBlockObject * getSelectedObject(
f32 max_d,
v3f from_pos_f_on_map,
core::line3d<f32> shootline_on_map
);
// Prints a line or two of info
void printDebugInfo(std::ostream &os);
2010-12-18 16:46:00 +01:00
2010-12-19 15:51:45 +01:00
//s32 getDayNightIndex();
u32 getDayNightRatio();
//void updateSomeExpiredMeshes();
2010-11-27 00:02:21 +01:00
2010-12-21 01:25:47 +01:00
void setTempMod(v3s16 p, NodeMod mod)
{
JMutexAutoLock envlock(m_env_mutex);
assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
v3s16 blockpos = ((ClientMap&)m_env.getMap()).setTempMod(p, mod);
m_env.getMap().updateMeshes(blockpos, m_env.getDayNightRatio());
}
void clearTempMod(v3s16 p)
{
JMutexAutoLock envlock(m_env_mutex);
assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
v3s16 blockpos = ((ClientMap&)m_env.getMap()).clearTempMod(p);
m_env.getMap().updateMeshes(blockpos, m_env.getDayNightRatio());
}
2010-12-23 11:10:46 +01:00
float getAvgRtt()
{
JMutexAutoLock lock(m_con_mutex);
con::Peer *peer = m_con.GetPeerNoEx(PEER_ID_SERVER);
if(peer == NULL)
return 0.0;
return peer->avg_rtt;
}
bool getChatMessage(std::wstring &message)
{
if(m_chat_queue.size() == 0)
return false;
message = m_chat_queue.pop_front();
return true;
}
void addChatMessage(const std::wstring &message)
{
JMutexAutoLock envlock(m_env_mutex);
LocalPlayer *player = m_env.getLocalPlayer();
assert(player != NULL);
std::wstring name = narrow_to_wide(player->getName());
m_chat_queue.push_back(
(std::wstring)L"<"+name+L"> "+message);
}
2010-11-27 00:02:21 +01:00
private:
// Virtual methods from con::PeerHandler
void peerAdded(con::Peer *peer);
void deletingPeer(con::Peer *peer, bool timeout);
void ReceiveAll();
void Receive();
void sendPlayerPos();
// This sends the player's current name etc to the server
void sendPlayerInfo();
2010-12-19 15:51:45 +01:00
float m_packetcounter_timer;
float m_delete_unused_sectors_timer;
float m_connection_reinit_timer;
float m_avg_rtt_timer;
float m_playerpos_send_timer;
2010-11-27 00:02:21 +01:00
ClientUpdateThread m_thread;
// NOTE: If connection and environment are both to be locked,
// environment shall be locked first.
Environment m_env;
JMutex m_env_mutex;
con::Connection m_con;
JMutex m_con_mutex;
/*core::map<v3s16, float> m_fetchblock_history;
JMutex m_fetchblock_mutex;*/
core::list<IncomingPacket> m_incoming_queue;
JMutex m_incoming_queue_mutex;
IrrlichtDevice *m_device;
v3f camera_position;
v3f camera_direction;
// Server serialization version
u8 m_server_ser_ver;
float m_step_dtime;
JMutex m_step_dtime_mutex;
// This is behind m_env_mutex.
bool m_inventory_updated;
core::map<v3s16, bool> m_active_blocks;
PacketCounter m_packetcounter;
2010-12-18 16:46:00 +01:00
// Received from the server. 0-23999
MutexedVariable<u32> m_time_of_day;
2010-12-19 15:51:45 +01:00
// 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
//s32 m_daynight_i;
//u32 m_daynight_ratio;
Queue<std::wstring> m_chat_queue;
2010-11-27 00:02:21 +01:00
};
#endif // !SERVER
#endif // !CLIENT_HEADER
2010-11-27 00:02:21 +01:00