rules

.cursor/rules/roblox/reference/engine/classes/FriendPages.yaml

@@ -0,0 +1,52 @@
+# This file is automatically generated. Please don't edit it manually.
+# To submit a bug report on the content, see
+# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
+
+name: FriendPages
+type: class
+memory_category: Instances
+summary: |
+  A special version of `Class.Pages` that contains information about a player's
+  connections.
+description: |
+  FriendPages is a special version of `Class.Pages` returned by
+  `Class.Players:GetFriendsAsync()`. The items contained within include
+  information about a player's connections and have the following structure:
+
+  <table>
+  <tr>
+  <th>Name</th>
+  <th>Type</th>
+  <th>Description</th>
+  </tr>
+  <tr>
+  <td><code>DisplayName</code></td>
+  <td>string</td>
+  <td>The current display name of the connection.</td>
+  </tr>
+  <tr>
+  <td><code>Id</code></td>
+  <td>int64</td>
+  <td>The user ID of the connection.</td>
+  </tr>
+  <tr>
+  <td><code>Username</code></td>
+  <td>string</td>
+  <td>The username of the connection.</td>
+  </tr>
+  </table>
+
+  See the code samples for how to iterate over a player's connections.
+code_samples:
+  - print-roblox-friends
+inherits:
+  - Pages
+descendants: []
+tags:
+  - NotCreatable
+  - NotReplicated
+deprecation_message: ''
+properties: []
+methods: []
+events: []
+callbacks: []