FOnlinePartyData

Data associated with the entire party

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

FOnlinePartyData

References

Module

OnlineSubsystem

Header

/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlinePartyInterface.h

Include

#include "Interfaces/OnlinePartyInterface.h"

Syntax

class FOnlinePartyData : public TSharedFromThis< FOnlinePartyData >

Remarks

Data associated with the entire party

Variables

Name Description

Public variable

int32

 

RevisionCount

Id representing number of updates sent, useful for determining if a client has missed an update

Public variable

int32

 

TotalBytes

Stat tracking variables Total number of bytes generated by calls to ToJsonFull and ToJsonDirty

Public variable

int32

 

TotalEffectiveBytes

Total number of bytes generated by calls to ToJsonFull and ToJsonDirty, multiplied by the number of recipients the packet was sent to

Public variable

int32

 

TotalPackets

Total number of packets generated by calls to ToJsonFull and ToJsonDirty

Constructors

Destructors

Name Description

Public function Virtual

~FOnlinePartyData()

Functions

Name Description

Public function

void

 

ClearAttributes()

Clear the attributes map

Public function

void

 

ClearDirty()

Clear the dirty keys set, called after successfully sending an update of the dirty elements

Public function

void

 

FromJson

(
    const FString& JsonString
)

Update attributes from a JSON packet

Public function Const

TSharedRef< ...

 

GetAllAttributesAsJsonObject()

Create a JSON object containing all key-value attributes

Public function Const

FString

 

GetAllAttributesAsJsonObjectString()

Create a string representing a JSON object containing all key-value attributes

Public function Const

bool

 

GetAttribute

(
    const FString& AttrName,
    FVariantData& OutAttrValue
)

Get an attribute from the party data

Public function Const

void

 

GetDirtyKeyValAttrs

(
    FOnlineKeyValuePairs< FString, FVar...,
    TArray< FString >& OutRemovedAttrs
)

Get the dirty and removed key-value attributes

Public function Const

const FOnlin...

 

GetKeyValAttrs()

Public function

FOnlineKeyVa...

 

GetKeyValAttrs()

Accessor functions for KeyValAttrs map

Public function Const

bool

 

HasDirtyKeys()

Check if there are any dirty keys

Public function

void

 

MarkAttributeDirty

(
    FString&& AttrName
)

Mark an attribute as dirty so it can be rebroadcasted

Public function Const

void

 

OnPacketSent

(
    int32 PacketSize,
    int32 NumRecipients,
    bool bIncrementRevision
)

Increment the stat tracking variables on packet sent

Public function

void

 

RemoveAttribute

(
    FString&& AttrName
)

Remove an attribute from the party data

Public function

void

 

RemoveAttribute

(
    const FString& AttrName
)

Remove an attribute from the party data

Public function

void

 

SetAttribute

(
    const FString& AttrName,
    const FVariantData& AttrValue
)

Set an attribute from the party data

Public function

void

 

SetAttribute

(
    FString&& AttrName,
    FVariantData&& AttrValue
)

Set an attribute from the party data

Public function Const

void

 

ToJsonDirty

(
    FString& JsonString
)

Generate a JSON packet containing only the dirty key-value attributes for a delta update

Public function Const

void

 

ToJsonFull

(
    FString& JsonString
)

Generate a JSON packet containing all key-value attributes

Operators

Name Description

Public function Const

bool

 

operator!=

(
    const FOnlinePartyData& Other
)

Inequality operator

Public function

FOnlineParty...

 

operator=

(
    const FOnlinePartyData&
)

Public function

FOnlineParty...

 

operator=

(
    FOnlinePartyData&&
)

Public function Const

bool

 

operator==

(
    const FOnlinePartyData& Other
)

Equality operator
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss