rules

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

@@ -0,0 +1,31 @@
+# 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: LocalScript
+type: class
+memory_category: Script
+summary: |
+  An object that contains and runs Luau code on the client (player's device)
+  instead of the server.
+description: |
+  A `Class.LocalScript` is a Luau source container that runs its contents on the
+  client (player's device) instead of the server. It is used to access
+  client-only objects such as the player's `Class.Camera`.
+
+  For code run through `Class.LocalScript|LocalScripts`, the
+  `Class.Players.LocalPlayer|LocalPlayer` property of the `Class.Players`
+  service will return the player whose client is running the script.
+
+  See [here](../../../projects/data-model.md#client) for a table of valid
+  container services from which `Class.LocalScript|LocalScripts` will execute.
+code_samples: []
+inherits:
+  - Script
+descendants: []
+tags: []
+deprecation_message: ''
+properties: []
+methods: []
+events: []
+callbacks: []