Retrieves a list of player identifiers for the local player’s friends.
- iOS 4.1–8.0Deprecated
- macOS 10.8–10.10Deprecated
- Mac Catalyst 13.0–13.0Deprecated
- watchOS 2.0–2.0Deprecated
A block to be called when the request completes.
The block receives the following parameters:
An array of
NSStringobjects containing the player identifiers for the players that are friends of the local player. If an error occurred, this value can be non-
nil. In that case, the array contains the data that Game Kit was able to download before the error occurred.
If an error occurred, this parameter holds an error object that explains the error. Otherwise, the value of this parameter is
When this method is called, it creates a new background task to handle the request. The method then returns control to your game. Later, when the task is complete, Game Kit calls your completion handler. The completion handler is always called on the main thread.
Once this call is completed, the
friends property of the shared local player object is set to the same list of players returned in the completion handler.