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
553AdShape: AdShape
599EnableVideoAds: bool
645FallbackImage: ContentId
725FallbackImageContent: Content
569Status: AdUnitStatus
639GetSingleReportAdInfo(): Map
627HandleLuaUIEvent(eventType: AdUIEventType): null
636forwardStateToLuaUI(): null
627adGuiStateChanged(adUIState: Variant)
734OnAdEvent(eventInfo: Dictionary): bool
inherited from SurfaceGuiBase
553Active: bool
553Adornee: Instance
553Face: NormalId
inherited from LayerCollector
553Enabled: bool
553ResetOnSpawn: bool
553ZIndexBehavior: ZIndexBehavior
648GetGuiObjectsAtPosition(x: int, y: int): Instances
462GetLayoutNodeTree(): Dictionary
inherited from GuiBase2d
553AbsolutePosition: Vector2
553AbsoluteRotation: float
553AbsoluteSize: Vector2
553AutoLocalize: bool
553RootLocalizationTable: LocalizationTable
553SelectionBehaviorDown: SelectionBehavior
553SelectionBehaviorLeft: SelectionBehavior
553SelectionBehaviorRight: SelectionBehavior
553SelectionBehaviorUp: SelectionBehavior
553SelectionGroup: bool
525SelectionChanged(amISelected: bool, previousSelection: GuiObject, newSelection: GuiObject)
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: 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
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(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 21

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 2

EnableVideoAds

TypeDefault
booltrue

The property enables the AdGui to serve video ads.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

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 1

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 2

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