Skip to content

Commit fe22fce

Browse files
committed
Update README to match feature
1 parent 710ec7c commit fe22fce

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,8 +229,9 @@ Returns the friend list of any Steam user, provided his Steam Community profile
229229
Name | Type | Description | Required | Default
230230
-----|------|-------------|----------|---------
231231
relationship| string (all or friend) | The type of friends to get | No | all
232+
summaries| bool (true or false) | To return the friend player summaries, or only steamIds | No | true
232233

233-
Once the list of friends is gathered, it is passed through [GetPlayerSummaries](#GetPlayerSummaries). This allows you to get back a collection of Player objects.
234+
Once the list of friends is gathered, if `summaries` is not set to `false`; it is passed through [GetPlayerSummaries](#GetPlayerSummaries). This allows you to get back a collection of Player objects.
234235

235236

236237
> Example Output: [GetFriendList](./examples/user/GetFriendList.txt)

0 commit comments

Comments
 (0)