Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
AdGui
Inherits from: SurfaceGuiBase → LayerCollector → GuiBase2d → GuiBase → Instance → Object
AdGui is a SurfaceGuiBase that renders immersive display ads onto a face of the Part it's adorned to. When no ad is available, it shows the creator-supplied AdGui.FallbackImage, or a default Roblox fallback image when that property is empty.
To render ads, the AdGui must be adorned to a block Part that's a descendant of Workspace, must be the only surface GUI on that face, and must be at least the minimum eligible size. When these conditions aren't met, the object displays a placeholder image in Studio's edit view and renders nothing in a running experience.
Inherits from: SurfaceGuiBase
Memory category: Internal
Properties
| Name | Type / Returns | Description |
|---|---|---|
| AdGui.AdShape | AdShape | Determines the shape of the ad displayed by the AdGui. |
| AdGui.EnableVideoAds | boolean | Enables the AdGui to serve video ads. |
| AdGui.FallbackImage | ContentId | The image the AdGui displays when no ad is available to serve. |
| AdGui.FallbackImageContent | Content | The Content equivalent of AdGui.FallbackImage that supports asset URIs and EditableImage objects. |
| AdGui.Status | AdUnitStatus | Indicates whether the AdGui is currently displaying a served ad. |
Inherited from SurfaceGuiBase
| Name | Type / Returns | Description |
|---|---|---|
| SurfaceGuiBase.Active | boolean | Determines whether the SurfaceGui sinks user input; true by default. |
| SurfaceGuiBase.Adornee | Instance | BasePart on which to apply the SurfaceGui, overriding the default parent association. |
| SurfaceGuiBase.Face | NormalId | NormalId face upon which to apply the SurfaceGui. |
Inherited from LayerCollector
| Name | Type / Returns | Description |
|---|---|---|
| LayerCollector.Enabled | boolean | Toggles the visibility of this LayerCollector. |
| LayerCollector.ResetOnSpawn | boolean | Determines if the LayerCollector resets (deletes itself and re-clones into the player's PlayerGui) every time the player's character respawns. |
| LayerCollector.ZIndexBehavior | ZIndexBehavior | Controls how GuiObject.ZIndex behaves on all descendants of this LayerCollector. |
Inherited from GuiBase2d
| Name | Type / Returns | Description |
|---|---|---|
| GuiBase2d.AbsolutePosition | Vector2 | Describes the actual screen position of a GuiBase2d element, in pixels. |
| GuiBase2d.AbsoluteRotation | float | Describes the actual screen rotation of a GuiBase2d element, in degrees. |
| GuiBase2d.AbsoluteSize | Vector2 | Describes the actual screen size of a GuiBase2d element, in pixels. |
| GuiBase2d.AutoLocalize | boolean | When set to true, localization will be applied to this GuiBase2d and its descendants. |
| GuiBase2d.Localize | boolean | Automatically set to true when a localization table's LocalizationTable.Root targets this object, or an ancestor of this object. |
| GuiBase2d.RootLocalizationTable | LocalizationTable | A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants. |
| GuiBase2d.SelectionBehaviorDown | SelectionBehavior | Customizes gamepad selection behavior in the down direction. |
| GuiBase2d.SelectionBehaviorLeft | SelectionBehavior | Customizes gamepad selection behavior in the left direction. |
| GuiBase2d.SelectionBehaviorRight | SelectionBehavior | Customizes gamepad selection behavior in the right direction. |
| GuiBase2d.SelectionBehaviorUp | SelectionBehavior | Customizes gamepad selection behavior in the up direction. |
| GuiBase2d.SelectionGroup | boolean | Allows customization of gamepad selection movement. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
AdGui.AdShape
Determines the shape of the ad rendered by the AdGui, including the creative's aspect ratio on the part surface. Defaults to HorizontalRectangle, which is the only served shape aside from the sentinel Undefined.
| Field | Value |
|---|---|
| type | AdShape |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["UI"] |
AdGui.EnableVideoAds
The property enables the AdGui to serve video ads.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["UI","Monetization"] |
AdGui.FallbackImage
A creator-supplied image that the AdGui displays when it has no served ad to render. Defaults to an empty content string; while empty, the AdGui renders a default Roblox fallback image instead.
| Field | Value |
|---|---|
| type | ContentId |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["UI"] |
AdGui.FallbackImageContent
A Content-typed property that holds the fallback image the AdGui displays when no served ad is available. It is the content-typed backing for AdGui.FallbackImage (a legacy TextureId string); writing to either property updates the same underlying storage. Unlike FallbackImage, this property accepts asset URIs and references to EditableImage objects. When empty, the AdGui renders a default Roblox fallback image instead.
| Field | Value |
|---|---|
| type | Content |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["UI"] |
AdGui.Status
A read-only property that reports whether the AdGui is actively displaying a served ad. It's Active when the AdGui is rendering ad content, and Inactive otherwise.
| Field | Value |
|---|---|
| type | AdUnitStatus |
| tags | ["ReadOnly","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Behavior |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["UI","Monetization"] |
Callbacks
| Name | Type / Returns | Description |
|---|---|---|
| AdGui.OnAdEvent | boolean | Used to react to the AdGui events. |
AdGui.OnAdEvent
Deprecated. This callback has been deprecated and will never be called.
Used to react to the AdGui events.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| eventInfo | Dictionary | 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 | Description |
|---|---|
| boolean | Whether the callback has successfully reacted to the event. |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI","Monetization"] |
Methods
Inherited from LayerCollector
| Name | Type / Returns | Description |
|---|---|---|
| LayerCollector:GetLayoutNodeTree | Dictionary |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
Events
Inherited from GuiBase2d
| Name | Type / Returns | Description |
|---|---|---|
| GuiBase2d.SelectionChanged | Fires when the gamepad selection moves to, leaves, or changes within the connected GuiBase2d or any descendant GuiObjects. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |