rules

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

@@ -0,0 +1,118 @@
+# 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: AdGui
+type: class
+memory_category: Internal
+summary: ''
+description: ''
+code_samples: []
+inherits:
+  - SurfaceGuiBase
+descendants: []
+tags: []
+deprecation_message: ''
+properties:
+  - name: AdGui.AdShape
+    summary: ''
+    description: ''
+    code_samples: []
+    type: AdShape
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Data
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - UI
+  - name: AdGui.EnableVideoAds
+    summary: |
+      Enables the AdGui to serve video ads.
+    description: |
+      The property enables the AdGui to serve video ads.
+    code_samples: []
+    type: boolean
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Data
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - UI
+  - name: AdGui.FallbackImage
+    summary: ''
+    description: ''
+    code_samples: []
+    type: ContentId
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Appearance
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - UI
+  - name: AdGui.Status
+    summary: ''
+    description: ''
+    code_samples: []
+    type: AdUnitStatus
+    tags:
+      - ReadOnly
+      - NotReplicated
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Behavior
+    serialization:
+      can_load: false
+      can_save: false
+    capabilities:
+      - UI
+methods: []
+events: []
+callbacks:
+  - name: AdGui.OnAdEvent
+    summary: |
+      Used to react to the AdGui events.
+    description: |
+      The callback function used to react to the AdGui events.
+    code_samples: []
+    parameters:
+      - name: eventInfo
+        type: Dictionary
+        default:
+        summary: |
+          Options table for the method:
+
+          - `PlayerId` – The user ID of the player related to the ad event.
+          - `AdEventType` – A `Enum.AdEventType` enum value describing the AdGui
+            events.
+    returns:
+      - type: boolean
+        summary: |
+          Whether the callback has successfully reacted to the event.
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - UI
+    writeCapabilities: []