#include <EntityId.h>
Inherited by AZ::NamedEntityId.
|
class | JsonEntityIdSerializer |
|
class | Entity |
|
Entity ID type. Entity IDs are used to uniquely identify entities. Each component that is attached to an entity is tagged with the entity's ID, and component buses are typically addressed by entity ID.
◆ EntityId()
Creates an entity ID instance. If you do not provide a value for the entity ID, the entity ID is set to an invalid value.
- Parameters
-
id | (Optional) An ID for the entity. |
◆ AZ_TYPE_INFO()
AZ::EntityId::AZ_TYPE_INFO |
( |
EntityId |
, |
|
|
"{6383F1D3-BB27-4E6B-A49A-6409B2059EAA}" |
|
|
) |
| |
Enables this class to be identified across modules and serialized into different contexts.
◆ IsValid()
AZ_FORCE_INLINE bool AZ::EntityId::IsValid |
( |
| ) |
const |
|
inline |
Determines whether this entity ID is valid. An entity ID is invalid if you did not provide an argument to the entity ID constructor.
- Returns
- Returns true if the entity ID is valid. Otherwise, false.
◆ operator u64()
AZ_FORCE_INLINE AZ::EntityId::operator u64 |
( |
| ) |
const |
|
inlineexplicit |
Casts the entity ID to u64.
- Returns
- The entity ID.
◆ operator!=()
AZ_FORCE_INLINE bool AZ::EntityId::operator!= |
( |
const EntityId & |
rhs | ) |
const |
|
inline |
Compares two entity IDs.
- Parameters
-
rhs | An entity ID whose value you want to compare to the given entity ID. |
- Returns
- True if the entity IDs are different. Otherwise, false.
◆ operator<()
AZ_FORCE_INLINE bool AZ::EntityId::operator< |
( |
const EntityId & |
rhs | ) |
const |
|
inline |
Evaluates whether the entity ID is less than a given entity ID.
- Parameters
-
rhs | An entity ID whose size you want to compare to the given entity ID. |
- Returns
- True if the entity ID is less than the given entity ID. Otherwise, false.
◆ operator==()
AZ_FORCE_INLINE bool AZ::EntityId::operator== |
( |
const EntityId & |
rhs | ) |
const |
|
inline |
Compares two entity IDs for equality.
- Parameters
-
rhs | An entity ID whose value you want to compare to the given entity ID. |
- Returns
- True if the entity IDs are equal. Otherwise, false.
◆ operator>()
AZ_FORCE_INLINE bool AZ::EntityId::operator> |
( |
const EntityId & |
rhs | ) |
const |
|
inline |
Evaluates whether the entity ID is greater than a given entity ID.
- Parameters
-
rhs | An entity ID whose size you want to compare to the given entity ID. |
- Returns
- True if the entity ID is greater than the given entity ID. Otherwise, false.
◆ SetInvalid()
AZ_FORCE_INLINE void AZ::EntityId::SetInvalid |
( |
| ) |
|
|
inline |
Sets the entity ID to an invalid value.
◆ ToString()
Returns the entity ID as a string.
◆ InvalidEntityId
const u64 AZ::EntityId::InvalidEntityId = 0x00000000FFFFFFFFull |
|
static |
Invalid entity ID with a machine ID of 0 and the maximum timestamp.
◆ m_id
The documentation for this class was generated from the following file: