FOnlineMessagePayload | Unreal Engine 5.7 Documentation

Message payload that stores key value pairs for variant type data


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

Syntax

class FOnlineMessagePayload

Name	Remarks	Include Path	Unreal Specifiers
FOnlineMessagePayload()	Constructor	Interfaces/OnlineMessageInterface.h

Name	Type	Remarks	Include Path
MaxPayloadSize	const int32	Max size of buffer when serializing payloads	Interfaces/OnlineMessageInterface.h

Name	Type	Remarks	Include Path	Unreal Specifiers
KeyValData	FOnlineKeyValuePairs< FString, FVariantData >	Key value attributes to store variant type data	Interfaces/OnlineMessageInterface.h

Name	Remarks	Include Path
void FromBytes ( const TArray< uint8 >& InBytes )	Convert byte array to key value data	Interfaces/OnlineMessageInterface.h
void FromJson ( const FJsonObject& JsonObject )	Convert json to key/val properties	Interfaces/OnlineMessageInterface.h
void FromJsonStr ( const FString& JsonStr )	Convert json string to key/val properties	Interfaces/OnlineMessageInterface.h
bool GetAttribute ( const FString& AttrName, FVariantData& OutAttrValue ) const	Find an attribute by name and get its value	Interfaces/OnlineMessageInterface.h
void SetAttribute ( const FString& AttrName, const FVariantData& AttrValue )	Set an attribute value by name	Interfaces/OnlineMessageInterface.h
void ToBytes ( TArray< uint8 >& OutBytes ) const	Convert the key value data to byte array	Interfaces/OnlineMessageInterface.h
void ToJson ( FJsonObject& OutJsonObject ) const	Convert key/val properties to json	Interfaces/OnlineMessageInterface.h
FString ToJsonStr()	Convert key/val properties to json str	Interfaces/OnlineMessageInterface.h