Navigation
API > API/Plugins > API/Plugins/PlayTimeLimit
Implementation of IOnlinePlayTimeLimit
| Name | FPlayTimeLimitImpl |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineFramework/Source/PlayTimeLimit/Public/PlayTimeLimitImpl.h |
| Include Path | #include "PlayTimeLimitImpl.h" |
Syntax
class FPlayTimeLimitImpl : public IOnlinePlayTimeLimit
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default constructor | PlayTimeLimitImpl.h | ||
FPlayTimeLimitImpl
(
const FPlayTimeLimitImpl& Other |
Not copyable. | PlayTimeLimitImpl.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FPlayTimeLimitImpl() |
Destructor | PlayTimeLimitImpl.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnGameExitRequested | TMulticastDelegate_NoParams< void > | Delegate called when a game exit is requested | PlayTimeLimitImpl.h |
| FOnGameExitRequestedDelegate | FOnGameExitRequested::FDelegate | PlayTimeLimitImpl.h | |
| OnRequestCreateUserDelegate | TBaseDelegate_OneParam< FPlayTimeLimitUserRawPtr, const FUniqueNetId & > | PlayTimeLimitImpl.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnGameExitRequestedDelegate | FOnGameExitRequested | Delegate used to request a game exit | PlayTimeLimitImpl.h | |
| OnRequestCreateUser | OnRequestCreateUserDelegate | PlayTimeLimitImpl.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DumpState() |
Dump state to log | PlayTimeLimitImpl.h | |
void GameExitByRequest() |
PlayTimeLimitImpl.h | ||
const FOnlinePlayLimitConfigEntry * GetConfigEntry
(
const int32 PlayTimeMinutes |
Get the config entry that corresponds to the number of minutes played | PlayTimeLimitImpl.h | |
virtual int32 GetPlayTimeMinutes
(
const FUniqueNetId& UserId |
PlayTimeLimitImpl.h | ||
virtual float GetRewardRate
(
const FUniqueNetId& UserId |
PlayTimeLimitImpl.h | ||
virtual FWarnUserPlayTime & GetWarnUserPlayTimeDelegate() |
PlayTimeLimitImpl.h | ||
virtual bool HasTimeLimit
(
const FUniqueNetId& UserId |
Begin IOnlinePlayTimeLimit. | PlayTimeLimitImpl.h | |
void Initialize() |
Initialize | PlayTimeLimitImpl.h | |
void MockUser
(
const FUniqueNetId& UserId, |
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 | PlayTimeLimitImpl.h | |
void NotifyNow() |
Cheat function to trigger the notification to players of their play time immediately | PlayTimeLimitImpl.h | |
void RegisterUser
(
const FUniqueNetId& NewUser |
Register a user to monitor their play time | PlayTimeLimitImpl.h | |
void Shutdown() |
Shutdown | PlayTimeLimitImpl.h | |
bool Tick
(
float Delta |
Tick - update users and execute warn time delegates | PlayTimeLimitImpl.h | |
void UnregisterUser
(
const FUniqueNetId& UserId |
Unregister a user | PlayTimeLimitImpl.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void UpdateNextNotificationTime
(
FPlayTimeLimitUser& User, |
Update the next notification time for a user based on their current play time | PlayTimeLimitImpl.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FPlayTimeLimitImpl & Get() |
Get the singleton | PlayTimeLimitImpl.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPlayTimeLimitImpl & operator=
(
FPlayTimeLimitImpl& Other |
PlayTimeLimitImpl.h |