Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FPlayTimeLimitImpl

Implementation of [IOnlinePlayTimeLimit](API\Plugins\OnlineSubsystem\Interfaces\IOnlinePlayTimeLimit)

Windows

MacOS

Linux

Inheritance Hierarchy

IModularFeature

IOnlinePlayTimeLimit

FPlayTimeLimitImpl

References

Module	PlayTimeLimit
Header	/Engine/Plugins/Online/OnlineFramework/Source/PlayTimeLimit/Public/PlayTimeLimitImpl.h
Include	#include "PlayTimeLimitImpl.h"

Syntax

class FPlayTimeLimitImpl : public IOnlinePlayTimeLimit

Remarks

Variables

	Name	Description
TArray< FOnline...	ConfigRates	Configuration to control notification rate at different levels of play time
double	LastTickLogicTime	Last time we performed tick logic
OnRequestCreate...	OnRequestCreateUser
FDelegateHandle	TickHandle	Delegate for callbacks to Tick
TArray< FPlayTi...	Users	List of users we are monitoring
FWarnUserPlayTi...	WarnUserPlayTimeDelegate	Delegate used to display a warning to the user about their play time

Constructors

	Name	Description
	FPlayTimeLimitImpl()	Default constructor

Destructors

	Name	Description
	~FPlayTimeLimitImpl()	Destructor

Functions

	Name	Description
void	DumpState()	Dump state to log
FPlayTimeLim...	Get()	Get the singleton
const FOnlin...	GetConfigEntry ( const int32 PlayTimeMinutes )	Get the config entry that corresponds to the number of minutes played
void	Initialize()	Initialize
void	MockUser ( const FUniqueNetId& UserId, const bool bHasTimeLimit, const double CurrentPlayTimeMinutes )	Override a user's play time For testing the system without needing to potentially wait hours - waiting to accumulate time and waiting for the time to reset
void	NotifyNow()	Cheat function to trigger the notification to players of their play time immediately
void	RegisterUser ( const FUniqueNetId& NewUser )	Register a user to monitor their play time
void	Shutdown()	Shutdown
bool	Tick ( float Delta )	Tick - update users and execute warn time delegates
void	UnregisterUser ( const FUniqueNetId& UserId )	Unregister a user
void	UpdateNextNotificationTime ( FPlayTimeLimitUser& User, const int32 PlayTimeMinutes )	Update the next notification time for a user based on their current play time

Overridden from IOnlinePlayTimeLimit

	Name	Description
int32	GetPlayTimeMinutes ( const FUniqueNetId& UserId )	Get the play time in minutes for the user
float	GetRewardRate ( const FUniqueNetId& UserId )	Get the reward amount multiplier for the user Expected to start at 1.0 (full rewards), and is reduced based on their play time
FWarnUserPla...	GetWarnUserPlayTimeDelegate()	Delegate called when a warning should be displayed to the user. See FWarnUserPlayTimeDelegate
bool	HasTimeLimit ( const FUniqueNetId& UserId )	Begin IOnlinePlayTimeLimit.

Typedefs

Name	Description
OnRequestCreateUserDelegate

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

Take our survey

Dismiss