Skip to content

Commit d1fd858

Browse files
committed
Update friend widget binding documentation
1 parent 3a86b4e commit d1fd858

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/framework/bind_friends_list.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,16 @@ Friend list entries provide the following information as variables or functions
7373
- `UserId`: The user ID.
7474
- `DisplayName`: The user's display name.
7575
- `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.
7779
- `InviteStatus`: The user's invite status, and how they are related to the local player.
7880
- `PresenceStatus`: The user's presence status.
7981
- `bPlayingThisGame`: If true, this user is currently playing this game.
8082
- `bIsGameFriend`: If true, this user is a friend only at the game level, and not from the platform.
8183
- `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.
8284
- `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.
8386
- `GetSectionType()`: Returns the section type that this entry should be displayed under.
8487

8588
## 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
99102
| Can Reject Friend Request | Reject Friend Request from Friend List Entry |
100103
| Can Join Party | Join Party of Friend List Entry |
101104
| 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 |
106107

107108
### Check if an action can be performed
108109

0 commit comments

Comments
 (0)