You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/framework/bind_friends_list.mdx
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,13 +73,16 @@ Friend list entries provide the following information as variables or functions
73
73
-`UserId`: The user ID.
74
74
-`DisplayName`: The user's display name.
75
75
-`bInParty`: This user is in the local player's current party.
76
-
-`bIsInvitable`: If true, this user can be invited to parties or games via EOS or the local platform.
76
+
-`bInGame`: This user is in the local player's current game.
77
+
-`bIsInvitableToParty`: If true, this user can be invited to the local player's current party.
78
+
-`bIsInvitableToGame`: If true, this user can be invited to the local player's current game.
77
79
-`InviteStatus`: The user's invite status, and how they are related to the local player.
78
80
-`PresenceStatus`: The user's presence status.
79
81
-`bPlayingThisGame`: If true, this user is currently playing this game.
80
82
-`bIsGameFriend`: If true, this user is a friend only at the game level, and not from the platform.
81
83
-`bIsBeingActedUpon`: If true, the local player is currently [performing some kind of action on this friend](#acting-on-friend-list-entries) (such as inviting them to the party). This boolean value can be used to disable UI elements when the user is already doing something or to show an operation as in-progress.
82
84
-`bInJoinableParty`: If the user is currently in a party that the local player can join.
85
+
-`bInJoinableGame`: If the user is currently in a game that the local player can join.
83
86
-`GetSectionType()`: Returns the section type that this entry should be displayed under.
84
87
85
88
## Acting on friend list entries
@@ -99,10 +102,8 @@ If you want to provide a list of actions that the user can take for a friend lis
99
102
| Can Reject Friend Request | Reject Friend Request from Friend List Entry |
100
103
| Can Join Party | Join Party of Friend List Entry |
101
104
| Can Leave Party | Leave Party of Friend List Entry |
102
-
103
-
:::note
104
-
"Join Game of Friend List Entry" will be added in a future release.
105
-
:::
105
+
| Can Join Game | Join Game Session of Friend List Entry |
106
+
| Can Invite to Game | Invite Friend List Entry to Game Session |
0 commit comments