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
| Name | Value | Description |
|---|---|---|
| AdLabelClicked | 0 | The player clicked the "Sponsored" label on the ad overlay, which opens the ad disclosure prompt showing advertiser and payer information. |
| VolumeButtonClicked | 1 | The player clicked the volume toggle button on the ad overlay, which mutes or unmutes the video ad audio. |
| FullscreenButtonClicked | 2 | The player clicked the fullscreen toggle button, which smoothly zooms the camera to a centered view of the ad surface and enables audio. |
| PlayButtonClicked | 3 | 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. |
| PauseButtonClicked | 4 | The player clicked the pause button while a video ad is playing in fullscreen mode, which pauses video playback. |
| CloseButtonClicked | 5 | The player clicked the close button on the fullscreen video ad view, which exits fullscreen mode and returns to the normal camera position. |
| WhyThisAdClicked | 6 | 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. |
| PlayEventTriggered | 7 | A system-initiated play/resume event that clears the force-pause state and resumes video playback if the stream is open. |
| PauseEventTriggered | 8 | 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. |
AdLabelClicked
The player clicked the "Sponsored" label on the ad overlay, which opens the ad disclosure prompt showing advertiser and payer information.
| Field | Value |
|---|---|
| value | 0 |
VolumeButtonClicked
The player clicked the volume toggle button on the ad overlay, which mutes or unmutes the video ad audio.
| Field | Value |
|---|---|
| value | 1 |
FullscreenButtonClicked
The player clicked the fullscreen toggle button, which smoothly zooms the camera to a centered view of the ad surface and enables audio.
| Field | Value |
|---|---|
| value | 2 |
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.
| Field | Value |
|---|---|
| value | 3 |
PauseButtonClicked
The player clicked the pause button while a video ad is playing in fullscreen mode, which pauses video playback.
| Field | Value |
|---|---|
| value | 4 |
CloseButtonClicked
The player clicked the close button on the fullscreen video ad view, which exits fullscreen mode and returns to the normal camera position.
| Field | Value |
|---|---|
| value | 5 |
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.
| Field | Value |
|---|---|
| value | 6 |
PlayEventTriggered
A system-initiated play/resume event that clears the force-pause state and resumes video playback if the stream is open.
| Field | Value |
|---|---|
| value | 7 |
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.
| Field | Value |
|---|---|
| value | 8 |