C4ControlJoinPlayer Struct Reference

#include <C4Control.h>

Inheritance diagram for C4ControlJoinPlayer:

Collaboration diagram for C4ControlJoinPlayer:

Public Member Functions
	C4ControlJoinPlayer ()=default
	C4ControlJoinPlayer (const char *szFilename, int32_t iAtClient, int32_t iIDInfo, C4Network2ResCore ResCore)
	C4ControlJoinPlayer (const char *szFilename, int32_t iAtClient, int32_t iIDInfo)
DECLARE_C4CONTROL_VIRTUALS bool	PreExecute () const override
void	PreRec (C4Record *pRecord) override
void	Strip ()
int32_t	getByClient () const
bool	LocalControl () const
bool	HostControl () const
void	SetByClient (int32_t iByClient)
virtual void	Execute () const =0
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
StdStrBuf	Filename
int32_t	iAtClient {-1}
int32_t	idInfo {-1}
bool	fByRes {false}
StdBuf	PlrData
C4Network2ResCore	ResCore
int32_t	iByClient

Detailed Description

Definition at line 420 of file C4Control.h.

Constructor & Destructor Documentation

C4ControlJoinPlayer() [1/3]

C4ControlJoinPlayer::C4ControlJoinPlayer ( )

default

C4ControlJoinPlayer() [2/3]

C4ControlJoinPlayer::C4ControlJoinPlayer	(	const char *	szFilename,
		int32_t	iAtClient,
		int32_t	iIDInfo,
		C4Network2ResCore	ResCore
	)

Definition at line 1003 of file C4Control.cpp.

        : Filename(szFilename, true), iAtClient(iAtClient),
        idInfo(iIDInfo), fByRes(true), ResCore(std::move(ResCore))
{
}

C4ControlJoinPlayer() [3/3]

C4ControlJoinPlayer::C4ControlJoinPlayer	(	const char *	szFilename,
		int32_t	iAtClient,
		int32_t	iIDInfo
	)

Definition at line 1009 of file C4Control.cpp.

        : Filename(szFilename, true), iAtClient(iAtClient),
        idInfo(iIDInfo)
{
    // load from file if filename is given - which may not be the case for script players
    StdStrBuf filename;
    if (szFilename && Reloc.LocateItem(szFilename, filename))
    {
        bool file_is_temp = false;
        if (DirectoryExists(filename.getData()))
        {
            // the player file is unpacked - temp pack and read
            StdStrBuf filename_buf;
            filename_buf.Copy(Config.AtTempPath(GetFilenameOnly(filename.getData())));
            MakeTempFilename(&filename_buf);
            if (C4Group_PackDirectoryTo(filename.getData(), filename_buf.getData()))
            {
                filename.Take(filename_buf);
                file_is_temp = true;
            }
            else
            {
                // pack failed
                LogF("[!]Error packing player file %s to %s for join: Pack failed.", filename.getData(), filename_buf.getData());
                assert(false);
            }
        }
        bool fSuccess = PlrData.LoadFromFile(filename.getData());
        if (!fSuccess)
        {
            LogF("[!]Error loading player file from %s.", filename.getData());
            assert(false);
        }
        if (file_is_temp) EraseFile(filename.getData());
    }
    else if(szFilename)
    {
        LogF("[!]Error loading player file from %s.", szFilename);
        assert(false);
    }
}

References C4Config::AtTempPath(), C4Group_PackDirectoryTo(), Config, StdStrBuf::Copy(), DirectoryExists(), EraseFile(), StdStrBuf::getData(), GetFilenameOnly(), StdBuf::LoadFromFile(), C4Reloc::LocateItem(), LogF(), MakeTempFilename(), PlrData, Reloc, and StdStrBuf::Take().

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.

{
    // Section must be set by caller
    pComp->Value(mkNamingAdapt(mkIntPackAdapt(iByClient), "ByClient", -1));
}

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.

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

{ return iByClient == C4ClientIDHost; }

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.

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

{
    return iByClient == ::Control.ClientID();
}

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.

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

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.

{
    return C4NetIOPacket(DecompileToBuf<StdCompilerBinWrite>(mkInsertAdapt(mkDecompileAdapt(*this), cStatus)), addr);
}

References mkDecompileAdapt(), and mkInsertAdapt().

Here is the call graph for this function:

PreExecute()

bool C4ControlJoinPlayer::PreExecute ( ) const

overridevirtual

Reimplemented from C4ControlPacket.

Definition at line 1150 of file C4Control.cpp.

{
    // all data included in control packet?
    if (!fByRes) return true;
    // client lost?
    if (!Game.Clients.getClientByID(iAtClient)) return true;
    // network only
    if (!::Control.isNetwork()) return true;
    // search resource
    C4Network2Res::Ref pRes = ::Network.ResList.getRefRes(ResCore.getID());
    // doesn't exist? start loading
    if (!pRes) { pRes = ::Network.ResList.AddByCore(ResCore, true); }
    if (!pRes) return true;
    // is loading or removed?
    return !pRes->isLoading();
}

References C4Network2ResList::AddByCore(), C4Game::Clients, Control, fByRes, Game, C4ClientList::getClientByID(), C4Network2ResCore::getID(), C4Network2ResList::getRefRes(), iAtClient, C4Network2Res::isLoading(), C4GameControl::isNetwork(), Network, ResCore, and C4Network2::ResList.

