Menu
Lumberyard
C++ API Reference (Version 1.10)

AzFramework::SliceInstantiationTicket Class Reference

Identifies an asynchronous slice instantiation request. More...

Public Member Functions

 AZ_TYPE_INFO (SliceInstantiationTicket, "{E6E7C0C5-07C9-44BB-A38C-930431948667}")
 Enables this class to be identified across modules and serialized into different contexts. More...
 
 SliceInstantiationTicket (EntityContextId contextId=0, AZ::u64 requestId=0)
 Creates a slice instantiation ticket. More...
 
bool 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. More...
 
 operator bool () const
 Overloads the boolean operator to indicate that a slice instantiation ticket is true if its request ID is valid. More...
 

Public Attributes

EntityContextId m_contextId
 The ID of the entity context to create the slice in. More...
 
AZ::u64 m_requestId
 An ID for the slice instantiation ticket. More...
 

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 ( EntityContextId  contextId = 0,
AZ::u64  requestId = 0 
)
inline

Creates a slice instantiation ticket.

Parameters
contextIdThe ID of the entity context to create the slice in.
requestIdAn 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.

◆ operator bool()

AzFramework::SliceInstantiationTicket::operator bool ( ) const
inline

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
inline

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
rhsThe 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.

Member Data Documentation

◆ m_contextId

EntityContextId AzFramework::SliceInstantiationTicket::m_contextId

The ID of the entity context to create the slice in.

◆ m_requestId

AZ::u64 AzFramework::SliceInstantiationTicket::m_requestId

An ID for the slice instantiation ticket.


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