AzFramework::SliceInstantiationTicket Class Reference

#include <SliceInstantiationTicket.h>

Public Member Functions
	AZ_TYPE_INFO (SliceInstantiationTicket, "{E6E7C0C5-07C9-44BB-A38C-930431948667}")
	SliceInstantiationTicket (const EntityContextId &contextId=AZ::Uuid::CreateNull(), AZ::u64 requestId=0)
bool	operator== (const SliceInstantiationTicket &rhs) const
bool	operator!= (const SliceInstantiationTicket &rhs) const
bool	IsValid () const
AZStd::string	ToString () const
const EntityContextId &	GetContextId () const
AZ::u64	GetRequestId () const

Detailed Description

Identifies an asynchronous slice instantiation request. This can be used to get the results of a slice instantiation request.

Constructor & Destructor Documentation

SliceInstantiationTicket()

AzFramework::SliceInstantiationTicket::SliceInstantiationTicket ( const EntityContextId &  contextId = AZ::Uuid::CreateNull(), AZ::u64  requestId = 0  )

explicit

Creates a slice instantiation ticket.

Parameters

contextId	The ID of the entity context to create the slice in.
requestId	An ID for the slice instantiation ticket.

Member Function Documentation

AZ_TYPE_INFO()

AzFramework::SliceInstantiationTicket::AZ_TYPE_INFO	(	SliceInstantiationTicket	,
		"{E6E7C0C5-07C9-44BB-A38C-930431948667}"
	)

Enables this class to be identified across modules and serialized into different contexts.

IsValid()

bool AzFramework::SliceInstantiationTicket::IsValid

(

)

const

Overloads the boolean operator to indicate that a slice instantiation ticket is true if its request ID is valid.

Returns

Returns true if the request ID is not equal to zero.

operator!=()

bool AzFramework::SliceInstantiationTicket::operator!=

(

const SliceInstantiationTicket &

rhs

)

const

Overloads the inequality operator to indicate that two slice instantiation tickets are not equal do not have the same entity context ID and request ID.

Parameters

rhs	The slice instantiation ticket you want to compare to the current ticket.

Returns

Returns true if the entity context ID and the request ID of the slice instantiation tickets are not equal.

operator==()

bool AzFramework::SliceInstantiationTicket::operator==

(

const SliceInstantiationTicket &

rhs

)

const

Overloads the equality operator to indicate that two slice instantiation tickets are equal if they have the same entity context ID and request ID.

Parameters

rhs	The slice instantiation ticket you want to compare to the current ticket.

Returns

Returns true if the entity context ID and the request ID of the slice instantiation tickets are equal.

---

The documentation for this class was generated from the following file:

• Code/Framework/AzFramework/AzFramework/Slice/SliceInstantiationTicket.h