Property replication packet. More...

#include <NetworkEntityUpdateMessage.h>

Public Member Functions
	AZ_TYPE_INFO (NetworkEntityUpdateMessage,"{CFCA08F7-547B-4B89-9794-37A8679608DF}")

	NetworkEntityUpdateMessage (NetworkEntityUpdateMessage &&rhs)

	NetworkEntityUpdateMessage (const NetworkEntityUpdateMessage &rhs)

	NetworkEntityUpdateMessage (NetEntityRole entityRole, NetEntityId entityId)

	NetworkEntityUpdateMessage (NetEntityRole entityRole, NetEntityId entityId, const PrefabEntityId &prefabEntityId)

	NetworkEntityUpdateMessage (NetEntityId entityId, bool isMigrated)

NetworkEntityUpdateMessage &	operator= (NetworkEntityUpdateMessage &&rhs)

NetworkEntityUpdateMessage &	operator= (const NetworkEntityUpdateMessage &rhs)

bool	operator== (const NetworkEntityUpdateMessage &rhs) const

bool	operator!= (const NetworkEntityUpdateMessage &rhs) const

uint32_t	GetEstimatedSerializeSize () const

NetEntityRole	GetNetworkRole () const

NetEntityId	GetEntityId () const

bool	GetIsDelete () const

bool	GetWasMigrated () const

bool	GetHasValidPrefabId () const

void	SetPrefabEntityId (const PrefabEntityId &value)

const PrefabEntityId &	GetPrefabEntityId () const

void	SetData (const AzNetworking::PacketEncodingBuffer &value)

const AzNetworking::PacketEncodingBuffer *	GetData () const

AzNetworking::PacketEncodingBuffer &	ModifyData ()

bool	Serialize (AzNetworking::ISerializer &serializer)

Detailed Description

Property replication packet.

Constructor & Destructor Documentation

Multiplayer::NetworkEntityUpdateMessage::NetworkEntityUpdateMessage	(	NetEntityRole	entityRole,
		NetEntityId	entityId
	)

explicit

Constructor for update without a slice name (remote replicator established).

Parameters

entityRole	the role of the entity being replicated
entityId	the networkId of the entity being replicated

Multiplayer::NetworkEntityUpdateMessage::NetworkEntityUpdateMessage	(	NetEntityRole	entityRole,
		NetEntityId	entityId,
		const PrefabEntityId &	prefabEntityId
	)

explicit

Constructor for update with a slice name (no remote replicator established).

Parameters

entityRole	the role of the entity being replicated
entityId	the networkId of the entity being replicated
prefabEntityId	the prefab entityId to clone this replicated entity from

Multiplayer::NetworkEntityUpdateMessage::NetworkEntityUpdateMessage	(	NetEntityId	entityId,
		bool	isMigrated
	)

explicit

Constructor for an entity delete message.

Parameters

entityId	the networkId of the entity being deleted
isMigrated	whether or not the entity is being migrated or deleted

Member Function Documentation

const AzNetworking::PacketEncodingBuffer* Multiplayer::NetworkEntityUpdateMessage::GetData ( ) const

Gets the current value of Data.

Returns: the current value of Data

NetEntityId Multiplayer::NetworkEntityUpdateMessage::GetEntityId ( ) const

Gets the entity's networkId.

Returns: the entity's networkId

uint32_t Multiplayer::NetworkEntityUpdateMessage::GetEstimatedSerializeSize ( ) const

Returns an estimated serialization footprint for this NetworkEntityUpdateMessage.

Returns: an estimated serialization footprint for this NetworkEntityUpdateMessage

bool Multiplayer::NetworkEntityUpdateMessage::GetHasValidPrefabId ( ) const

Gets the current value of HasValidPrefabId.

Returns: the current value of HasValidPrefabId

bool Multiplayer::NetworkEntityUpdateMessage::GetIsDelete ( ) const

Gets the current value of IsDelete (true if this represents a DeleteProxy message).

Returns: the current value of IsDelete

NetEntityRole Multiplayer::NetworkEntityUpdateMessage::GetNetworkRole ( ) const

Gets the current value of NetworkRole.

Returns: the current value of NetworkRole

const PrefabEntityId& Multiplayer::NetworkEntityUpdateMessage::GetPrefabEntityId ( ) const

Gets the current value of PrefabEntityId.

Returns: the current value of PrefabEntityId

bool Multiplayer::NetworkEntityUpdateMessage::GetWasMigrated ( ) const

Returns whether or not the entity was migrated.

Returns: whether or not the entity was migrated

AzNetworking::PacketEncodingBuffer& Multiplayer::NetworkEntityUpdateMessage::ModifyData ( )

Retrieves a non-const reference to the value of Data.

Returns: a non-const reference to the value of Data

bool Multiplayer::NetworkEntityUpdateMessage::Serialize ( AzNetworking::ISerializer & serializer )

Base serialize method for all serializable structures or classes to implement.

Parameters

serializer ISerializer instance to use for serialization

Returns: boolean true for success, false for serialization failure

void Multiplayer::NetworkEntityUpdateMessage::SetData ( const AzNetworking::PacketEncodingBuffer & value )

Sets the current value for Data

Parameters

value the value to set Data to

void Multiplayer::NetworkEntityUpdateMessage::SetPrefabEntityId ( const PrefabEntityId & value )

Sets the current value for PrefabEntityId.

Parameters

value the value to set PrefabEntityId to

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

Gems/Multiplayer/Code/Include/Multiplayer/NetworkEntity/NetworkEntityUpdateMessage.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation