FUniqueNetIdAccelByteResource Class Reference

Unique ID instance for identifying generic AccelByte resources other than users. User IDs should use FUniqueNetIdAccelByteUser as they have extra composite components that are useful for identifying a user on their specific platform. More...

#include <OnlineSubsystemAccelByteTypes.h>

Inheritance diagram for FUniqueNetIdAccelByteResource:

Public Member Functions
virtual FName	GetType () const override
	Return the type of this unique ID. In this case, it should always be ACCELBYTE_RESOURCE_ID_TYPE.
virtual bool	IsValid () const override
	Check whether this resource ID is valid or not.

Static Public Member Functions
template<typename... TArgs>
static FUniqueNetIdAccelByteResourceRef	Create (TArgs &&... Args)
	Create a new AccelByte Resource UniqueNetId instance.
static FUniqueNetIdAccelByteResourceRef	Cast (FUniqueNetId const &InNetId)
	Takes an UniqueNetId object and converts it to an AccelByte Resource UniqueNetId instance if the type matches. Will return an Invalid ID reference if the conversion cannot be made. Prefer the other Cast methods if possible.
static FUniqueNetIdAccelByteResourcePtr	TryCast (FUniqueNetId const &InNetId)
	Attempts to convert an UniqueNetId object to an AccelByte Resource UniqueNetId instance. Will return nullptr if the cast cannot be made.
static FUniqueNetIdAccelByteResourcePtr	TryCast (FUniqueNetIdRef const &InNetIdRef)
	Attempts to convert a shared reference of UniqueNetId object to an AccelByte Resource UniqueNetId instance. Will return nullptr if the cast cannot be made.
static FUniqueNetIdAccelByteResourceRef	Invalid ()
	Convenience method to construct an invalid instance of AccelByte Resource UniqueNetId.
static FUniqueNetIdAccelByteResourceRef	CastChecked (FUniqueNetIdRef const &InNetIdRef)
	Attempts to convert a shared reference of UniqueNetId object to an AccelByte Resource UniqueNetId instance. Guarded by a check call that will crash if an improper ID is attempted to be casted.

Public Attributes
PACKAGE_SCOPE	: static FUniqueNetIdAccelByteResourceRef CastChecked(FUniqueNetId const& InNetId)

Protected Member Functions
	FUniqueNetIdAccelByteResource ()
	Default constructor.
	FUniqueNetIdAccelByteResource (FString const &InNetIdStr)
	Internal constructor that accepts an UniqueNetId string.
	FUniqueNetIdAccelByteResource (FString &&InNetIdStr)
	Internal constructor that pass the ownership of UniqueNetId string.
	FUniqueNetIdAccelByteResource (FUniqueNetId const &InNetId)
	Internal constructor that accepts an instance of UniqueNetId.
	FUniqueNetIdAccelByteResource (FString const &InNetIdStr, FName const InType)
	Internal constructor that accepts an UniqueNetId string and its type name.
	FUniqueNetIdAccelByteResource (FString &&InNetIdStr, FName const InType)
	Internal constructor that accepts the ownership of UniqueNetId string and its type name.

Detailed Description

Unique ID instance for identifying generic AccelByte resources other than users. User IDs should use FUniqueNetIdAccelByteUser as they have extra composite components that are useful for identifying a user on their specific platform.

Constructor & Destructor Documentation

FUniqueNetIdAccelByteResource() [1/5]

FUniqueNetIdAccelByteResource::FUniqueNetIdAccelByteResource ( FString const & InNetIdStr )

explicitprotected

Internal constructor that accepts an UniqueNetId string.

Parameters

InNetIdStr

The UniqueNetId string.

FUniqueNetIdAccelByteResource() [2/5]

FUniqueNetIdAccelByteResource::FUniqueNetIdAccelByteResource ( FString && InNetIdStr )

explicitprotected

Internal constructor that pass the ownership of UniqueNetId string.

Parameters

InNetIdStr

The UniqueNetId string.

FUniqueNetIdAccelByteResource() [3/5]

FUniqueNetIdAccelByteResource::FUniqueNetIdAccelByteResource ( FUniqueNetId const & InNetId )

explicitprotected

Internal constructor that accepts an instance of UniqueNetId.

Parameters

