UInGameAdManager

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/InGameAdManager.h

Include

#include "Engine/InGameAdManager.h"

Syntax

class UInGameAdManager : public UPlatformInterfaceBase

Variables

Name Description

Public variable

uint32: 1

 

bShouldPauseWhileAdOpen

If true, the game will pause when the user clicks on the ad, which could take over the screen

Public variable

TArray< FOnUser...

 

ClickedBannerDelegates

Public variable

TArray< FOnUser...

 

ClosedAdDelegates

Constructors

Name Description

Public function

UInGameAdManager

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual

void

 

AddClickedBannerDelegate

(
    FOnUserClickedBanner InDelegate
)

Adds a delegate to the list of listeners

Public function Virtual

void

 

AddClosedAdDelegate

(
    FOnUserClosedAdvertisement InDelega...
)

Adds a delegate to the list of listeners

Public function Virtual

void

 

ClearClickedBannerDelegate

(
    FOnUserClickedBanner InDelegate
)

Removes a delegate from the list of listeners

Public function Virtual

void

 

ClearClosedAdDelegate

(
    FOnUserClosedAdvertisement InDelega...
)

Removes a delegate from the list of listeners

Public function Virtual

void

 

ForceCloseAd()

If the game absolutely must close an opened (clicked on) advertisement, call this function.

Public function Virtual

void

 

HideBanner()

Hides the advertisement banner shown with ShowInGameAdvertisementBanner.

Public function Virtual

void

 

Init()

Perform any needed initialization

Public function

void

 

OnUserClickedBanner()

Called by platform when the user clicks on the ad banner.

Public function

void

 

OnUserClosedAd()

Called by platform when an opened ad is closed. Will unpause the game before calling the delegates

Public function Virtual

void

 

SetPauseWhileAdOpen

(
    bool bShouldPause
)

Sets the value of bShouldPauseWhileAdOpen

Public function Virtual

void

 

ShowBanner

(
    bool bShowBottomOfScreen
)

Allows the platform to put up an advertisement on top of the viewport.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss