From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_net_game_client.html | 1337 +++++++++++++++++++++++++++ 1 file changed, 1337 insertions(+) create mode 100644 Doc/doxygen/html/class_net_game_client.html (limited to 'Doc/doxygen/html/class_net_game_client.html') diff --git a/Doc/doxygen/html/class_net_game_client.html b/Doc/doxygen/html/class_net_game_client.html new file mode 100644 index 0000000..2418f4f --- /dev/null +++ b/Doc/doxygen/html/class_net_game_client.html @@ -0,0 +1,1337 @@ + + + + + +Starshatter_Open: NetGameClient Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Protected Member Functions | +Protected Attributes
+
+
NetGameClient Class Reference
+
+
+ +

#include <NetGameClient.h>

+
+Inheritance diagram for NetGameClient:
+
+
+ + +NetGame +SimObserver + +
+ +

List of all members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 NetGameClient ()
virtual ~NetGameClient ()
virtual bool IsClient () const
virtual bool IsServer () const
virtual void ExecFrame ()
virtual void Send ()
virtual void SendData (NetData *data)
virtual void Respawn (DWORD objid, Ship *spawn)
virtual bool Update (SimObject *obj)
virtual const char * GetObserverName () const
- Public Member Functions inherited from NetGame
 NetGame ()
virtual ~NetGame ()
virtual bool IsActive () const
virtual DWORD GetNetID () const
virtual DWORD GetObjID () const
virtual void Recv ()
virtual NetPlayer * FindPlayerByName (const char *name)
virtual NetPlayer * FindPlayerByNetID (DWORD netid)
virtual NetPlayer * FindPlayerByObjID (DWORD objid)
virtual Ship * FindShipByObjID (DWORD objid)
virtual Shot * FindShotByObjID (DWORD objid)
virtual NetPeer * GetPeer (NetPlayer *player)
- Public Member Functions inherited from SimObserver
virtual ~SimObserver ()
int operator== (const SimObserver &o) const
virtual void Observe (SimObject *obj)
virtual void Ignore (SimObject *obj)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

virtual void DoJoinRequest (NetMsg *msg)
virtual void DoJoinAnnounce (NetMsg *msg)
virtual void DoQuitRequest (NetMsg *msg)
virtual void DoQuitAnnounce (NetMsg *msg)
virtual void DoGameOver (NetMsg *msg)
virtual void DoDisconnect (NetMsg *msg)
virtual void DoObjLoc (NetMsg *msg)
virtual void DoObjDamage (NetMsg *msg)
virtual void DoObjKill (NetMsg *msg)
virtual void DoObjSpawn (NetMsg *msg)
virtual void DoObjHyper (NetMsg *msg)
virtual void DoObjTarget (NetMsg *msg)
virtual void DoObjEmcon (NetMsg *msg)
virtual void DoSysDamage (NetMsg *msg)
virtual void DoSysStatus (NetMsg *msg)
virtual void DoElemCreate (NetMsg *msg)
virtual void DoShipLaunch (NetMsg *msg)
virtual void DoNavData (NetMsg *msg)
virtual void DoNavDelete (NetMsg *msg)
virtual void DoWepTrigger (NetMsg *msg)
virtual void DoWepRelease (NetMsg *msg)
virtual void DoWepDestroy (NetMsg *msg)
virtual void DoCommMsg (NetMsg *msg)
virtual void DoChatMsg (NetMsg *msg)
virtual void DoSelfDestruct (NetMsg *msg)
virtual void SendJoinRequest ()
virtual bool DoJoinBacklog (NetJoinAnnounce *join_ann)
- Protected Member Functions inherited from NetGame
virtual void DoElemRequest (NetMsg *msg)
+ + + + + + + + + + + + + + + + + + +

+Protected Attributes

DWORD server_id
DWORD join_req_time
List< NetJoinAnnounce > join_backlog
- Protected Attributes inherited from NetGame
List< NetPlayer > players
NetLink * link
DWORD objid
DWORD netid
Ship * local_player
Text player_name
Text player_pass
Ship * target
Sim * sim
bool active
DWORD last_send_time
- Protected Attributes inherited from SimObserver
List< SimObject > observe_list
+ + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Types inherited from NetGame
enum  { SHIP, +SHOT + }
- Static Public Member Functions inherited from NetGame
static const char * TYPENAME ()
static NetGame * Create ()
static NetGame * GetInstance ()
static bool IsNetGame ()
static bool IsNetGameClient ()
static bool IsNetGameServer ()
static int NumPlayers ()
static DWORD GetNextObjID (int type=SHIP)
- Static Public Member Functions inherited from SimObserver
static const char * TYPENAME ()
+

Detailed Description

+
+

Definition at line 27 of file NetGameClient.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
NetGameClient::NetGameClient ()
+
+ +

Definition at line 55 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
NetGameClient::~NetGameClient ()
+ 		+virtual
+
+ +

Definition at line 88 of file NetGameClient.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoChatMsg (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 906 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoCommMsg (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 893 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoDisconnect (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 386 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoElemCreate (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 633 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoGameOver (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 376 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoJoinAnnounce (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 139 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool NetGameClient::DoJoinBacklog (NetJoinAnnounce * join_ann)
+ 		+protectedvirtual
+
+ +

Definition at line 255 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoJoinRequest (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 128 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoNavData (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 814 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoNavDelete (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 851 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoObjDamage (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 410 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoObjEmcon (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 590 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoObjHyper (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 563 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoObjKill (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 467 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoObjLoc (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 397 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoObjSpawn (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 558 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoObjTarget (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 577 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoQuitAnnounce (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 345 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoQuitRequest (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 337 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoSelfDestruct (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 921 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoShipLaunch (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 721 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoSysDamage (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 605 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoSysStatus (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 618 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoWepDestroy (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 876 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoWepRelease (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 757 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::DoWepTrigger (NetMsg * msg)
+ 		+protectedvirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 744 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void NetGameClient::ExecFrame ()
+ 		+virtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 995 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char * NetGameClient::GetObserverName () const
+ 		+virtual
+
+ +

Reimplemented from SimObserver.

+ +

Definition at line 1045 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual bool NetGameClient::IsClient () const
+ 		+inlinevirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 33 of file NetGameClient.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual bool NetGameClient::IsServer () const
+ 		+inlinevirtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 34 of file NetGameClient.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void NetGameClient::Respawn (DWORD objid,
Ship * spawn 
)
+ 		+virtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 1053 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void NetGameClient::Send ()
+ 		+virtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 937 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NetGameClient::SendData (NetData * data)
+ 		+virtual
+
+ +

Reimplemented from NetGame.

+ +

Definition at line 976 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void NetGameClient::SendJoinRequest ()
+ 		+protectedvirtual
+
+ +

Definition at line 101 of file NetGameClient.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool NetGameClient::Update (SimObject * obj)
+ 		+virtual
+
+ +

Reimplemented from SimObserver.

+ +

Definition at line 1033 of file NetGameClient.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
List<NetJoinAnnounce> NetGameClient::join_backlog
+ 		+protected
+
+ +

Definition at line 81 of file NetGameClient.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
DWORD NetGameClient::join_req_time
+ 		+protected
+
+ +

Definition at line 80 of file NetGameClient.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
DWORD NetGameClient::server_id
+ 		+protected
+
+ +

Definition at line 79 of file NetGameClient.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1