rules

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

@@ -0,0 +1,36 @@
+# 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: Hint
+type: class
+memory_category: Instances
+summary: |
+  A Hint is an object that creates a small black bar at the very top of the
+  screen with text.
+description: |
+  A Hint is an object that creates a small black bar at the very top of the
+  screen with text. Its appearance cannot be customized in any way.
+
+  Notes:
+
+  - When a Hint is placed in the `Class.Workspace`, it will be visible to
+    everyone
+  - When placed under a player's `Class.PlayerGui`, it will be visible only to
+    that player
+  - Hints will render if placed in the `Class.CoreGui`
+code_samples: []
+inherits:
+  - Message
+descendants: []
+tags:
+  - Deprecated
+deprecation_message: |
+  With the introduction of Roblox's GUI features hints have been deprecated and
+  `Class.TextLabel|TextLabels` should be used instead for new work. The
+  `Class.TextLabel` object offers a wide range of features for displaying and
+  customizing text that hints do not.
+properties: []
+methods: []
+events: []
+callbacks: []