---
title: "loadFriendPlayers(completionHandler:)"
framework: gamekit
role: symbol
role_heading: Instance Method
path: "gamekit/gklocalplayer/loadfriendplayers(completionhandler:)"
---

# loadFriendPlayers(completionHandler:)

Retrieves a list of player identifiers for the local player’s friends.

## Declaration

```swift
func loadFriendPlayers(completionHandler: (@Sendable ([GKPlayer]?, (any Error)?) -> Void)? = nil)
```

```swift
func loadFriendPlayers() async throws -> [GKPlayer]
```

## Parameters

- `completionHandler`: A block to call when the request completes. The block receives the following parameters:

## Discussion

Discussion The code below shows an example of how to load a player’s friends. Create your own method to save information about the found players. - (void) retrieveFriends {    GKLocalPlayer *lp = [GKLocalPlayer localPlayer];    if (lp.authenticated)    {       [lp loadFriendPlayersWithCompletionHandler:^(NSArray *friendPlayers, NSError *error) {          if (friendPlayers != nil)          {             [self loadPlayerData: friendPlayers];          }       }];    } }

## See Also

### Deprecated methods

- [authenticate(completionHandler:)](gamekit/gklocalplayer/authenticate(completionhandler:).md)
- [generateIdentityVerificationSignature(completionHandler:)](gamekit/gklocalplayer/generateidentityverificationsignature(completionhandler:).md)
- [loadDefaultLeaderboardCategoryID(completionHandler:)](gamekit/gklocalplayer/loaddefaultleaderboardcategoryid(completionhandler:).md)
- [loadFriendsObsoleted(completionHandler:)](gamekit/gklocalplayer/loadfriendsobsoleted(completionhandler:).md)
- [setDefaultLeaderboardCategoryID(_:completionHandler:)](gamekit/gklocalplayer/setdefaultleaderboardcategoryid(_:completionhandler:).md)