> ## Documentation Index
> Fetch the complete documentation index at: https://docs.summerengine.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SummerFriend

> One of the player's Summer friends, as this Game may see them.

**Class:** `SummerFriend` · **Inherits:** RefCounted

One of the player's Summer friends, as this Game may see them.

An immutable view of one friend in one read of [`Summer.client.friends`](/api-reference/gdscript/client#friends). A later read that changes this friend replaces the object, so key UI by [`user_id`](/api-reference/gdscript/types/friend#user_id) rather than holding the object. [`user_id`](/api-reference/gdscript/types/friend#user_id) and [`display_name`](/api-reference/gdscript/types/friend#display_name) match the identity the Game sees for the same player in a [`SummerSession`](/api-reference/gdscript/types/session).

## Properties

| Property | Type | Access | Description |
| - | - | - | - |
| <a id="display_name" />`display_name` | String | read-only, `get_display_name()` | The friend's current Summer display name. |
| <a id="handle" />`handle` | String | read-only, `get_handle()` | The friend's Summer handle, or an empty `String` when they have not claimed one. |
| <a id="status" />`status` | StringName | read-only, `get_status()` | `offline`, `online`, `in_this_game` when the friend is playing this Game, or `in_other_game` when they are playing another Game, which is never named. A friend who does not share their activity appears `offline`. `unknown` means the platform could not read the friend's presence right now; it is not `offline`. |
| <a id="user_id" />`user_id` | String | read-only, `get_user_id()` | The friend's stable Summer user ID. Pass it to `SummerClientFriends.show_profile`, `SummerClientFriends.show_chat` or `SummerClientMessages.send`. |

***

What is live on the platform today: [platform capability status](/knowledge-base/source-status). Check availability at runtime before you offer a feature.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.