OpenClonk
C4ControlReInitScenario Struct Referenceabstract

#include <C4Control.h>

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

Public Member Functions

 C4ControlReInitScenario ()
 
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)
 

Protected Attributes

StdBuf data
 
int32_t iByClient
 

Detailed Description

Definition at line 604 of file C4Control.h.

Constructor & Destructor Documentation

◆ C4ControlReInitScenario()

C4ControlReInitScenario::C4ControlReInitScenario ( )

Definition at line 1881 of file C4Control.cpp.

1882 {
1883  // Create a temp file with the scenario files to be loaded as a section
1884  char *tmp_fn = const_cast<char *>(Config.AtTempPath("ReinitSectionSave.ocs"));
1885  MakeTempFilename(tmp_fn);
1886  C4Group grp;
1887  grp.Open(tmp_fn, true);
1888  StdBuf buf;
1889  bool success = true;
1891  for (const char *section_component : section_components)
1892  {
1893  if (::Game.ScenarioFile.LoadEntry(section_component, &buf))
1894  {
1895  if (!grp.Add(section_component, buf, false, true)) success = false;
1896  }
1897  buf.Clear();
1898  }
1899  if (!grp.Save(false)) success = false;
1900  if (!success) return;
1901  // Move into buffer to be sent via queue
1902  success = data.LoadFromFile(tmp_fn);
1903  EraseFile(tmp_fn);
1904  if (!success) return;
1905 }
#define C4CFN_MapFg
Definition: C4Components.h:58
#define C4CFN_ScenarioObjectsScript
Definition: C4Components.h:74
#define C4CFN_MapBg
Definition: C4Components.h:59
#define C4CFN_ScenarioObjects
Definition: C4Components.h:87
#define C4CFN_Map
Definition: C4Components.h:57
#define C4CFN_ScenarioCore
Definition: C4Components.h:42
C4Config Config
Definition: C4Config.cpp:930
C4Game Game
Definition: C4Globals.cpp:52
void MakeTempFilename(char *szFilename)
Definition: StdFile.cpp:320
bool EraseFile(const char *szFileName)
const char * AtTempPath(const char *filename)
Definition: C4Config.cpp:600
C4Group ScenarioFile
Definition: C4Game.h:86
bool Add(const char *filename, const char *entry_name)
Definition: C4Group.cpp:1621
bool LoadEntry(const char *entry_name, char **buffer, size_t *size_info=nullptr, int zeros_to_append=0)
Definition: C4Group.cpp:2375
bool Save(bool reopen)
Definition: C4Group.cpp:1031
bool Open(const char *group_name, bool do_create=false)
Definition: C4Group.cpp:660
Definition: StdBuf.h:30
bool LoadFromFile(const char *szFile)
Definition: StdBuf.cpp:32
void Clear()
Definition: StdBuf.h:190

References C4Group::Add(), C4Config::AtTempPath(), C4CFN_Map, C4CFN_MapBg, C4CFN_MapFg, C4CFN_ScenarioCore, C4CFN_ScenarioObjects, C4CFN_ScenarioObjectsScript, StdBuf::Clear(), Config, data, EraseFile(), Game, C4Group::LoadEntry(), StdBuf::LoadFromFile(), MakeTempFilename(), C4Group::Open(), C4Group::Save(), and C4Game::ScenarioFile.

Here is the call graph for this function:

Member Function Documentation

◆ CompileFunc()

void C4ControlPacket::CompileFunc ( StdCompiler pComp)
overridevirtualinherited

Implements C4PacketBase.

Definition at line 70 of file C4Control.cpp.

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

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

Here is the call graph for this function:

◆ Execute()

virtual void C4ControlPacket::Execute ( ) const
pure virtualinherited

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

Here is the caller graph for this function:

◆ getByClient()

int32_t C4ControlPacket::getByClient ( ) const
inlineinherited

Definition at line 42 of file C4Control.h.

42 { return iByClient; }

References C4ControlPacket::iByClient.

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

Here is the caller graph for this function:

◆ HostControl()

bool C4ControlPacket::HostControl ( ) const
inlineinherited

Definition at line 44 of file C4Control.h.

44 { return iByClient == C4ClientIDHost; }
const int32_t C4ClientIDHost
Definition: C4Client.h:25

References C4ClientIDHost, and C4ControlPacket::iByClient.

◆ Lobby()

virtual bool C4ControlPacket::Lobby ( ) const
inlinevirtualinherited

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

Definition at line 53 of file C4Control.h.

53 { return false; }

Referenced by C4GameControl::DoInput().

Here is the caller graph for this function:

◆ LocalControl()

bool C4ControlPacket::LocalControl ( ) const
inherited

Definition at line 60 of file C4Control.cpp.

61 {
62  return iByClient == ::Control.ClientID();
63 }
C4GameControl Control
int32_t ClientID() const

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

Here is the call 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.

151 {
152  return C4NetIOPacket(DecompileToBuf<StdCompilerBinWrite>(*this), addr);
153 }

Referenced by MkC4NetIOPacket().

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.

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

References mkDecompileAdapt(), and mkInsertAdapt().

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.

48 { return true; }

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

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.

50 { }

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

Here is the caller graph for this function:

◆ SetByClient()

void C4ControlPacket::SetByClient ( int32_t  iByClient)
inherited

Definition at line 65 of file C4Control.cpp.

66 {
67  iByClient = inByClient;
68 }

References C4ControlPacket::iByClient.

◆ 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.

55 { return true; }

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

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.

161 {
162  if (pStatus) *pStatus = Pkt.getStatus();
163  CompileFromBuf<StdCompilerBinRead>(*this, pStatus ? Pkt.getPBuf() : Pkt.getRef());
164 }
uint8_t getStatus() const
Definition: C4NetIO.h:319
StdBuf getPBuf() const
Definition: C4NetIO.h:322
C4NetIOPacket getRef() const
Definition: C4NetIO.h:325

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

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

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ data

StdBuf C4ControlReInitScenario::data
protected

Definition at line 609 of file C4Control.h.

Referenced by C4ControlReInitScenario().

◆ iByClient


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