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

A single networked client input command. More...

#include <NetworkInput.h>

Public Member Functions

 NetworkInput (const NetworkInput &)
 
NetworkInputoperator= (const NetworkInput &)
 
void SetClientInputId (ClientInputId inputId)
 
ClientInputId GetClientInputId () const
 
ClientInputId & ModifyClientInputId ()
 
void SetHostFrameId (HostFrameId hostFrameId)
 
HostFrameId GetHostFrameId () const
 
HostFrameId & ModifyHostFrameId ()
 
void SetHostTimeMs (AZ::TimeMs hostTimeMs)
 
AZ::TimeMs GetHostTimeMs () const
 
AZ::TimeMs & ModifyHostTimeMs ()
 
void SetHostBlendFactor (float hostBlendFactor)
 
float GetHostBlendFactor () const
 
void AttachNetBindComponent (NetBindComponent *netBindComponent)
 
bool Serialize (AzNetworking::ISerializer &serializer)
 
AZStd::vector< MultiplayerAuditingElementGetComponentInputDeltaLogs () const
 
const AZStd::string GetOwnerName () const
 
const IMultiplayerComponentInputFindComponentInput (NetComponentId componentId) const
 
IMultiplayerComponentInputFindComponentInput (NetComponentId componentId)
 
template<class InputType >
const InputType * FindComponentInput () const
 
template<typename InputType >
InputType * FindComponentInput ()
 

Friends

class NetworkInputArray
 
class NetworkInputMigrationVector
 
class NetworkInputHistory
 
class NetworkInputChild
 

Detailed Description

A single networked client input command.

Member Function Documentation

◆ GetComponentInputDeltaLogs()

AZStd::vector<MultiplayerAuditingElement> Multiplayer::NetworkInput::GetComponentInputDeltaLogs ( ) const

Fetches a vector of datums detailing which values per component input were not the default

Returns
A vector of datums detailing inputs and their non-default values

◆ GetOwnerName()

const AZStd::string Multiplayer::NetworkInput::GetOwnerName ( ) const

Returns the name of the owner entity of this input

Returns
An AZStd::string of the owning entity's name

Friends And Related Function Documentation

◆ NetworkInputArray

friend class NetworkInputArray
friend

Intentionally restrict instancing of these objects to associated containers classes only This is a mechanism used to restrict calling autonomous client predicted setter functions to the ProcessInput call chain only


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