Here is the call graph for this function:

PreRec()

void C4ControlJoinPlayer::PreRec ( C4Record *  pRecord )

overridevirtual

Reimplemented from C4ControlPacket.

Definition at line 1167 of file C4Control.cpp.

{
    if (!pRecord) return;
    if (fByRes)
    {
        // get local file by id
        C4Network2Res::Ref pRes = ::Network.ResList.getRefRes(ResCore.getID());
        if (!pRes || pRes->isRemoved()) return;
        // create a copy of the resource
        StdStrBuf szTemp; szTemp.Copy(pRes->getFile());
        MakeTempFilename(&szTemp);
        if (C4Group_CopyItem(pRes->getFile(), szTemp.getData()))
        {
            // add to record
            StdStrBuf szTarget = FormatString("%d-%s", ResCore.getID(), GetFilename(ResCore.getFileName()));
            pRecord->AddFile(szTemp.getData(), szTarget.getData(), true);
        }
    }
    else
    {
        // player data raw within control: Will be used directly in record
    }
}

References C4Record::AddFile(), C4Group_CopyItem(), StdStrBuf::Copy(), fByRes, FormatString(), StdStrBuf::getData(), C4Network2Res::getFile(), C4Network2ResCore::getFileName(), GetFilename(), C4Network2ResCore::getID(), C4Network2ResList::getRefRes(), C4Network2Res::isRemoved(), MakeTempFilename(), Network, ResCore, and C4Network2::ResList.

Here is the call graph for this function:

SetByClient()

void C4ControlPacket::SetByClient ( int32_t  iByClient )

inherited

Definition at line 65 of file C4Control.cpp.

{
    iByClient = inByClient;
}

References C4ControlPacket::iByClient.

Strip()

void C4ControlJoinPlayer::Strip

(

)

Definition at line 1120 of file C4Control.cpp.

{
    // By resource? Can't touch player file, then.
    if (fByRes) return;
    // create temp file
    StdStrBuf PlayerFilename; PlayerFilename = GetFilename(Filename.getData());
    PlayerFilename = Config.AtTempPath(PlayerFilename.getData());
    // Copy to it
    if (PlrData.SaveToFile(PlayerFilename.getData()))
    {
        // open as group
        C4Group Grp;
        if (!Grp.Open(PlayerFilename.getData()))
            { EraseFile(PlayerFilename.getData()); return; }
        // remove bigicon, if the file size is too large
        size_t iBigIconSize=0;
        if (Grp.FindEntry(C4CFN_BigIcon, nullptr, &iBigIconSize))
            if (iBigIconSize > C4NetResMaxBigicon*1024)
                Grp.Delete(C4CFN_BigIcon);
        Grp.Close();
        // Set new data
        StdBuf NewPlrData;
        if (!NewPlrData.LoadFromFile(PlayerFilename.getData()))
            { EraseFile(PlayerFilename.getData()); return; }
        PlrData = std::move(NewPlrData);
        // Done
        EraseFile(PlayerFilename.getData());
    }
}

References C4Config::AtTempPath(), C4CFN_BigIcon, C4NetResMaxBigicon, C4Group::Close(), Config, C4Group::Delete(), EraseFile(), fByRes, Filename, C4Group::FindEntry(), StdStrBuf::getData(), GetFilename(), StdBuf::LoadFromFile(), C4Group::Open(), PlrData, and StdBuf::SaveToFile().

Referenced by C4Playback::Strip().

Here is the call graph for this function:

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.

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

{
    if (pStatus) *pStatus = Pkt.getStatus();
    CompileFromBuf<StdCompilerBinRead>(*this, pStatus ? Pkt.getPBuf() : Pkt.getRef());
}

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

fByRes

bool C4ControlJoinPlayer::fByRes {false}

protected

Definition at line 430 of file C4Control.h.

Referenced by PreExecute(), PreRec(), and Strip().

Filename

StdStrBuf C4ControlJoinPlayer::Filename

protected

Definition at line 427 of file C4Control.h.

Referenced by Strip().

iAtClient

int32_t C4ControlJoinPlayer::iAtClient {-1}

protected

Definition at line 428 of file C4Control.h.

Referenced by PreExecute().

iByClient

int32_t C4ControlPacket::iByClient

protectedinherited

Definition at line 39 of file C4Control.h.

Referenced by C4ControlPacket::CompileFunc(), C4ControlPacket::getByClient(), C4ControlVote::getDesc(), C4ControlPacket::HostControl(), C4ControlPacket::LocalControl(), and C4ControlPacket::SetByClient().

idInfo

int32_t C4ControlJoinPlayer::idInfo {-1}

protected

Definition at line 429 of file C4Control.h.

PlrData

StdBuf C4ControlJoinPlayer::PlrData

protected

Definition at line 431 of file C4Control.h.

Referenced by C4ControlJoinPlayer(), and Strip().

ResCore

C4Network2ResCore C4ControlJoinPlayer::ResCore

protected

Definition at line 432 of file C4Control.h.

Referenced by PreExecute(), and PreRec().

---

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

• C4Control.h
• C4Control.cpp