OpenClonk
C4ControlPlayerMouse Class Referenceabstract

#include <C4Control.h>

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

Public Types

enum  Action { CPM_NoAction = 0, CPM_Hover = 0x01, CPM_Drop = 0x02 }
 

Public Member Functions

 C4ControlPlayerMouse ()
 
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
 
void CompileFunc (StdCompiler *pComp) override
 
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)
 

Static Public Member Functions

static C4ControlPlayerMouseHover (const C4Player *player, const C4Object *target, const C4Object *old_target, const C4Object *drag=nullptr)
 
static C4ControlPlayerMouseDragDrop (const C4Player *player, const C4Object *target, const C4Object *drag)
 

Protected Attributes

int32_t iByClient
 

Detailed Description

Definition at line 233 of file C4Control.h.

Member Enumeration Documentation

◆ Action

Enumerator
CPM_NoAction 
CPM_Hover 
CPM_Drop 

Definition at line 236 of file C4Control.h.

Constructor & Destructor Documentation

◆ C4ControlPlayerMouse()

C4ControlPlayerMouse::C4ControlPlayerMouse ( )
inline

Definition at line 244 of file C4Control.h.

References DECLARE_C4CONTROL_VIRTUALS, and C4ScriptGuiWindowPropertyName::player.

244 : player(NO_OWNER) {}
const int NO_OWNER
Definition: C4Constants.h:137

Member Function Documentation

◆ CompileFunc()

void C4ControlPacket::CompileFunc ( StdCompiler pComp)
overridevirtualinherited

Implements C4PacketBase.

Definition at line 70 of file C4Control.cpp.

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

Referenced by C4ControlEMDrawTool::C4ControlEMDrawTool(), C4ControlMenuCommand::C4ControlMenuCommand(), C4ControlPlayerSelect::C4ControlPlayerSelect(), C4ControlReInitScenario::C4ControlReInitScenario(), C4Control::CompileFunc(), C4ControlPlayerControl::ControlItem::CompileFunc(), C4ControlPlayerControl::ControlItem::ControlItem(), C4Control::Delete(), DragDrop(), C4ControlSyncCheck::GetAllCrewPosX(), C4ControlVote::getDescWarning(), C4ControlPlayerAction::InitPlayerControl(), C4ControlJoinPlayer::PreRec(), C4ControlPacket::Sync(), and C4ControlEMMoveObject::~C4ControlEMMoveObject().

71 {
72  // Section must be set by caller
73  pComp->Value(mkNamingAdapt(mkIntPackAdapt(iByClient), "ByClient", -1));
74 }
int32_t iByClient
Definition: C4Control.h:39
StdNamingAdapt< T > mkNamingAdapt(T &&rValue, const char *szName)
Definition: StdAdaptors.h:92
void Value(const T &rStruct)
Definition: StdCompiler.h:161
StdIntPackAdapt< T > mkIntPackAdapt(T &rVal)
Definition: StdAdaptors.h:777
Here is the call graph for this function:
Here is the caller graph for this function:

◆ DragDrop()

C4ControlPlayerMouse * C4ControlPlayerMouse::DragDrop ( const C4Player player,
const C4Object target,
const C4Object drag 
)
static

Definition at line 459 of file C4Control.cpp.

References C4VObj(), C4PropList::Call(), C4ControlPacket::CompileFunc(), C4ControlPacket::Execute(), mkNamingAdapt(), NO_OWNER, C4Player::Number, C4PropListNumbered::Number, Objects, C4ScriptGuiWindowPropertyName::player, PSF_MouseDragDrop, PSF_MouseHover, C4GameObjects::SafeObjectPointer(), ScriptEngine, and StdCompiler::Value().

Referenced by C4MouseControl::ButtonUpDragScript().

460 {
461  assert(player != nullptr);
462  if (!player) return nullptr;
463 
464  auto control = new C4ControlPlayerMouse();
465  control->action = CPM_Drop;
466  control->player = player->Number;
467  control->drag_obj = drag ? drag->Number : 0;
468  control->target_obj = target ? target->Number : 0;
469  return control;
470 }
int32_t Number
Definition: C4Player.h:86
Here is the call graph for this function:
Here is the caller graph for this function:

◆ Execute()

◆ getByClient()

int32_t C4ControlPacket::getByClient ( ) const
inlineinherited

Definition at line 42 of file C4Control.h.

References C4ControlPacket::iByClient, and C4ControlPacket::LocalControl().

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

42 { return iByClient; }
int32_t iByClient
Definition: C4Control.h:39
Here is the call graph for this function:
Here is the caller graph for this function:

◆ HostControl()

bool C4ControlPacket::HostControl ( ) const
inlineinherited

Definition at line 44 of file C4Control.h.