InNetId

The UniqueNetId object.

FUniqueNetIdAccelByteResource() [4/5]

FUniqueNetIdAccelByteResource::FUniqueNetIdAccelByteResource ( FString const & InNetIdStr, FName const InType )

explicitprotected

Internal constructor that accepts an UniqueNetId string and its type name.

Parameters

InNetIdStr	The UniqueNetId string.
InType	The type name of UniqueNetId.

FUniqueNetIdAccelByteResource() [5/5]

FUniqueNetIdAccelByteResource::FUniqueNetIdAccelByteResource ( FString && InNetIdStr, FName const InType )

explicitprotected

Internal constructor that accepts the ownership of UniqueNetId string and its type name.

Parameters

InNetIdStr	The UniqueNetId string.
InType	The type name of UniqueNetId.

Member Function Documentation

Cast()

FUniqueNetIdAccelByteResourceRef FUniqueNetIdAccelByteResource::Cast ( FUniqueNetId const & InNetId )

static

Takes an UniqueNetId object and converts it to an AccelByte Resource UniqueNetId instance if the type matches. Will return an Invalid ID reference if the conversion cannot be made. Prefer the other Cast methods if possible.

Parameters

InNetId

The UniqueNetId object to attempt to convert to an AccelByte Resource UniqueNetId instance.

Returns

A shared reference of AccelByte Resource UniqueNetId object.

CastChecked()

FUniqueNetIdAccelByteResourceRef FUniqueNetIdAccelByteResource::CastChecked ( FUniqueNetIdRef const & InNetIdRef )

static

Attempts to convert a shared reference of UniqueNetId object to an AccelByte Resource UniqueNetId instance. Guarded by a check call that will crash if an improper ID is attempted to be casted.

Parameters

InNetIdRef

The shared reference of UniqueNetId object that will be converted to AccelByte Resource UniqueNetId instance.

Returns

A shared reference of AccelByte Resource UniqueNetId object.

Create()

template<typename... TArgs>

FUniqueNetIdAccelByteResourceRef FUniqueNetIdAccelByteResource::Create ( TArgs &&... Args )

inlinestatic

Create a new AccelByte Resource UniqueNetId instance.

Parameters

Args	The arguments that will be forwarded to the Constructor.

Returns

A shared reference of AccelByte Resource UniqueNetId object.

GetType()

FName FUniqueNetIdAccelByteResource::GetType ( ) const

overridevirtual

Return the type of this unique ID. In this case, it should always be ACCELBYTE_RESOURCE_ID_TYPE.

Returns

ACCELBYTE_RESOURCE_ID_TYPE.

Reimplemented in FUniqueNetIdAccelByteUser.

Invalid()

FUniqueNetIdAccelByteResourceRef FUniqueNetIdAccelByteResource::Invalid ( )

static

Convenience method to construct an invalid instance of AccelByte Resource UniqueNetId.

Returns

A shared reference of AccelByte Resource UniqueNetId object that has Invalid ID.

IsValid()

bool FUniqueNetIdAccelByteResource::IsValid ( ) const

overridevirtual

Check whether this resource ID is valid or not.

Reimplemented in FUniqueNetIdAccelByteUser.

TryCast() [1/2]

FUniqueNetIdAccelByteResourcePtr FUniqueNetIdAccelByteResource::TryCast ( FUniqueNetId const & InNetId )

static

Attempts to convert an UniqueNetId object to an AccelByte Resource UniqueNetId instance. Will return nullptr if the cast cannot be made.

Parameters

InNetId

The UniqueNetId object to attempt to convert to an AccelByte Resource UniqueNetId instance.

Returns

A shared pointer of AccelByte Resource UniqueNetId object.

TryCast() [2/2]

FUniqueNetIdAccelByteResourcePtr FUniqueNetIdAccelByteResource::TryCast ( FUniqueNetIdRef const & InNetIdRef )

static

Attempts to convert a shared reference of UniqueNetId object to an AccelByte Resource UniqueNetId instance. Will return nullptr if the cast cannot be made.

Parameters

InNetIdRef

The shared reference of UniqueNetId object to attempt to convert to an AccelByte Resource UniqueNetId instance.

Returns

A shared pointer of AccelByte Resource UniqueNetId object.