Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AdGui

A surface-based GUI that displays immersive ads on a face of a Part in the 3D world.

Memory categoryInternal

Member index 12

HistoryMember
731AdShape: AdShape
731EnableVideoAds: bool
645FallbackImage: ContentId
731FallbackImageContent: Content
731Status: AdUnitStatus
639GetSingleReportAdInfo(): Map
627HandleLuaUIEvent(eventType: AdUIEventType): null
636forwardStateToLuaUI(): null
627adGuiStateChanged(adUIState: Variant)
734OnAdEvent(eventInfo: Dictionary): bool
inherited from SurfaceGuiBase
731Active: bool
731Adornee: Instance
731Face: NormalId
inherited from LayerCollector
731Enabled: bool
731ResetOnSpawn: bool
731ZIndexBehavior: ZIndexBehavior
648GetGuiObjectsAtPosition(x: int, y: int): Instances
462GetLayoutNodeTree(): Dictionary
inherited from GuiBase2d
731AbsolutePosition: Vector2
731AbsoluteRotation: float
731AbsoluteSize: Vector2
731AutoLocalize: bool
731RootLocalizationTable: LocalizationTable
731SelectionBehaviorDown: SelectionBehavior
731SelectionBehaviorLeft: SelectionBehavior
731SelectionBehaviorRight: SelectionBehavior
731SelectionBehaviorUp: SelectionBehavior
731SelectionGroup: bool
525SelectionChanged(amISelected: bool, previousSelection: GuiObject, newSelection: GuiObject)
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

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.

History 33

Members 12

AdShape

TypeDefault
AdShapeHorizontalRectangle

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.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

EnableVideoAds

TypeDefault
booltrue

The property enables the AdGui to serve video ads.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 3

FallbackImage

TypeDefault
ContentId

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.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 2

FallbackImageContent

TypeDefault
Content

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.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 3

GetSingleReportAdInfo

Parameters (0)
No parameters.
Returns (1)
Map
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

HandleLuaUIEvent

Parameters (1)
eventTypeAdUIEventType
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

OnAdEvent

Parameters (1)
eventInfoDictionary
Returns (1)
bool
This callback is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 2

Tags: [Deprecated]

Status

TypeDefault
AdUnitStatusInactive

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.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryBehavior
Loaded/Savedfalse

History 4

Tags: [ReadOnly, NotReplicated]

adGuiStateChanged

Parameters (1)
adUIStateVariant
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

forwardStateToLuaUI

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

Settings