Open 3D Engine Multiplayer Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Multiplayer::NetworkEntityRpcMessage Class Reference

Remote procedure call data. More...

#include <NetworkEntityRpcMessage.h>

Public Member Functions

 AZ_TYPE_INFO (NetworkEntityRpcMessage, "{3AA5E1A5-6383-46C1-9817-F1B8C2325178}")
 
 NetworkEntityRpcMessage (NetworkEntityRpcMessage &&rhs)
 
 NetworkEntityRpcMessage (const NetworkEntityRpcMessage &rhs)
 
 NetworkEntityRpcMessage (RpcDeliveryType rpcDeliveryType, NetEntityId entityId, NetComponentId componentId, RpcIndex rpcIndex, ReliabilityType isReliable)
 
NetworkEntityRpcMessageoperator= (NetworkEntityRpcMessage &&rhs)
 
NetworkEntityRpcMessageoperator= (const NetworkEntityRpcMessage &rhs)
 
bool operator== (const NetworkEntityRpcMessage &rhs) const
 
bool operator!= (const NetworkEntityRpcMessage &rhs) const
 
uint32_t GetEstimatedSerializeSize () const
 
RpcDeliveryType GetRpcDeliveryType () const
 
void SetRpcDeliveryType (RpcDeliveryType value)
 
NetEntityId GetEntityId () const
 
NetComponentId GetComponentId () const
 
RpcIndex GetRpcIndex () const
 
bool SetRpcParams (IRpcParamStruct &params)
 
bool GetRpcParams (IRpcParamStruct &outParams)
 
bool Serialize (AzNetworking::ISerializer &serializer)
 
void SetReliability (ReliabilityType reliabilityType)
 
ReliabilityType GetReliability () const
 

Detailed Description

Remote procedure call data.

Constructor & Destructor Documentation

◆ NetworkEntityRpcMessage()

Multiplayer::NetworkEntityRpcMessage::NetworkEntityRpcMessage ( RpcDeliveryType  rpcDeliveryType,
NetEntityId  entityId,
NetComponentId  componentId,
RpcIndex  rpcIndex,
ReliabilityType  isReliable 
)
explicit

Fill explicit constructor.

Parameters
rpcDeliveryTypethe delivery type (origin and target) for this rpc
entityIdthe networked entityId of the entity handling this rpc
componentTypethe networked componentId of the component handling this rpc
rpcIndexthe component defined rpc index, so the component knows which rpc this message corresponds to
isReliablewhether or not this rpc should be sent reliably

Member Function Documentation

◆ GetComponentId()

NetComponentId Multiplayer::NetworkEntityRpcMessage::GetComponentId ( ) const

Gets the current value of EntityComponentType.

Returns
the current value of EntityComponentType

◆ GetEntityId()

NetEntityId Multiplayer::NetworkEntityRpcMessage::GetEntityId ( ) const

Gets the current value of EntityId.

Returns
the current value of EntityId

◆ GetEstimatedSerializeSize()

uint32_t Multiplayer::NetworkEntityRpcMessage::GetEstimatedSerializeSize ( ) const

Returns an estimated serialization footprint for this NetworkEntityRpcMessage.

Returns
an estimated serialization footprint for this NetworkEntityRpcMessage

◆ GetReliability()

ReliabilityType Multiplayer::NetworkEntityRpcMessage::GetReliability ( ) const

Returns whether or not this RPC has been flagged for reliable delivery.

Returns
the reliability type of this RPC

◆ GetRpcDeliveryType()

RpcDeliveryType Multiplayer::NetworkEntityRpcMessage::GetRpcDeliveryType ( ) const

Gets the current value of RpcDeliveryType.

Returns
the current value of RpcDeliveryType

◆ GetRpcIndex()

RpcIndex Multiplayer::NetworkEntityRpcMessage::GetRpcIndex ( ) const

Gets the current value of RpcIndex.

Returns
the current value of RpcIndex

◆ GetRpcParams()

bool Multiplayer::NetworkEntityRpcMessage::GetRpcParams ( IRpcParamStruct outParams)

Reads the data contained inside this NetworkEntityRpcMessage's blob buffer and stores them in outParams.

Parameters
outParamsthe parameters instance to store to the resulting data inside

◆ Serialize()

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

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

Parameters
serializerISerializer instance to use for serialization
Returns
boolean true for success, false for serialization failure

◆ SetReliability()

void Multiplayer::NetworkEntityRpcMessage::SetReliability ( ReliabilityType  reliabilityType)

Sets this RPC's reliable delivery flag.

Parameters
reliabilityTypethe reliability type for this RPC

◆ SetRpcDeliveryType()

void Multiplayer::NetworkEntityRpcMessage::SetRpcDeliveryType ( RpcDeliveryType  value)

Sets the current value for RpcDeliveryType.

Parameters
valuethe value to set RpcDeliveryType to

◆ SetRpcParams()

bool Multiplayer::NetworkEntityRpcMessage::SetRpcParams ( IRpcParamStruct params)

Writes the data contained inside a_Params to this NetworkEntityRpcMessage's blob buffer.

Parameters
paramsthe parameters to save inside this NetworkEntityRpcMessage instance

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