References C4ClientIDHost, and C4ControlPacket::SetByClient().

Referenced by C4ControlEMDrawTool::C4ControlEMDrawTool(), C4Control::CompileFunc(), and C4ControlVote::getDescWarning().

44 { return iByClient == C4ClientIDHost; }
int32_t iByClient
Definition: C4Control.h:39
const int32_t C4ClientIDHost
Definition: C4Client.h:25
Here is the call graph for this function:
Here is the caller graph for this function:

◆ Hover()

C4ControlPlayerMouse * C4ControlPlayerMouse::Hover ( const C4Player player,
const C4Object target,
const C4Object old_target,
const C4Object drag = nullptr 
)
static

Definition at line 446 of file C4Control.cpp.

References C4Player::Number, and C4PropListNumbered::Number.

Referenced by C4MouseControl::UpdateCursorTarget().

447 {
448  assert(player != nullptr);
449  if (!player) return nullptr;
450 
451  auto control = new C4ControlPlayerMouse();
452  control->action = CPM_Hover;
453  control->player = player->Number;
454  control->drag_obj = drag ? drag->Number : 0;
455  control->target_obj = target ? target->Number : 0;
456  control->old_obj = old_target ? old_target->Number : 0;
457  return control;
458 }
int32_t Number
Definition: C4Player.h:86
Here is the caller graph for this function:

◆ Lobby()

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:

◆ LocalControl()

bool C4ControlPacket::LocalControl ( ) const
inherited

Definition at line 60 of file C4Control.cpp.

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

Referenced by C4ControlJoinPlayer::C4ControlJoinPlayer(), C4Control::CompileFunc(), C4ControlPacket::getByClient(), and C4ControlEMMoveObject::~C4ControlEMMoveObject().

61 {
62  return iByClient == ::Control.ClientID();
63 }
int32_t iByClient
Definition: C4Control.h:39
int32_t ClientID() const
C4GameControl Control
Here is the call graph for this function:
Here is the caller graph for this function:

◆ pack() [1/2]

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

Definition at line 150 of file C4Packet2.cpp.

Referenced by MkC4NetIOPacket().

151 {
152  return C4NetIOPacket(DecompileToBuf<StdCompilerBinWrite>(*this), addr);
153 }
Here is the caller graph for this function:

◆ pack() [2/2]

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

Definition at line 155 of file C4Packet2.cpp.

References mkDecompileAdapt(), and mkInsertAdapt().

156 {
157  return C4NetIOPacket(DecompileToBuf<StdCompilerBinWrite>(mkInsertAdapt(mkDecompileAdapt(*this), cStatus)), addr);
158 }
StdDecompileAdapt< T > mkDecompileAdapt(const T &rValue)
Definition: StdAdaptors.h:153
StdInsertAdapt< T, I > mkInsertAdapt(T &&rObj, I &&rIns, bool fBefore=true)
Definition: StdAdaptors.h:455
Here is the call graph for this function:

◆ PreExecute()

virtual bool C4ControlPacket::PreExecute ( ) const
inlinevirtualinherited

Reimplemented in C4ControlJoinPlayer.

Definition at line 48 of file C4Control.h.

References C4ControlPacket::Execute().

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

48 { return true; }
Here is the call graph for this function:
Here is the caller graph for this function:

◆ PreRec()

virtual void C4ControlPacket::PreRec ( C4Record pRecord)
inlinevirtualinherited

Reimplemented in C4ControlJoinPlayer.

Definition at line 50 of file C4Control.h.

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

50 { }
Here is the caller graph for this function:

◆ SetByClient()

void C4ControlPacket::SetByClient ( int32_t  iByClient)
inherited

Definition at line 65 of file C4Control.cpp.

References C4ControlPacket::iByClient.

Referenced by C4ControlPacket::HostControl(), and C4ControlEMMoveObject::~C4ControlEMMoveObject().

66 {
67  iByClient = inByClient;
68 }
int32_t iByClient
Definition: C4Control.h:39
Here is the caller graph for this function:

◆ Sync()

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.

References C4ControlPacket::CompileFunc().

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

55 { return true; }
Here is the call graph for this function:
Here is the caller graph for this function:

◆ unpack()

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

Definition at line 160 of file C4Packet2.cpp.

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

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

161 {
162  if (pStatus) *pStatus = Pkt.getStatus();
163  CompileFromBuf<StdCompilerBinRead>(*this, pStatus ? Pkt.getPBuf() : Pkt.getRef());
164 }
uint8_t getStatus() const
Definition: C4NetIO.h:318
StdBuf getPBuf() const
Definition: C4NetIO.h:321
C4NetIOPacket getRef() const
Definition: C4NetIO.h:324
Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ iByClient


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