Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AdUIEventType

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

Items 9

HistoryNameValueDescription
627AdLabelClicked0

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

627VolumeButtonClicked1

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

627FullscreenButtonClicked2

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

627PlayButtonClicked3

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.

627PauseButtonClicked4

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

627CloseButtonClicked5

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

637WhyThisAdClicked6

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.

648PlayEventTriggered7

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

648PauseEventTriggered8

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.

Description

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

History 10

Settings