UgsFriends
16 tools in this family (folder Editor/Tools/UgsFriends/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.
| Tool | Effect | Description |
|---|---|---|
ugs_friends_accept_request | writes | Accept an incoming friend request — promotes the pending request to a confirmed friendship. The |
ugs_friends_add | writes | Send a friend request to another player by their Unity Player ID. The request stays in their |
ugs_friends_block | writes | Block a player. Blocking removes any existing friendship, drops pending requests in both directions,… |
ugs_friends_decline_request | writes | Reject an incoming friend request OR cancel an outgoing one. mode='incoming' declines a request |
ugs_friends_export_setup | read-only | Export the current Friends state as a JSON snapshot: package availability, session info, friend list… |
ugs_friends_get_blocked | read-only | Get the current blocked-players list. Each entry has the same shape as a friend entry (id, name, |
ugs_friends_get_friend_presence | read-only | Get a specific friend's current presence (availability + activity dict). Returns availability=Offlin… |
ugs_friends_get_recent_players | read-only | Get the recent-players list — players we recently matched / lobbied with. Auto-populated by the UGS |
ugs_friends_get_requests | read-only | Get pending friend requests — both incoming (others sent us) and outgoing (we sent them). Each entry… |
ugs_friends_init | writes | Verify UGS Authentication is initialized and the player is signed in (Friends requires UGS Auth). |
ugs_friends_list | read-only | Get the current friend list — confirmed bidirectional friendships only (does NOT include pending |
ugs_friends_remove | writes | Unfriend a player. Both sides see the friendship disappear immediately. Idempotent — removing |
ugs_friends_send_message | writes | Send a light-weight direct message to a friend — intended for game invites, gift notifications, and |
ugs_friends_set_presence | writes | Broadcast my presence to friends — availability state plus an optional activity dict that friends |
ugs_friends_set_profile_name | writes | Update the local player's display name as shown to friends. <= 64 chars. This is the name friends se… |
ugs_friends_unblock | writes | Unblock a previously-blocked player. The relationship returns to None — they are NOT automatically |