AdUIEventType¶
Not yet Enum
Describes the type of user-interaction or system event that occurred on the immersive ad UI overlay of an AdGui.
Not implemented in Nova
This enum is missing from Nova. Scripts that reference it will fail.
Items¶
| Item | Value | Status | Notes |
|---|---|---|---|
AdLabelClicked |
0 | Not yet | The player clicked the "Sponsored" label on the ad overlay, which opens the ad disclosure prompt showing advertiser and payer information. |
VolumeButtonClicked |
1 | Not yet | The player clicked the volume toggle button on the ad overlay, which mutes or unmutes the video ad audio. |
FullscreenButtonClicked |
2 | Not yet | 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 | Not yet | 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 | Not yet | The player clicked the pause button while a video ad is playing in fullscreen mode, which pauses video playback. |
CloseButtonClicked |
5 | Not yet | 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 | Not yet | 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 | Not yet | A system-initiated play/resume event that clears the force-pause state and resumes video playback if the stream is open. |
PauseEventTriggered |
8 | Not yet | 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… |
Roblox reference: AdUIEventType