Navigation
API > API/Plugins > API/Plugins/PlayTimeLimit
Information about a user we are observing the play time and instituting limits for
| Name | FPlayTimeLimitUser |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineFramework/Source/PlayTimeLimit/Public/PlayTimeLimitUser.h |
| Include Path | #include "PlayTimeLimitUser.h" |
Syntax
class FPlayTimeLimitUser : public TSharedFromThis< FPlayTimeLimitUser, ESPMode::ThreadSafe >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FPlayTimeLimitUser
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPlayTimeLimitUser
(
const FUniqueNetIdRef& InUserId |
Constructor | PlayTimeLimitUser.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FPlayTimeLimitUser() |
Destructor | PlayTimeLimitUser.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OverrideButtonText | FString | PlayTimeLimitUser.h | ||
| OverrideDialogText | FString | PlayTimeLimitUser.h | ||
| OverrideDialogTitle | FString | PlayTimeLimitUser.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ClearDialogOverrideText() |
Clear override dialog text | PlayTimeLimitUser.h | |
float GetLastKnownRewardRate() |
Get the last known reward rate | PlayTimeLimitUser.h | |
TOptional< double > GetNextNotificationTime() |
Get the next time we are scheduled to send the user a notification This is for the periodic notification; if the reward rate changes we will immediately display a notification | PlayTimeLimitUser.h | |
int32 GetPlayTimeMinutes() |
Get the number of minutes this user has played | PlayTimeLimitUser.h | |
float GetRewardRate() |
Get the current reward rate | PlayTimeLimitUser.h | |
FUniqueNetIdRef GetUserId() |
Get the user's unique id | PlayTimeLimitUser.h | |
bool HasTimeLimit() |
Check if the user has a play time limit | PlayTimeLimitUser.h | |
virtual void Init() |
PlayTimeLimitUser.h | ||
void SetLastKnownRewardRate
(
float InLastKnownRewardRate |
Set the last known reward rate | PlayTimeLimitUser.h | |
virtual void SetNextNotificationTime
(
const TOptional< double >& InNextNotificationTime |
Set the next time to send the user a notification | PlayTimeLimitUser.h | |
virtual void Tick() |
Tick | PlayTimeLimitUser.h |