1. Epic GamesDeveloper
  3. FPlayTimeLimitImpl

FPlayTimeLimitImpl

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

API > API/Plugins > API/Plugins/PlayTimeLimit

Inheritance Hierarchy

References

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

Syntax

class FPlayTimeLimitImpl : public IOnlinePlayTimeLimit

Remarks

Implementation of IOnlinePlayTimeLimit

Variables

  Type Name Description
Protected variable TArray< FOnlinePlayLimitConfigEntry > ConfigRates Configuration to control notification rate at different levels of play time
Protected variable double LastTickLogicTime Last time we performed tick logic
Public variable FOnGameExitRequested OnGameExitRequestedDelegate Delegate used to request a game exit
Public variable OnRequestCreateUserDelegate OnRequestCreateUser  
Protected variable FTSTicker::FDelegateHandle TickHandle Delegate for callbacks to Tick
Protected variable TArray< FPlayTimeLimitUserPtr > Users List of users we are monitoring
Protected variable FWarnUserPlayTime WarnUserPlayTimeDelegate Delegate used to display a warning to the user about their play time

Constructors

  Type Name Description
Public function   Default constructor

Destructors

  Type Name Description
Public function Virtual   Destructor

Functions

  Type Name Description
Public function void Dump state to log
Public function void  
Public function Static FPlayTimeLimitImpl &

Get ()

 Get the singleton
Public function Const const FOnlinePlayLimitConfigEntry *

GetConfigEntry ( const int32 PlayTimeMinutes
)

 Get the config entry that corresponds to the number of minutes played
Public function void Initialize
Public function 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
Public function void Cheat function to trigger the notification to players of their play time immediately
Public function void

RegisterUser ( const FUniqueNetId& NewUser
)

 Register a user to monitor their play time
Public function void Shutdown
Public function bool

Tick ( float Delta
)

 Tick - update users and execute warn time delegates
Public function void

UnregisterUser ( const FUniqueNetId& UserId
)

 Unregister a user
Protected function Const void

UpdateNextNotificationTime ( FPlayTimeLimitUser& User,
const int32 PlayTimeMinutes
)

 Update the next notification time for a user based on their current play time

Overridden from IOnlinePlayTimeLimit

  Type Name Description
Public function Virtual int32

GetPlayTimeMinutes ( const FUniqueNetId& UserId
)

 Get the play time in minutes for the user
Public function Virtual 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
Public function Virtual FWarnUserPlayTime & Delegate called when a warning should be displayed to the user. See FWarnUserPlayTimeDelegate
Public function Virtual bool

HasTimeLimit ( const FUniqueNetId& UserId
)

 Begin IOnlinePlayTimeLimit.

Typedefs

Name Description
FOnGameExitRequested Delegate called when a game exit is requested
FOnGameExitRequestedDelegate  
OnRequestCreateUserDelegate  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page