Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AdGui

Member index 10

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

Removed member index 2

HistoryMember

Description

History 26

Members 10

AdShape

TypeDefault
AdShape

History 3

EnableVideoAds

TypeDefault
bool

The property enables the AdGui to serve video ads.

History 2

FallbackImage

TypeDefault
ContentId

History 2

FallbackImageContent

TypeDefault
Content

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
AdUnitStatus
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 3

Tags: [ReadOnly, NotReplicated]

adGuiStateChanged

Parameters (1)
adUIStateVariant

History 1

forwardStateToLuaUI

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

History 1

Removed members 2

Settings