AdGui¶
A surface-based GUI that displays immersive ads on a face of a Part in the 3D world.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
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.
Inheritance¶
Object → Instance → GuiBase → GuiBase2d → LayerCollector → SurfaceGuiBase → AdGui
Properties¶
| Member | Signature | Summary |
|---|---|---|
AdShape |
AdShape: AdShape |
Determines the shape of the ad displayed by the AdGui. |
EnableVideoAds |
EnableVideoAds: bool |
Enables the AdGui to serve video ads. |
FallbackImage |
FallbackImage: ContentId |
The image the AdGui displays when no ad is available to serve. |
FallbackImageContent |
FallbackImageContent: Content |
The Content equivalent of AdGui.FallbackImage that supports asset URIs and EditableImage objects. |
Status |
Status: AdUnitStatus |
Indicates whether the AdGui is currently displaying a served ad. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
forwardStateToLuaUI |
AdGui:forwardStateToLuaUI(): null |
— |
GetSingleReportAdInfo |
AdGui:GetSingleReportAdInfo(): Map |
— |
HandleLuaUIEvent |
AdGui:HandleLuaUIEvent(eventType: AdUIEventType): null |
— |
Events¶
| Member | Signature | Summary |
|---|---|---|
AdEvent |
AdEvent(adEventType: AdEventType) |
— |
adGuiStateChanged |
adGuiStateChanged(adUIState: Variant) |
— |
ReportIsSubscribedToVideoCompletion |
ReportIsSubscribedToVideoCompletion() |
— |
Callbacks¶
| Member | Signature | Summary |
|---|---|---|
OnAdEvent |
OnAdEvent(eventInfo: Dictionary) -> bool |
Used to react to the AdGui events. |
Roblox reference: AdGui
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.