1. Epic GamesDeveloper
  3. FOnlinePartyData

FOnlinePartyData

Data associated with the entire party

API > API/Plugins > API/Plugins/OnlineSubsystem

Data associated with the entire party

   
Name FOnlinePartyData
Type class
Header File /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlinePartyInterface.h
Include Path #include "Interfaces/OnlinePartyInterface.h"

Syntax

class FOnlinePartyData : public TSharedFromThis< FOnlinePartyData >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  Interfaces/OnlinePartyInterface.h  
  Interfaces/OnlinePartyInterface.h  
  Interfaces/OnlinePartyInterface.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FOnlinePartyData()

   Interfaces/OnlinePartyInterface.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
RevisionCount int32 Id representing number of updates sent, useful for determining if a client has missed an update Interfaces/OnlinePartyInterface.h  
TotalBytes int32 Stat tracking variables Total number of bytes generated by calls to ToJsonFull and ToJsonDirty Interfaces/OnlinePartyInterface.h  
TotalEffectiveBytes int32 Total number of bytes generated by calls to ToJsonFull and ToJsonDirty, multiplied by the number of recipients the packet was sent to Interfaces/OnlinePartyInterface.h  
TotalPackets int32 Total number of packets generated by calls to ToJsonFull and ToJsonDirty Interfaces/OnlinePartyInterface.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
DirtyKeys TSet< FString > Set of which fields are dirty and need to transmitted Interfaces/OnlinePartyInterface.h  
KeyValAttrs FOnlineKeyValuePairs< FString, FVariantData > Map of key/val attributes that represents the data Interfaces/OnlinePartyInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void ClearAttributes()

 Clear the attributes map Interfaces/OnlinePartyInterface.h  

virtual void ClearDirty()

 Clear the dirty keys set, called after successfully sending an update of the dirty elements Interfaces/OnlinePartyInterface.h  

void FromJson ( const FString& JsonString
)

 Update attributes from a JSON packet Interfaces/OnlinePartyInterface.h  

TSharedRef< FJsonObject > GetAllAttributesAsJsonObject()

 Create a JSON object containing all key-value attributes Interfaces/OnlinePartyInterface.h  

FString GetAllAttributesAsJsonObjectString()

 Create a string representing a JSON object containing all key-value attributes Interfaces/OnlinePartyInterface.h  

bool GetAttribute ( const FString& AttrName,
FVariantData& OutAttrValue
) const

 Get an attribute from the party data Interfaces/OnlinePartyInterface.h  

void GetDirtyKeyValAttrs ( FOnlineKeyValuePairs< FString, FVariantData >& OutDirtyAttrs,
TArray< FString >& OutRemovedAttrs
) const

 Get the dirty and removed key-value attributes Interfaces/OnlinePartyInterface.h  
  Interfaces/OnlinePartyInterface.h  
Accessor functions for KeyValAttrs map Interfaces/OnlinePartyInterface.h  

bool HasDirtyKeys()

 Check if there are any dirty keys Interfaces/OnlinePartyInterface.h  

virtual void MarkAttributeDirty ( FString&& AttrName
)

 Mark an attribute as dirty so it can be rebroadcasted Interfaces/OnlinePartyInterface.h  

void OnPacketSent ( int32 PacketSize,
int32 NumRecipients,
bool bIncrementRevision
) const

 Increment the stat tracking variables on packet sent Interfaces/OnlinePartyInterface.h  

void RemoveAttribute ( const FString& AttrName
)

 Remove an attribute from the party data Interfaces/OnlinePartyInterface.h  

virtual void RemoveAttribute ( FString&& AttrName
)

 Remove an attribute from the party data Interfaces/OnlinePartyInterface.h  

void SetAttribute ( const FString& AttrName,
const FVariantData& AttrValue
)

 Set an attribute from the party data Interfaces/OnlinePartyInterface.h  

virtual void SetAttribute ( FString&& AttrName,
FVariantData&& AttrValue
)

 Set an attribute from the party data Interfaces/OnlinePartyInterface.h  

void ToJsonDirty ( FString& JsonString
) const

 Generate a JSON packet containing only the dirty key-value attributes for a delta update Interfaces/OnlinePartyInterface.h  

void ToJsonFull ( FString& JsonString
) const

 Generate a JSON packet containing all key-value attributes Interfaces/OnlinePartyInterface.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FOnlinePartyData& Other
) const

 Inequality operator Interfaces/OnlinePartyInterface.h  
  Interfaces/OnlinePartyInterface.h  
  Interfaces/OnlinePartyInterface.h  

bool operator== ( const FOnlinePartyData& Other
) const

 Equality operator Interfaces/OnlinePartyInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page