Navigation
API > API/Plugins > API/Plugins/Party
Base struct used to replicate data about the state of a single party member to all members.
| Name | FPartyMemberRepData |
| Type | struct |
| Header File | /Engine/Plugins/Online/OnlineFramework/Source/Party/Public/Party/PartyMember.h |
| Include Path | #include "Party/PartyMember.h" |
Syntax
USTRUCT ()
struct FPartyMemberRepData : public FOnlinePartyRepDataBase
Inheritance Hierarchy
- FOnlinePartyRepDataBase → FPartyMemberRepData
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPartyMemberRepData() |
Party/PartyMember.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| CrossplayPreferenceArgType | std::conditional_t< TOr< TIsPODType< ECrossplayPreference >, TIsPointer< ECrossplayPreference > >::Value, ECrossplayPreference, const MutableCrossplayPreferenceType & > | Party/PartyMember.h | |
| FOnCrossplayPreferenceChanged | TMulticastDelegate_OneParam< void, CrossplayPreferenceArgType > | Bummer to have two signatures, but cases that want both the old and new values are much rarer, so most don't want to bother with a handler that takes an extra unused param | Party/PartyMember.h |
| FOnCrossplayPreferenceChangedDif | TMulticastDelegate_TwoParams< void, CrossplayPreferenceArgType, CrossplayPreferenceArgType > | Party/PartyMember.h | |
| FOnJoinInProgressDataRequestChanged | TMulticastDelegate_OneParam< void, JoinInProgressDataRequestArgType > | Bummer to have two signatures, but cases that want both the old and new values are much rarer, so most don't want to bother with a handler that takes an extra unused param | Party/PartyMember.h |
| FOnJoinInProgressDataRequestChangedDif | TMulticastDelegate_TwoParams< void, JoinInProgressDataRequestArgType, JoinInProgressDataRequestArgType > | Party/PartyMember.h | |
| FOnJoinInProgressDataResponsesChanged | TMulticastDelegate_OneParam< void, JoinInProgressDataResponsesArgType > | Bummer to have two signatures, but cases that want both the old and new values are much rarer, so most don't want to bother with a handler that takes an extra unused param | Party/PartyMember.h |
| FOnJoinInProgressDataResponsesChangedDif | TMulticastDelegate_TwoParams< void, JoinInProgressDataResponsesArgType, JoinInProgressDataResponsesArgType > | Party/PartyMember.h | |
| FOnJoinMethodChanged | TMulticastDelegate_OneParam< void, JoinMethodArgType > | Bummer to have two signatures, but cases that want both the old and new values are much rarer, so most don't want to bother with a handler that takes an extra unused param | Party/PartyMember.h |
| FOnJoinMethodChangedDif | TMulticastDelegate_TwoParams< void, JoinMethodArgType, JoinMethodArgType > | Party/PartyMember.h | |
| FOnPlatformDataPlatformChanged | TMulticastDelegate_OneParam< void, PlatformDataPlatformArgType > | Bummer to have two signatures, but cases that want both the old and new values are much rarer, so most don't want to bother with a handler that takes an extra unused param | Party/PartyMember.h |
| FOnPlatformDataPlatformChangedDif | TMulticastDelegate_TwoParams< void, PlatformDataPlatformArgType, PlatformDataPlatformArgType > | Party/PartyMember.h | |
| FOnPlatformDataSessionIdChanged | TMulticastDelegate_OneParam< void, PlatformDataSessionIdArgType > | Bummer to have two signatures, but cases that want both the old and new values are much rarer, so most don't want to bother with a handler that takes an extra unused param | Party/PartyMember.h |
| FOnPlatformDataSessionIdChangedDif | TMulticastDelegate_TwoParams< void, PlatformDataSessionIdArgType, PlatformDataSessionIdArgType > | Party/PartyMember.h | |
| FOnPlatformDataUniqueIdChanged | TMulticastDelegate_OneParam< void, PlatformDataUniqueIdArgType > | Bummer to have two signatures, but cases that want both the old and new values are much rarer, so most don't want to bother with a handler that takes an extra unused param | Party/PartyMember.h |
| FOnPlatformDataUniqueIdChangedDif | TMulticastDelegate_TwoParams< void, PlatformDataUniqueIdArgType, PlatformDataUniqueIdArgType > | Party/PartyMember.h | |
| JoinInProgressDataRequestArgType | std::conditional_t< TOr< TIsPODType< FPartyMemberJoinInProgressRequest >, TIsPointer< FPartyMemberJoinInProgressRequest > >::Value, FPartyMemberJoinInProgressRequest, const MutableJoinInProgressDataRequestType & > | Party/PartyMember.h | |
| JoinInProgressDataResponsesArgType | std::conditional_t< TOr< TIsPODType< TArray< FPartyMemberJoinInProgressResponse > >, TIsPointer< TArray< FPartyMemberJoinInProgressResponse > > >::Value, TArray< FPartyMemberJoinInProgressResponse >, const MutableJoinInProgressDataResponsesType & > | Party/PartyMember.h | |
| JoinMethodArgType | std::conditional_t< TOr< TIsPODType< FString >, TIsPointer< FString > >::Value, FString, const MutableJoinMethodType & > | Party/PartyMember.h | |
| MutableCrossplayPreferenceType | std::remove_const_t< ECrossplayPreference > | If the property is a POD or ptr type, we'll work with it by copy. Otherwise, by const ref | Party/PartyMember.h |
| MutableJoinInProgressDataRequestType | std::remove_const_t< FPartyMemberJoinInProgressRequest > | If the property is a POD or ptr type, we'll work with it by copy. Otherwise, by const ref | Party/PartyMember.h |
| MutableJoinInProgressDataResponsesType | std::remove_const_t< TArray< FPartyMemberJoinInProgressResponse > > | If the property is a POD or ptr type, we'll work with it by copy. Otherwise, by const ref | Party/PartyMember.h |
| MutableJoinMethodType | std::remove_const_t< FString > | If the property is a POD or ptr type, we'll work with it by copy. Otherwise, by const ref | Party/PartyMember.h |
| MutablePlatformDataPlatformType | std::remove_const_t< FUserPlatform > | If the property is a POD or ptr type, we'll work with it by copy. Otherwise, by const ref | Party/PartyMember.h |
| MutablePlatformDataSessionIdType | std::remove_const_t< FSessionId > | If the property is a POD or ptr type, we'll work with it by copy. Otherwise, by const ref | Party/PartyMember.h |
| MutablePlatformDataUniqueIdType | std::remove_const_t< FUniqueNetIdRepl > | If the property is a POD or ptr type, we'll work with it by copy. Otherwise, by const ref | Party/PartyMember.h |
| PlatformDataPlatformArgType | std::conditional_t< TOr< TIsPODType< FUserPlatform >, TIsPointer< FUserPlatform > >::Value, FUserPlatform, const MutablePlatformDataPlatformType & > | Party/PartyMember.h | |
| PlatformDataSessionIdArgType | std::conditional_t< TOr< TIsPODType< FSessionId >, TIsPointer< FSessionId > >::Value, FSessionId, const MutablePlatformDataSessionIdType & > | Party/PartyMember.h | |
| PlatformDataUniqueIdArgType | std::conditional_t< TOr< TIsPODType< FUniqueNetIdRepl >, TIsPointer< FUniqueNetIdRepl > >::Value, FUniqueNetIdRepl, const MutablePlatformDataUniqueIdType & > | Party/PartyMember.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAllowOwnerless | bool | Party/PartyMember.h | ||
| CrossplayPreference | ECrossplayPreference | The crossplay preference of this user. Only relevant to crossplay party scenarios. | Party/PartyMember.h | |
| JoinInProgressData | FPartyMemberJoinInProgressData | Data used for join in progress flow. | Party/PartyMember.h | |
| JoinMethod | FString | Method used to join the party | Party/PartyMember.h | |
| OnCrossplayPreferenceChangedDifEvent | FOnCrossplayPreferenceChangedDif | Party/PartyMember.h | ||
| OnCrossplayPreferenceChangedEvent | FOnCrossplayPreferenceChanged | Party/PartyMember.h | ||
| OnJoinInProgressDataRequestChangedDifEvent | FOnJoinInProgressDataRequestChangedDif | Party/PartyMember.h | ||
| OnJoinInProgressDataRequestChangedEvent | FOnJoinInProgressDataRequestChanged | Party/PartyMember.h | ||
| OnJoinInProgressDataResponsesChangedDifEvent | FOnJoinInProgressDataResponsesChangedDif | Party/PartyMember.h | ||
| OnJoinInProgressDataResponsesChangedEvent | FOnJoinInProgressDataResponsesChanged | Party/PartyMember.h | ||
| OnJoinMethodChangedDifEvent | FOnJoinMethodChangedDif | Party/PartyMember.h | ||
| OnJoinMethodChangedEvent | FOnJoinMethodChanged | Party/PartyMember.h | ||
| OnPlatformDataPlatformChangedDifEvent | FOnPlatformDataPlatformChangedDif | Party/PartyMember.h | ||
| OnPlatformDataPlatformChangedEvent | FOnPlatformDataPlatformChanged | Party/PartyMember.h | ||
| OnPlatformDataSessionIdChangedDifEvent | FOnPlatformDataSessionIdChangedDif | Party/PartyMember.h | ||
| OnPlatformDataSessionIdChangedEvent | FOnPlatformDataSessionIdChanged | Party/PartyMember.h | ||
| OnPlatformDataUniqueIdChangedDifEvent | FOnPlatformDataUniqueIdChangedDif | Party/PartyMember.h | ||
| OnPlatformDataUniqueIdChangedEvent | FOnPlatformDataUniqueIdChanged | Party/PartyMember.h | ||
| OwnerMember | TWeakObjectPtr< const UPartyMember > | Party/PartyMember.h | ||
| PlatformData | FPartyMemberPlatformData | Platform data fields for party replication | Party/PartyMember.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
CrossplayPreferenceArgType GetCrossplayPreference() |
Party/PartyMember.h | ||
JoinInProgressDataRequestArgType GetJoinInProgressDataRequest() |
Party/PartyMember.h | ||
JoinInProgressDataResponsesArgType GetJoinInProgressDataResponses() |
Party/PartyMember.h | ||
JoinMethodArgType GetJoinMethod() |
Party/PartyMember.h | ||
PlatformDataPlatformArgType GetPlatform() |
Party/PartyMember.h | ||
PlatformDataPlatformArgType GetPlatformDataPlatform() |
Party/PartyMember.h | ||
PlatformDataSessionIdArgType GetPlatformDataSessionId() |
Party/PartyMember.h | ||
PlatformDataUniqueIdArgType GetPlatformDataUniqueId() |
Party/PartyMember.h | ||
PlatformDataSessionIdArgType GetPlatformSessionId() |
Party/PartyMember.h | ||
PlatformDataUniqueIdArgType GetPlatformUniqueId() |
Party/PartyMember.h | ||
void MarkOwnerless () |
Mark the party data as ownerless. | Party/PartyMember.h | |
FOnCrossplayPreferenceChanged & OnCrossplayPreferenceChanged() |
Bind to receive the new property value only on changes | Party/PartyMember.h | |
FOnCrossplayPreferenceChangedDif & OnCrossplayPreferenceChangedDif() |
Bind to receive both the new and old property value on changes | Party/PartyMember.h | |
FOnJoinInProgressDataRequestChanged & OnJoinInProgressDataRequestChanged() |
Bind to receive the new property value only on changes | Party/PartyMember.h | |
FOnJoinInProgressDataRequestChangedDif & OnJoinInProgressDataRequestChangedDif() |
Bind to receive both the new and old property value on changes | Party/PartyMember.h | |
FOnJoinInProgressDataResponsesChanged & OnJoinInProgressDataResponsesChanged() |
Bind to receive the new property value only on changes | Party/PartyMember.h | |
FOnJoinInProgressDataResponsesChangedDif & OnJoinInProgressDataResponsesChangedDif() |
Bind to receive both the new and old property value on changes | Party/PartyMember.h | |
FOnJoinMethodChanged & OnJoinMethodChanged() |
Bind to receive the new property value only on changes | Party/PartyMember.h | |
FOnJoinMethodChangedDif & OnJoinMethodChangedDif() |
Bind to receive both the new and old property value on changes | Party/PartyMember.h | |
FOnPlatformDataPlatformChanged & OnPlatformChanged() |
Bind to receive the new property value only on changes | Party/PartyMember.h | |
FOnPlatformDataPlatformChangedDif & OnPlatformChangedDif() |
Bind to receive both the new and old property value on changes | Party/PartyMember.h | |
FOnPlatformDataPlatformChanged & OnPlatformDataPlatformChanged() |
Bind to receive the new property value only on changes | Party/PartyMember.h | |
FOnPlatformDataPlatformChangedDif & OnPlatformDataPlatformChangedDif() |
Bind to receive both the new and old property value on changes | Party/PartyMember.h | |
FOnPlatformDataSessionIdChanged & OnPlatformDataSessionIdChanged() |
Bind to receive the new property value only on changes | Party/PartyMember.h | |
FOnPlatformDataSessionIdChangedDif & OnPlatformDataSessionIdChangedDif() |
Bind to receive both the new and old property value on changes | Party/PartyMember.h | |
FOnPlatformDataUniqueIdChanged & OnPlatformDataUniqueIdChanged() |
Bind to receive the new property value only on changes | Party/PartyMember.h | |
FOnPlatformDataUniqueIdChangedDif & OnPlatformDataUniqueIdChangedDif() |
Bind to receive both the new and old property value on changes | Party/PartyMember.h | |
FOnPlatformDataSessionIdChanged & OnPlatformSessionIdChanged() |
Bind to receive the new property value only on changes | Party/PartyMember.h | |
FOnPlatformDataSessionIdChangedDif & OnPlatformSessionIdChangedDif() |
Bind to receive both the new and old property value on changes | Party/PartyMember.h | |
FOnPlatformDataUniqueIdChanged & OnPlatformUniqueIdChanged() |
Bind to receive the new property value only on changes | Party/PartyMember.h | |
FOnPlatformDataUniqueIdChangedDif & OnPlatformUniqueIdChangedDif() |
Bind to receive both the new and old property value on changes | Party/PartyMember.h | |
void SetCrossplayPreference
(
CrossplayPreferenceArgType NewCrossplayPreference |
Party/PartyMember.h | ||
void SetJoinInProgressDataRequest
(
JoinInProgressDataRequestArgType NewJoinInProgressDataRequest |
Party/PartyMember.h | ||
void SetJoinInProgressDataResponses
(
JoinInProgressDataResponsesArgType NewJoinInProgressDataResponses |
Party/PartyMember.h | ||
void SetJoinMethod
(
JoinMethodArgType NewJoinMethod |
Party/PartyMember.h | ||
virtual void SetOwningMember
(
const UPartyMember& InOwnerMember |
Party/PartyMember.h | ||
void SetPlatform
(
PlatformDataPlatformArgType NewPlatformDataPlatform |
Party/PartyMember.h | ||
void SetPlatformDataPlatform
(
PlatformDataPlatformArgType NewPlatformDataPlatform |
Party/PartyMember.h | ||
void SetPlatformDataSessionId
(
PlatformDataSessionIdArgType NewPlatformDataSessionId |
Party/PartyMember.h | ||
void SetPlatformDataUniqueId
(
PlatformDataUniqueIdArgType NewPlatformDataUniqueId |
Party/PartyMember.h | ||
void SetPlatformSessionId
(
PlatformDataSessionIdArgType NewPlatformDataSessionId |
Party/PartyMember.h | ||
void SetPlatformUniqueId
(
PlatformDataUniqueIdArgType NewPlatformDataUniqueId |
Party/PartyMember.h |
Protected
Overridden from FOnlinePartyRepDataBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanEditData() |
Party/PartyMember.h | ||
virtual void CompareAgainst
(
const FOnlinePartyRepDataBase& OldData |
Compare this data against the given old data, triggering delegates as appropriate. | Party/PartyMember.h | |
virtual const USocialParty * GetOwnerParty() |
Party/PartyMember.h | ||
virtual const UPartyMember * GetOwningMember() |
Party/PartyMember.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPartyMemberRepData & operator=
(
const FPartyMemberRepData& Other |
Party/PartyMember.h |