Skip to main content

RHAPI_PlayerDeserterStatus

Summary​

MembersDescriptions
struct FRHAPI_PlayerDeserterStatus

struct FRHAPI_PlayerDeserterStatus ​

struct FRHAPI_PlayerDeserterStatus
  : public FRHAPI_Model

Summary​

MembersDescriptions
public FString DeserterIdID for which type of deserter this is.
public bool DeserterStatusFlag of whether or not the player is a deserter.
public FDateTime DeserterExpiration_OptionalDatetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool DeserterExpiration_IsSettrue if DeserterExpiration_Optional has been set to a value
public FDateTime DeserterReset_OptionalDatetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool DeserterReset_IsSettrue if DeserterReset_Optional has been set to a value
public int32 DeserterCount_OptionalThe number of times a player has deserted before the expiration.
public bool DeserterCount_IsSettrue if DeserterCount_Optional has been set to a value
public FDateTime LastUpdated_OptionalDatetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool LastUpdated_IsSettrue if LastUpdated_Optional has been set to a value
public TMap< FString, FString > CustomData_OptionalCustom data about a players desertion status.
public bool CustomData_IsSettrue if CustomData_Optional has been set to a value
public virtual bool FromJson(const TSharedPtr< FJsonValue > & JsonValue)Fills this object with data from the passed in JSON.
public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) constWrites the data from this object into the specified JSON Writer stream.
public inline FString & GetDeserterId()Gets the value of DeserterId.
public inline const FString & GetDeserterId() constGets the value of DeserterId.
public inline void SetDeserterId(const FString & NewValue)Sets the value of DeserterId.
public inline void SetDeserterId(FString && NewValue)Sets the value of DeserterId using move semantics.
public inline bool & GetDeserterStatus()Gets the value of DeserterStatus.
public inline const bool & GetDeserterStatus() constGets the value of DeserterStatus.
public inline void SetDeserterStatus(const bool & NewValue)Sets the value of DeserterStatus.
public inline void SetDeserterStatus(bool && NewValue)Sets the value of DeserterStatus using move semantics.
public inline bool IsDeserterStatusDefaultValue() constReturns true if DeserterStatus matches the default value.
public inline void SetDeserterStatusToDefault()Sets the value of DeserterStatus to its default
public inline FDateTime & GetDeserterExpiration()Gets the value of DeserterExpiration_Optional, regardless of it having been set.
public inline const FDateTime & GetDeserterExpiration() constGets the value of DeserterExpiration_Optional, regardless of it having been set.
public inline const FDateTime & GetDeserterExpiration(const FDateTime & DefaultValue) constGets the value of DeserterExpiration_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDeserterExpiration(FDateTime & OutValue) constFills OutValue with the value of DeserterExpiration_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetDeserterExpirationOrNull()Returns a pointer to DeserterExpiration_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetDeserterExpirationOrNull() constReturns a pointer to DeserterExpiration_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDeserterExpiration(const FDateTime & NewValue)Sets the value of DeserterExpiration_Optional and also sets DeserterExpiration_IsSet to true.
public inline void SetDeserterExpiration(FDateTime && NewValue)Sets the value of DeserterExpiration_Optional and also sets DeserterExpiration_IsSet to true using move semantics.
public inline void ClearDeserterExpiration()Clears the value of DeserterExpiration_Optional and sets DeserterExpiration_IsSet to false.
public inline bool IsDeserterExpirationSet() constChecks whether DeserterExpiration_Optional has been set.
public inline FDateTime & GetDeserterReset()Gets the value of DeserterReset_Optional, regardless of it having been set.
public inline const FDateTime & GetDeserterReset() constGets the value of DeserterReset_Optional, regardless of it having been set.
public inline const FDateTime & GetDeserterReset(const FDateTime & DefaultValue) constGets the value of DeserterReset_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDeserterReset(FDateTime & OutValue) constFills OutValue with the value of DeserterReset_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetDeserterResetOrNull()Returns a pointer to DeserterReset_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetDeserterResetOrNull() constReturns a pointer to DeserterReset_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDeserterReset(const FDateTime & NewValue)Sets the value of DeserterReset_Optional and also sets DeserterReset_IsSet to true.
public inline void SetDeserterReset(FDateTime && NewValue)Sets the value of DeserterReset_Optional and also sets DeserterReset_IsSet to true using move semantics.
public inline void ClearDeserterReset()Clears the value of DeserterReset_Optional and sets DeserterReset_IsSet to false.
public inline bool IsDeserterResetSet() constChecks whether DeserterReset_Optional has been set.
public inline int32 & GetDeserterCount()Gets the value of DeserterCount_Optional, regardless of it having been set.
public inline const int32 & GetDeserterCount() constGets the value of DeserterCount_Optional, regardless of it having been set.
public inline const int32 & GetDeserterCount(const int32 & DefaultValue) constGets the value of DeserterCount_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDeserterCount(int32 & OutValue) constFills OutValue with the value of DeserterCount_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetDeserterCountOrNull()Returns a pointer to DeserterCount_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetDeserterCountOrNull() constReturns a pointer to DeserterCount_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDeserterCount(const int32 & NewValue)Sets the value of DeserterCount_Optional and also sets DeserterCount_IsSet to true.
public inline void SetDeserterCount(int32 && NewValue)Sets the value of DeserterCount_Optional and also sets DeserterCount_IsSet to true using move semantics.
public inline void ClearDeserterCount()Clears the value of DeserterCount_Optional and sets DeserterCount_IsSet to false.
public inline bool IsDeserterCountSet() constChecks whether DeserterCount_Optional has been set.
public inline bool IsDeserterCountDefaultValue() constReturns true if DeserterCount_Optional is set and matches the default value.
public inline void SetDeserterCountToDefault()Sets the value of DeserterCount_Optional to its default and also sets DeserterCount_IsSet to true.
public inline FDateTime & GetLastUpdated()Gets the value of LastUpdated_Optional, regardless of it having been set.
public inline const FDateTime & GetLastUpdated() constGets the value of LastUpdated_Optional, regardless of it having been set.
public inline const FDateTime & GetLastUpdated(const FDateTime & DefaultValue) constGets the value of LastUpdated_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLastUpdated(FDateTime & OutValue) constFills OutValue with the value of LastUpdated_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetLastUpdatedOrNull()Returns a pointer to LastUpdated_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetLastUpdatedOrNull() constReturns a pointer to LastUpdated_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLastUpdated(const FDateTime & NewValue)Sets the value of LastUpdated_Optional and also sets LastUpdated_IsSet to true.
public inline void SetLastUpdated(FDateTime && NewValue)Sets the value of LastUpdated_Optional and also sets LastUpdated_IsSet to true using move semantics.
public inline void ClearLastUpdated()Clears the value of LastUpdated_Optional and sets LastUpdated_IsSet to false.
public inline bool IsLastUpdatedSet() constChecks whether LastUpdated_Optional has been set.
public inline TMap< FString, FString > & GetCustomData()Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData() constGets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) constGets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) constFills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetCustomDataOrNull()Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetCustomDataOrNull() constReturns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCustomData(const TMap< FString, FString > & NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void SetCustomData(TMap< FString, FString > && NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.
public inline void ClearCustomData()Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
public inline bool IsCustomDataSet() constChecks whether CustomData_Optional has been set.

Members​

public FString DeserterId ​

ID for which type of deserter this is.

public bool DeserterStatus ​

Flag of whether or not the player is a deserter.

public FDateTime DeserterExpiration_Optional ​

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.

public bool DeserterExpiration_IsSet ​

true if DeserterExpiration_Optional has been set to a value

public FDateTime DeserterReset_Optional ​

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.

public bool DeserterReset_IsSet ​

true if DeserterReset_Optional has been set to a value

public int32 DeserterCount_Optional ​

The number of times a player has deserted before the expiration.

public bool DeserterCount_IsSet ​

true if DeserterCount_Optional has been set to a value

public FDateTime LastUpdated_Optional ​

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.

public bool LastUpdated_IsSet ​

true if LastUpdated_Optional has been set to a value

public TMap< FString, FString > CustomData_Optional ​

Custom data about a players desertion status.

public bool CustomData_IsSet ​

true if CustomData_Optional has been set to a value

public virtual bool FromJson(const TSharedPtr< FJsonValue > & JsonValue) ​

Fills this object with data from the passed in JSON.

Parameters​

  • JsonValue Data from the API call.

Returns​

true if parsing of the JSON data was successful.

public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) const ​

Writes the data from this object into the specified JSON Writer stream.

Parameters​

  • Writer JSON Writer stream to push .

public inline FString & GetDeserterId() ​

Gets the value of DeserterId.

public inline const FString & GetDeserterId() const ​

Gets the value of DeserterId.

public inline void SetDeserterId(const FString & NewValue) ​

Sets the value of DeserterId.

public inline void SetDeserterId(FString && NewValue) ​

Sets the value of DeserterId using move semantics.

public inline bool & GetDeserterStatus() ​

Gets the value of DeserterStatus.

public inline const bool & GetDeserterStatus() const ​

Gets the value of DeserterStatus.

public inline void SetDeserterStatus(const bool & NewValue) ​

Sets the value of DeserterStatus.

public inline void SetDeserterStatus(bool && NewValue) ​

Sets the value of DeserterStatus using move semantics.

public inline bool IsDeserterStatusDefaultValue() const ​

Returns true if DeserterStatus matches the default value.

public inline void SetDeserterStatusToDefault() ​

Sets the value of DeserterStatus to its default

public inline FDateTime & GetDeserterExpiration() ​

Gets the value of DeserterExpiration_Optional, regardless of it having been set.

public inline const FDateTime & GetDeserterExpiration() const ​

Gets the value of DeserterExpiration_Optional, regardless of it having been set.

public inline const FDateTime & GetDeserterExpiration(const FDateTime & DefaultValue) const ​

Gets the value of DeserterExpiration_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetDeserterExpiration(FDateTime & OutValue) const ​

Fills OutValue with the value of DeserterExpiration_Optional and returns true if it has been set, otherwise returns false.

public inline FDateTime * GetDeserterExpirationOrNull() ​

Returns a pointer to DeserterExpiration_Optional, if it has been set, otherwise returns nullptr.

public inline const FDateTime * GetDeserterExpirationOrNull() const ​

Returns a pointer to DeserterExpiration_Optional, if it has been set, otherwise returns nullptr.

public inline void SetDeserterExpiration(const FDateTime & NewValue) ​

Sets the value of DeserterExpiration_Optional and also sets DeserterExpiration_IsSet to true.

public inline void SetDeserterExpiration(FDateTime && NewValue) ​

Sets the value of DeserterExpiration_Optional and also sets DeserterExpiration_IsSet to true using move semantics.

public inline void ClearDeserterExpiration() ​

Clears the value of DeserterExpiration_Optional and sets DeserterExpiration_IsSet to false.

public inline bool IsDeserterExpirationSet() const ​

Checks whether DeserterExpiration_Optional has been set.

public inline FDateTime & GetDeserterReset() ​

Gets the value of DeserterReset_Optional, regardless of it having been set.

public inline const FDateTime & GetDeserterReset() const ​

Gets the value of DeserterReset_Optional, regardless of it having been set.

public inline const FDateTime & GetDeserterReset(const FDateTime & DefaultValue) const ​

Gets the value of DeserterReset_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetDeserterReset(FDateTime & OutValue) const ​

Fills OutValue with the value of DeserterReset_Optional and returns true if it has been set, otherwise returns false.

public inline FDateTime * GetDeserterResetOrNull() ​

Returns a pointer to DeserterReset_Optional, if it has been set, otherwise returns nullptr.

public inline const FDateTime * GetDeserterResetOrNull() const ​

Returns a pointer to DeserterReset_Optional, if it has been set, otherwise returns nullptr.

public inline void SetDeserterReset(const FDateTime & NewValue) ​

Sets the value of DeserterReset_Optional and also sets DeserterReset_IsSet to true.

public inline void SetDeserterReset(FDateTime && NewValue) ​

Sets the value of DeserterReset_Optional and also sets DeserterReset_IsSet to true using move semantics.

public inline void ClearDeserterReset() ​

Clears the value of DeserterReset_Optional and sets DeserterReset_IsSet to false.

public inline bool IsDeserterResetSet() const ​

Checks whether DeserterReset_Optional has been set.

public inline int32 & GetDeserterCount() ​

Gets the value of DeserterCount_Optional, regardless of it having been set.

public inline const int32 & GetDeserterCount() const ​

Gets the value of DeserterCount_Optional, regardless of it having been set.

public inline const int32 & GetDeserterCount(const int32 & DefaultValue) const ​

Gets the value of DeserterCount_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetDeserterCount(int32 & OutValue) const ​

Fills OutValue with the value of DeserterCount_Optional and returns true if it has been set, otherwise returns false.

public inline int32 * GetDeserterCountOrNull() ​

Returns a pointer to DeserterCount_Optional, if it has been set, otherwise returns nullptr.

public inline const int32 * GetDeserterCountOrNull() const ​

Returns a pointer to DeserterCount_Optional, if it has been set, otherwise returns nullptr.

public inline void SetDeserterCount(const int32 & NewValue) ​

Sets the value of DeserterCount_Optional and also sets DeserterCount_IsSet to true.

public inline void SetDeserterCount(int32 && NewValue) ​

Sets the value of DeserterCount_Optional and also sets DeserterCount_IsSet to true using move semantics.

public inline void ClearDeserterCount() ​

Clears the value of DeserterCount_Optional and sets DeserterCount_IsSet to false.

public inline bool IsDeserterCountSet() const ​

Checks whether DeserterCount_Optional has been set.

public inline bool IsDeserterCountDefaultValue() const ​

Returns true if DeserterCount_Optional is set and matches the default value.

public inline void SetDeserterCountToDefault() ​

Sets the value of DeserterCount_Optional to its default and also sets DeserterCount_IsSet to true.

public inline FDateTime & GetLastUpdated() ​

Gets the value of LastUpdated_Optional, regardless of it having been set.

public inline const FDateTime & GetLastUpdated() const ​

Gets the value of LastUpdated_Optional, regardless of it having been set.

public inline const FDateTime & GetLastUpdated(const FDateTime & DefaultValue) const ​

Gets the value of LastUpdated_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetLastUpdated(FDateTime & OutValue) const ​

Fills OutValue with the value of LastUpdated_Optional and returns true if it has been set, otherwise returns false.

public inline FDateTime * GetLastUpdatedOrNull() ​

Returns a pointer to LastUpdated_Optional, if it has been set, otherwise returns nullptr.

public inline const FDateTime * GetLastUpdatedOrNull() const ​

Returns a pointer to LastUpdated_Optional, if it has been set, otherwise returns nullptr.

public inline void SetLastUpdated(const FDateTime & NewValue) ​

Sets the value of LastUpdated_Optional and also sets LastUpdated_IsSet to true.

public inline void SetLastUpdated(FDateTime && NewValue) ​

Sets the value of LastUpdated_Optional and also sets LastUpdated_IsSet to true using move semantics.

public inline void ClearLastUpdated() ​

Clears the value of LastUpdated_Optional and sets LastUpdated_IsSet to false.

public inline bool IsLastUpdatedSet() const ​

Checks whether LastUpdated_Optional has been set.

public inline TMap< FString, FString > & GetCustomData() ​

Gets the value of CustomData_Optional, regardless of it having been set.

public inline const TMap< FString, FString > & GetCustomData() const ​

Gets the value of CustomData_Optional, regardless of it having been set.

public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) const ​

Gets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetCustomData(TMap< FString, FString > & OutValue) const ​

Fills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false.

public inline TMap< FString, FString > * GetCustomDataOrNull() ​

Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.

public inline const TMap< FString, FString > * GetCustomDataOrNull() const ​

Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.

public inline void SetCustomData(const TMap< FString, FString > & NewValue) ​

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.

public inline void SetCustomData(TMap< FString, FString > && NewValue) ​

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.

public inline void ClearCustomData() ​

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.

public inline bool IsCustomDataSet() const ​

Checks whether CustomData_Optional has been set.