OpenClonk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
C4ControlPlayerControl Class Referenceabstract

#include <C4Control.h>

Inheritance diagram for C4ControlPlayerControl:
[legend]
Collaboration diagram for C4ControlPlayerControl:
[legend]

Classes

struct  ControlItem
 

Public Types

typedef std::vector< ControlItemControlItemVec
 

Public Member Functions

 C4ControlPlayerControl ()
 
 C4ControlPlayerControl (int32_t iPlr, C4PlayerControl::ControlState state, const C4KeyEventData &rExtraData)
 
 C4ControlPlayerControl (int32_t iPlr, int32_t iControl, int32_t iExtraData)
 
DECLARE_C4CONTROL_VIRTUALS void AddControl (int32_t iControl, int32_t iTriggerMode)
 
const ControlItemVecGetControlItems () const
 
C4PlayerControl::ControlState GetState () const
 
const C4KeyEventDataGetExtraData () const
 
void SetExtraData (const C4KeyEventData &new_extra_data)
 
int32_t getByClient () const
 
bool LocalControl () const
 
bool HostControl () const
 
void SetByClient (int32_t iByClient)
 
virtual bool PreExecute () const
 
virtual void Execute () const =0
 
virtual void PreRec (C4Record *pRecord)
 
virtual bool Lobby () const
 
virtual bool Sync () const
 
virtual void CompileFunc (StdCompiler *pComp)
 
C4NetIOPacket pack (const C4NetIO::addr_t &addr=C4NetIO::addr_t()) const
 
C4NetIOPacket pack (uint8_t cStatus, const C4NetIO::addr_t &addr=C4NetIO::addr_t()) const
 
void unpack (const C4NetIOPacket &Pkt, char *pStatus=nullptr)
 

Protected Attributes

int32_t iPlr
 
int32_t state
 
C4KeyEventData ExtraData
 
ControlItemVec ControlItems
 
int32_t iByClient
 

Detailed Description

Definition at line 204 of file C4Control.h.

Member Typedef Documentation

Definition at line 222 of file C4Control.h.

Constructor & Destructor Documentation

C4ControlPlayerControl::C4ControlPlayerControl ( )
inline
C4ControlPlayerControl::C4ControlPlayerControl ( int32_t  iPlr,
C4PlayerControl::ControlState  state,
const C4KeyEventData rExtraData 
)
inline

Definition at line 208 of file C4Control.h.

209  : iPlr(iPlr), state(state), ExtraData(rExtraData) { }
C4KeyEventData ExtraData
Definition: C4Control.h:226
C4ControlPlayerControl::C4ControlPlayerControl ( int32_t  iPlr,
int32_t  iControl,
int32_t  iExtraData 
)
inline

Definition at line 210 of file C4Control.h.

References AddControl().

211  : iPlr(iPlr), state(C4PlayerControl::CONS_Down), ExtraData(iExtraData,0,0,0,0) { AddControl(iControl,0); }
C4KeyEventData ExtraData
Definition: C4Control.h:226
DECLARE_C4CONTROL_VIRTUALS void AddControl(int32_t iControl, int32_t iTriggerMode)
Definition: C4Control.h:230

Here is the call graph for this function:

Member Function Documentation

DECLARE_C4CONTROL_VIRTUALS void C4ControlPlayerControl::AddControl ( int32_t  iControl,
int32_t  iTriggerMode 
)
inline

Definition at line 230 of file C4Control.h.

Referenced by C4ControlPlayerControl(), and C4PlayerControl::PrepareInput().

231  { ControlItems.push_back(ControlItem(iControl, iTriggerMode)); }
ControlItemVec ControlItems
Definition: C4Control.h:227

Here is the caller graph for this function:

void C4ControlPacket::CompileFunc ( StdCompiler pComp)
virtualinherited

Implements C4PacketBase.

Definition at line 77 of file C4Control.cpp.

References C4ControlPacket::iByClient, mkIntPackAdapt(), mkNamingAdapt(), and StdCompiler::Value().

78 {
79  // Section must be set by caller
80  pComp->Value(mkNamingAdapt(mkIntPackAdapt(iByClient), "ByClient", -1));
81 }
int32_t iByClient
Definition: C4Control.h:39
StdNamingAdapt< T > mkNamingAdapt(T &&rValue, const char *szName)
Definition: StdAdaptors.h:93
void Value(const T &rStruct)
Definition: StdCompiler.h:171
StdIntPackAdapt< T > mkIntPackAdapt(T &rVal)
Definition: StdAdaptors.h:760

Here is the call graph for this function:

virtual void C4ControlPacket::Execute ( ) const
pure virtualinherited

Referenced by C4GameControl::DoSyncCheck(), C4GameControl::ExecControlPacket(), and C4Control::Execute().

Here is the caller graph for this function:

int32_t C4ControlPacket::getByClient ( ) const
inlineinherited

Definition at line 42 of file C4Control.h.

References C4ControlPacket::iByClient.

Referenced by C4Network2::GetVote(), and C4Network2::OpenVoteDialog().

42 { return iByClient; }
int32_t iByClient
Definition: C4Control.h:39

Here is the caller graph for this function:

const ControlItemVec& C4ControlPlayerControl::GetControlItems ( ) const
inline

Definition at line 232 of file C4Control.h.

References ControlItems.

Referenced by C4PlayerControl::ExecuteControlPacket().

232 { return ControlItems; }
ControlItemVec ControlItems
Definition: C4Control.h:227

Here is the caller graph for this function:

const C4KeyEventData& C4ControlPlayerControl::GetExtraData ( ) const
inline

Definition at line 234 of file C4Control.h.

References ExtraData.

Referenced by C4PlayerControl::ExecuteControlPacket().

