minetest/src/client.h

373 lines
8.3 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>
#include "clientobject.h"
#include "utility.h" // For IntervalLimiter
#include "gamedef.h"
2010-11-27 00:02:21 +01:00
2011-06-26 01:34:36 +02:00
struct MeshMakeData;
2010-11-27 00:02:21 +01:00
class ClientNotReadyException : public BaseException
{
public:
ClientNotReadyException(const char *s):
BaseException(s)
{}
};
struct QueuedMeshUpdate
{
v3s16 p;
MeshMakeData *data;
bool ack_block_to_server;
2011-06-26 01:34:36 +02:00
QueuedMeshUpdate();
~QueuedMeshUpdate();
};
/*
A thread-safe queue of mesh update tasks
*/
class MeshUpdateQueue
{
public:
2011-06-26 01:34:36 +02:00
MeshUpdateQueue();
2011-06-26 01:34:36 +02:00
~MeshUpdateQueue();
/*
peer_id=0 adds with nobody to send to
*/
2011-06-26 01:34:36 +02:00
void addBlock(v3s16 p, MeshMakeData *data, bool ack_block_to_server);
// Returned pointer must be deleted
// Returns NULL if queue is empty
2011-06-26 01:34:36 +02:00
QueuedMeshUpdate * pop();
u32 size()
{
JMutexAutoLock lock(m_mutex);
return m_queue.size();
}
private:
core::list<QueuedMeshUpdate*> m_queue;
JMutex m_mutex;
};
2010-11-27 00:02:21 +01:00
struct MeshUpdateResult
2010-11-27 00:02:21 +01:00
{
v3s16 p;
scene::SMesh *mesh;
bool ack_block_to_server;
MeshUpdateResult():
p(-1338,-1338,-1338),
mesh(NULL),
ack_block_to_server(false)
{
}
};
2010-11-27 00:02:21 +01:00
class MeshUpdateThread : public SimpleThread
{
2010-11-27 00:02:21 +01:00
public:
MeshUpdateThread(ITextureSource *tsrc):
m_tsrc(tsrc)
2010-11-27 00:02:21 +01:00
{
}
void * Thread();
MeshUpdateQueue m_queue_in;
MutexedQueue<MeshUpdateResult> m_queue_out;
ITextureSource *m_tsrc;
2010-11-27 00:02:21 +01:00
};
enum ClientEventType
2010-11-27 00:02:21 +01:00
{
CE_NONE,
CE_PLAYER_DAMAGE,
2011-10-15 13:46:59 +02:00
CE_PLAYER_FORCE_MOVE,
CE_DEATHSCREEN,
};
struct ClientEvent
{
ClientEventType type;
union{
struct{
} none;
struct{
u8 amount;
} player_damage;
struct{
f32 pitch;
f32 yaw;
} player_force_move;
2011-10-15 13:46:59 +02:00
struct{
bool set_camera_point_target;
f32 camera_point_target_x;
f32 camera_point_target_y;
f32 camera_point_target_z;
} deathscreen;
};
2010-11-27 00:02:21 +01:00
};
class Client : public con::PeerHandler, public InventoryManager, public IGameDef
2010-11-27 00:02:21 +01:00
{
public:
/*
NOTE: Nothing is thread-safe here.
2010-11-27 00:02:21 +01:00
*/
Client(
IrrlichtDevice *device,
const char *playername,
std::string password,
MapDrawControl &control,
ITextureSource *tsrc,
IToolDefManager *toolmgr
);
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();
2010-11-27 00:02:21 +01:00
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);
// Pops out a packet from the packet queue
//IncomingPacket getPacket();
2010-11-27 00:02:21 +01:00
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);
2011-10-15 11:17:21 +02:00
void clickActiveObject(u8 button, u16 id, u16 item_i);
2010-11-27 00:02:21 +01:00
void sendSignNodeText(v3s16 p, std::string text);
2010-12-22 15:30:23 +01:00
void sendInventoryAction(InventoryAction *a);
void sendChatMessage(const std::wstring &message);
void sendChangePassword(const std::wstring oldpassword,
const std::wstring newpassword);
void sendDamage(u8 damage);
2011-10-15 13:46:59 +02:00
void sendRespawn();
// 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, f32 fov);
2010-11-27 00:02:21 +01:00
void renderPostFx();
2010-11-27 00:02:21 +01:00
// Returns InvalidPositionException if not found
MapNode getNode(v3s16 p);
// Wrapper to Map
2011-04-04 02:45:08 +02:00
NodeMetadata* getNodeMetadata(v3s16 p);
2010-11-27 00:02:21 +01:00
LocalPlayer* getLocalPlayer();
2010-11-27 00:02:21 +01:00
void setPlayerControl(PlayerControl &control);
2011-08-10 18:31:44 +02:00
void selectPlayerItem(u16 item);
2010-11-27 00:02:21 +01:00
// 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);
2011-04-04 14:13:19 +02:00
InventoryContext *getInventoryContext();
Inventory* getInventory(InventoryContext *c, std::string id);
void inventoryAction(InventoryAction *a);
2010-11-27 00:02:21 +01:00
// Gets closest object pointed by the shootline
// Returns NULL if not found
ClientActiveObject * getSelectedActiveObject(
f32 max_d,
v3f from_pos_f_on_map,
core::line3d<f32> shootline_on_map
);
2010-11-27 00:02:21 +01:00
// 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
u32 getDayNightRatio();
u16 getHP();
2011-06-26 01:34:36 +02:00
void setTempMod(v3s16 p, NodeMod mod);
void clearTempMod(v3s16 p);
2010-12-23 11:10:46 +01:00
float getAvgRtt()
{
try{
return m_con.GetPeerAvgRTT(PEER_ID_SERVER);
} catch(con::PeerNotFoundException){
return 1337;
}
2010-12-23 11:10:46 +01:00
}
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)
{
if (message[0] == L'/') {
m_chat_queue.push_back(
(std::wstring)L"issued command: "+message);
return;
}
//JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
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);
}
u64 getMapSeed(){ return m_map_seed; }
void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false);
// Including blocks at appropriate edges
void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false);
// Get event from queue. CE_NONE is returned if queue is empty.
ClientEvent getClientEvent();
inline bool accessDenied()
{
return m_access_denied;
}
inline std::wstring accessDeniedReason()
{
return m_access_denied_reason;
}
float getRTT(void);
// IGameDef interface
// Under envlock
virtual IToolDefManager* getToolDefManager()
{ return m_toolmgr; }
virtual INodeDefManager* getNodeDefManager()
{ assert(0); return NULL; } // TODO
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();
// Send the item number 'item' as player item to the server
void sendPlayerItem(u16 item);
2010-12-19 15:51:45 +01:00
float m_packetcounter_timer;
float m_connection_reinit_timer;
float m_avg_rtt_timer;
float m_playerpos_send_timer;
float m_ignore_damage_timer; // Used after server moves player
IntervalLimiter m_map_timer_and_unload_interval;
2010-12-19 15:51:45 +01:00
ITextureSource *m_tsrc;
IToolDefManager *m_toolmgr;
MeshUpdateThread m_mesh_update_thread;
ClientEnvironment m_env;
2010-11-27 00:02:21 +01:00
con::Connection m_con;
IrrlichtDevice *m_device;
// Server serialization version
u8 m_server_ser_ver;
// This is behind m_env_mutex.
bool m_inventory_updated;
core::map<v3s16, bool> m_active_blocks;
PacketCounter m_packetcounter;
// Received from the server. 0-23999
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;
// The seed returned by the server in TOCLIENT_INIT is stored here
u64 m_map_seed;
std::string m_password;
bool m_access_denied;
std::wstring m_access_denied_reason;
2011-04-04 14:13:19 +02:00
InventoryContext m_inventory_context;
Queue<ClientEvent> m_client_event_queue;
2011-06-18 11:42:17 +02:00
friend class FarMesh;
2010-11-27 00:02:21 +01:00
};
#endif // !SERVER
#endif // !CLIENT_HEADER
2010-11-27 00:02:21 +01:00