3 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

AdUIEventType

Describes the type of user-interaction or system event that occurred on the immersive ad UI overlay of an AdGui.

Items

NameValueDescription
AdLabelClicked0The player clicked the "Sponsored" label on the ad overlay, which opens the ad disclosure prompt showing advertiser and payer information.
VolumeButtonClicked1The player clicked the volume toggle button on the ad overlay, which mutes or unmutes the video ad audio.
FullscreenButtonClicked2The player clicked the fullscreen toggle button, which smoothly zooms the camera to a centered view of the ad surface and enables audio.
PlayButtonClicked3The player clicked the play button on the ad overlay. If the ad is already in fullscreen, playback resumes; otherwise it enters fullscreen mode which also starts (or resumes) the video.
PauseButtonClicked4The player clicked the pause button while a video ad is playing in fullscreen mode, which pauses video playback.
CloseButtonClicked5The player clicked the close button on the fullscreen video ad view, which exits fullscreen mode and returns to the normal camera position.
WhyThisAdClicked6The player clicked the "Why this ad?" link, which displays the EUDSA (European Digital Services Act) disclosure prompt showing the advertiser and payer names for the current ad creative.
PlayEventTriggered7A system-initiated play/resume event that clears the force-pause state and resumes video playback if the stream is open.
PauseEventTriggered8A system-initiated pause event, used when the engine needs to force-pause the video (for example, when a dropdown menu opens over the ad). Prevents viewability-based auto-play from resuming playback until a corresponding system event clears that pause.

AdLabelClicked

The player clicked the "Sponsored" label on the ad overlay, which opens the ad disclosure prompt showing advertiser and payer information.

FieldValue
value0

VolumeButtonClicked

The player clicked the volume toggle button on the ad overlay, which mutes or unmutes the video ad audio.

FieldValue
value1

FullscreenButtonClicked

The player clicked the fullscreen toggle button, which smoothly zooms the camera to a centered view of the ad surface and enables audio.

FieldValue
value2

PlayButtonClicked

The player clicked the play button on the ad overlay. If the ad is already in fullscreen, playback resumes; otherwise it enters fullscreen mode which also starts (or resumes) the video.

FieldValue
value3

PauseButtonClicked

The player clicked the pause button while a video ad is playing in fullscreen mode, which pauses video playback.

FieldValue
value4

CloseButtonClicked

The player clicked the close button on the fullscreen video ad view, which exits fullscreen mode and returns to the normal camera position.

FieldValue
value5

WhyThisAdClicked

The player clicked the "Why this ad?" link, which displays the EUDSA (European Digital Services Act) disclosure prompt showing the advertiser and payer names for the current ad creative.

FieldValue
value6

PlayEventTriggered

A system-initiated play/resume event that clears the force-pause state and resumes video playback if the stream is open.

FieldValue
value7

PauseEventTriggered

A system-initiated pause event, used when the engine needs to force-pause the video (for example, when a dropdown menu opens over the ad). Prevents viewability-based auto-play from resuming playback until a corresponding system event clears that pause.

FieldValue
value8