Navigation
Unreal Engine C++ API Reference > Plugins > OnlineSubsystem > Interfaces
Inheritance Hierarchy
- FSharedFromThisBase
- 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
Type | Name | Description | |
---|---|---|---|
![]() |
int32 | RevisionCount | Id representing number of updates sent, useful for determining if a client has missed an update |
![]() |
int32 | TotalBytes | Stat tracking variables Total number of bytes generated by calls to ToJsonFull and ToJsonDirty |
![]() |
int32 | TotalEffectiveBytes | Total number of bytes generated by calls to ToJsonFull and ToJsonDirty, multiplied by the number of recipients the packet was sent to |
![]() |
int32 | TotalPackets | Total number of packets generated by calls to ToJsonFull and ToJsonDirty |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
|||
![]() |
FOnlinePartyData
(
const FOnlinePartyData& |
||
![]() |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | Clear the attributes map | |
![]() ![]() |
void | ClearDirty () |
Clear the dirty keys set, called after successfully sending an update of the dirty elements |
![]() |
void | Update attributes from a JSON packet | |
![]() ![]() |
TSharedRef< FJsonObject > | Create a JSON object containing all key-value attributes | |
![]() ![]() |
FString | Create a string representing a JSON object containing all key-value attributes | |
![]() ![]() |
bool | GetAttribute
(
const FString& AttrName, |
Get an attribute from the party data |
![]() ![]() |
void | GetDirtyKeyValAttrs
(
FOnlineKeyValuePairs< FString, FVariantData >& OutDirtyAttrs, |
Get the dirty and removed key-value attributes |
![]() ![]() |
const FOnlineKeyValuePairs< FString, FVariantData > & | ||
![]() |
FOnlineKeyValuePairs< FString, FVariantData > & | Accessor functions for KeyValAttrs map | |
![]() ![]() |
bool | HasDirtyKeys () |
Check if there are any dirty keys |
![]() ![]() |
void | MarkAttributeDirty
(
FString&& AttrName |
Mark an attribute as dirty so it can be rebroadcasted |
![]() ![]() |
void | OnPacketSent
(
int32 PacketSize, |
Increment the stat tracking variables on packet sent |
![]() |
void | RemoveAttribute
(
const FString& AttrName |
Remove an attribute from the party data |
![]() ![]() |
void | RemoveAttribute
(
FString&& AttrName |
Remove an attribute from the party data |
![]() |
void | SetAttribute
(
const FString& AttrName, |
Set an attribute from the party data |
![]() ![]() |
void | SetAttribute
(
FString&& AttrName, |
Set an attribute from the party data |
![]() ![]() |
void | ToJsonDirty
(
FString& JsonString |
Generate a JSON packet containing only the dirty key-value attributes for a delta update |
![]() ![]() |
void | ToJsonFull
(
FString& JsonString |
Generate a JSON packet containing all key-value attributes |
Operators
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
bool | operator!=
(
const FOnlinePartyData& Other |
Inequality operator |
![]() |
FOnlinePartyData & | operator=
(
const FOnlinePartyData& |
|
![]() |
FOnlinePartyData & | operator=
(
FOnlinePartyData&& |
|
![]() ![]() |
bool | operator==
(
const FOnlinePartyData& Other |
Equality operator |