234 { return ExtraData; }
C4KeyEventData ExtraData
Definition: C4Control.h:226

Here is the caller graph for this function:

C4PlayerControl::ControlState C4ControlPlayerControl::GetState ( ) const
inline

Definition at line 233 of file C4Control.h.

References state.

Referenced by C4PlayerControl::ExecuteControlPacket().

Here is the caller graph for this function:

bool C4ControlPacket::HostControl ( ) const
inlineinherited

Definition at line 44 of file C4Control.h.

References C4ClientIDHost.

44 { return iByClient == C4ClientIDHost; }
int32_t iByClient
Definition: C4Control.h:39
const int32_t C4ClientIDHost
Definition: C4Client.h:25
virtual bool C4ControlPacket::Lobby ( ) const
inlinevirtualinherited

Reimplemented in C4ControlMessage, C4ControlPlayerInfo, C4ControlClientRemove, C4ControlClientUpdate, C4ControlClientJoin, and C4ControlSet.

Definition at line 53 of file C4Control.h.

Referenced by C4GameControl::DoInput().

53 { return false; }

Here is the caller graph for this function:

bool C4ControlPacket::LocalControl ( ) const
inherited

Definition at line 67 of file C4Control.cpp.

References C4GameControl::ClientID(), Control, and C4ControlPacket::iByClient.

68 {
69  return iByClient == ::Control.ClientID();
70 }
int32_t iByClient
Definition: C4Control.h:39
C4GameControl Control
int32_t ClientID() const

Here is the call graph for this function:

C4NetIOPacket C4PacketBase::pack ( const C4NetIO::addr_t addr = C4NetIO::addr_t()) const
inherited

Definition at line 156 of file C4Packet2.cpp.

Referenced by MkC4NetIOPacket().

157 {
158  return C4NetIOPacket(DecompileToBuf<StdCompilerBinWrite>(*this), addr);
159 }

Here is the caller graph for this function:

C4NetIOPacket C4PacketBase::pack ( uint8_t  cStatus,
const C4NetIO::addr_t addr = C4NetIO::addr_t() 
) const
inherited

Definition at line 161 of file C4Packet2.cpp.

References mkDecompileAdapt(), and mkInsertAdapt().

162 {
163  return C4NetIOPacket(DecompileToBuf<StdCompilerBinWrite>(mkInsertAdapt(mkDecompileAdapt(*this), cStatus)), addr);
164 }
StdDecompileAdapt< T > mkDecompileAdapt(const T &rValue)
Definition: StdAdaptors.h:154
StdInsertAdapt< T, I > mkInsertAdapt(T &&rObj, I &&rIns, bool fBefore=true)
Definition: StdAdaptors.h:438

Here is the call graph for this function:

virtual bool C4ControlPacket::PreExecute ( ) const
inlinevirtualinherited

Reimplemented in C4ControlJoinPlayer.

Definition at line 48 of file C4Control.h.

Referenced by C4GameControl::ExecControlPacket(), and C4Control::PreExecute().

48 { return true; }

Here is the caller graph for this function:

virtual void C4ControlPacket::PreRec ( C4Record pRecord)
inlinevirtualinherited

Reimplemented in C4ControlJoinPlayer.

Definition at line 50 of file C4Control.h.

Referenced by C4Control::PreRec(), and C4Record::Rec().

50 { }

Here is the caller graph for this function:

void C4ControlPacket::SetByClient ( int32_t  iByClient)
inherited

Definition at line 72 of file C4Control.cpp.

References C4ControlPacket::iByClient.

73 {
74  iByClient = inByClient;
75 }
int32_t iByClient
Definition: C4Control.h:39
void C4ControlPlayerControl::SetExtraData ( const C4KeyEventData new_extra_data)
inline

Definition at line 235 of file C4Control.h.

235 { ExtraData = new_extra_data; }
C4KeyEventData ExtraData
Definition: C4Control.h:226
virtual bool C4ControlPacket::Sync ( ) const
inlinevirtualinherited

Reimplemented in C4ControlVoteEnd, C4ControlVote, C4ControlMessage, C4ControlPlayerInfo, C4ControlClientRemove, C4ControlClientUpdate, C4ControlClientJoin, and C4ControlSyncCheck.

Definition at line 55 of file C4Control.h.

Referenced by C4Playback::Check(), and C4GameControl::DoInput().

55 { return true; }

Here is the caller graph for this function:

void C4PacketBase::unpack ( const C4NetIOPacket Pkt,
char *  pStatus = nullptr 
)
inherited

Definition at line 166 of file C4Packet2.cpp.

References C4NetIOPacket::getPBuf(), C4NetIOPacket::getRef(), and C4NetIOPacket::getStatus().

Referenced by C4IDPacket::C4IDPacket(), and C4Network2IO::HandlePacket().

167 {
168  if (pStatus) *pStatus = Pkt.getStatus();
169  CompileFromBuf<StdCompilerBinRead>(*this, pStatus ? Pkt.getPBuf() : Pkt.getRef());
170 }
StdBuf getPBuf() const
Definition: C4NetIO.h:321
C4NetIOPacket getRef() const
Definition: C4NetIO.h:324
uint8_t getStatus() const
Definition: C4NetIO.h:318

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ControlItemVec C4ControlPlayerControl::ControlItems
protected

Definition at line 227 of file C4Control.h.

Referenced by GetControlItems().

C4KeyEventData C4ControlPlayerControl::ExtraData
protected

Definition at line 226 of file C4Control.h.

Referenced by GetExtraData().

int32_t C4ControlPacket::iByClient
protectedinherited
int32_t C4ControlPlayerControl::iPlr
protected

Definition at line 224 of file C4Control.h.

int32_t C4ControlPlayerControl::state
protected

Definition at line 225 of file C4Control.h.

Referenced by GetState().


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