# Friends List Display

## Goal

Load the player’s friends list and iterate it to populate your UI.

## Prerequisite

Make sure the player is authenticated first. Use `use-case-1-auth-bootstrap.md` for a safe startup flow.

## Actions used

* `GameServicesLoadFriends`
* `GameServicesGetLoadFriendsSuccessResult` (on success; gives `friendsCount`)
* `GameServicesGetLoadFriendsError` (on failure)
* `GameServicesGetFriendInfo` (iterate friends)

## Variables

* `friendsCount` (Int)
* `friendIndex` (Int)
* `playerId` (String), `displayName` (String), `alias` (String)

## Flow

1. State: `LoadFriends`
   * Action: `GameServicesLoadFriends`
   * Events:
     * `successEvent` → `GetFriendsCount`
     * `failureEvent` → `GetLoadFriendsError` (or show “no friends”)
2. State: `GetFriendsCount`
   * Action: `GameServicesGetLoadFriendsSuccessResult` → `friendsCount`
   * Set `friendIndex = 0`
3. Loop:
   * While `friendIndex < friendsCount`:
     * Action: `GameServicesGetFriendInfo` (input: `friendIndex`)
     * Read outputs: `playerId`, `displayName`, `alias`
     * Add to UI
     * `friendIndex++`

## Notes

* Friend lists can be empty due to privacy settings or no friends on the service.
* Refresh only when needed; `GameServicesLoadFriends` clears and repopulates the cached list.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://assetstore.essentialkit.voxelbusters.com/features/game-services/playmaker/use-cases/use-case-6-friends-display.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.