Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AdGui

Member index 11

HistoryMember
553AdShape: AdShape
599EnableVideoAds: bool
645FallbackImage: ContentId
569Status: AdUnitStatus
639GetSingleReportAdInfo(): Map
627HandleLuaUIEvent(eventType: AdUIEventType): null
636forwardStateToLuaUI(): null
627adGuiStateChanged(adUIState: Variant)
599OnAdEvent(eventInfo: Dictionary): bool
inherited from SurfaceGuiBase
553Active: bool
553Adornee: Instance
553Face: NormalId
inherited from LayerCollector
553Enabled: bool
553ResetOnSpawn: bool
553ZIndexBehavior: ZIndexBehavior
622GetGuiObjectsAtPosition(x: int, y: int): Objects
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
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
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
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Description

History 19

Members 11

AdShape

TypeDefault
AdShapeHorizontalRectangle

History 2

EnableVideoAds

TypeDefault
booltrue

The property enables the AdGui to serve video ads.

History 1

FallbackImage

TypeDefault
ContentId

History 2

GetSingleReportAdInfo

Parameters (0)
No parameters.
Returns (1)
Map

History 1

HandleLuaUIEvent

Parameters (1)
eventTypeAdUIEventType
Returns (1)
null

History 1

OnAdEvent

Parameters (1)
eventInfoDictionary
Returns (1)
bool

The callback function used to react to the AdGui events.

History 1

Status

TypeDefault
AdUnitStatusInactive
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.

History 2

Tags: [ReadOnly, NotReplicated]

adGuiStateChanged

Parameters (1)
adUIStateVariant

History 1

forwardStateToLuaUI

Parameters (0)
No parameters.
Returns (1)
null

History 1

Settings