TClientBubbleHandlerBase

Template client bubble functionality.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

MassReplication

Header

/Engine/Plugins/Runtime/MassGameplay/Source/MassReplication/Public/MassClientBubbleHandler.h

Include

#include "MassClientBubbleHandler.h"

Syntax

template<typename AgentArrayItem>
class TClientBubbleHandlerBase : public IClientBubbleHandlerInterface

Remarks

Template client bubble functionality. Replication logic for specific agent types is provided by deriving from this class. Interaction with the FMassClientBubbleSerializerBase and derived classes should be done from this class

Variables

Name Description

Protected variable

TArray< AgentAr...

 

Agents

Pointer to the Agents array in the associated Serializer class

Protected variable

TMap< FMassNetw...

 

AgentsRemoveDataMap

Data that is stored when an agent is removed from the bubble, when it times out its safe enough to remove entries in EntityInfoMap The idea is that any out of order adds and subsequent removes for this NetID will normally happen before FAgentRemoveData::TimeLastRemoved, Those that happen after will be on such a bad connection that it doest matter.

Protected variable

FMassClientHand...

 

ClientHandle

Protected variable

FMassClientBubb...

 

Serializer

Base class pointer to the associated Serializer class

Functions

Name Description

Public function Virtual

void

 

Initialize

(
    TArray< AgentArrayItem >& InAgents,
    FMassClientBubbleSerializerBase& I...
)

This must be called from outside before InitializeForWorld() is called.

Protected function

void

 

PostReplicatedAddEntitiesHelper

(
    const TArrayView< int32 > AddedIndi...,
    FAddRequirementsForSpawnQueryFuncti...,
    FCacheFragmentViewsForSpawnQueryFun...,
    FSetSpawnedEntityDataFunction SetSp...
)

Used by PostReplicatedAddHelper

Protected function

void

 

PostReplicatedAddHelper

(
    const TArrayView< int32 > AddedIndi...,
    FAddRequirementsForSpawnQueryFuncti...,
    FCacheFragmentViewsForSpawnQueryFun...,
    FSetSpawnedEntityDataFunction SetSp...,
    FSetModifiedEntityDataFunction SetM...
)

Called from TClientBubbleHandlerBase derived classes in PostReplicatedAd()

Protected function

void

 

PostReplicatedChangeHelper

(
    const TArrayView< int32 > ChangedIn...,
    FSetModifiedEntityDataFunction SetM...
)

Called from TClientBubbleHandlerBase derived classes in PostReplicatedChange()

Overridden from IClientBubbleHandlerInterface

Name Description

Protected function Virtual

void

 

DebugValidateBubbleOnClient()

Protected function Virtual

void

 

DebugValidateBubbleOnServer()

Public function Virtual

void

 

InitializeForWorld

(
    UWorld& InWorld
)

Protected function Virtual

void

 

PreReplicatedRemove

(
    const TArrayView< int32 > RemovedIn...,
    int32 FinalSize
)

These functions are processed internally by TClientBubbleHandlerBase

Protected function Virtual

void

 

Reset()

Protected function Virtual

void

 

SetClientHandle

(
    FMassClientHandle InClientHandle
)

Protected function Virtual

void

 

Tick

(
    float DeltaTime
)

Protected function Virtual

void

 

UpdateAgentsToRemove()

Typedefs