A bunch of work to get external multiplayer components to actually work

This commit is contained in:
karlberg
2021-05-12 16:01:59 -07:00
parent 293e0057f4
commit 254ad165c1
70 changed files with 162 additions and 185 deletions
@@ -11,8 +11,8 @@
*/
#include <Source/NetworkTime/NetworkTime.h>
#include <Source/Components/NetBindComponent.h>
#include <Include/IMultiplayer.h>
#include <Multiplayer/NetBindComponent.h>
#include <Multiplayer/IMultiplayer.h>
#include <AzFramework/Visibility/IVisibilitySystem.h>
namespace Multiplayer
@@ -12,7 +12,7 @@
#pragma once
#include <Include/INetworkTime.h>
#include <Multiplayer/INetworkTime.h>
#include <AzCore/Component/Component.h>
#include <AzCore/Console/IConsole.h>
@@ -1,118 +0,0 @@
/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
#pragma once
#include <Include/INetworkTime.h>
#include <AzNetworking/Serialization/ISerializer.h>
#include <AzNetworking/ConnectionLayer/IConnection.h>
#include <AzNetworking/Utilities/NetworkCommon.h>
#include <AzCore/std/containers/array.h>
#include <AzCore/std/string/string.h>
#include <AzCore/Console/ILogger.h>
namespace Multiplayer
{
//! @class RewindableObject
//! @brief A simple serializable data container that keeps a history of previous values, and can fetch those old values on request.
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
class RewindableObject
{
public:
RewindableObject() = default;
//! Constructor.
//! @param connectionId the connectionId of the connection that owns the object.
RewindableObject(const BASE_TYPE& value);
//! Copy construct from underlying base type.
//! @param value base type value to construct from
//! @param owningConnectionId the entity id of the owning object
explicit RewindableObject(const BASE_TYPE& value, AzNetworking::ConnectionId owningConnectionId);
//! Copy construct from another rewindable history buffer.
//! @param rhs rewindable history buffer to construct from
RewindableObject(const RewindableObject& rhs);
//! Assignment from underlying base type.
//! @param rhs base type value to assign from
RewindableObject& operator = (const BASE_TYPE& rhs);
//! Assignment from rewindable history buffer.
//! @param rhs rewindable history buffer to assign from
RewindableObject& operator = (const RewindableObject& rhs);
//! Sets the owning connectionId for the given rewindable object instance.
//! @param owningConnectionId the new connectionId to use as the owning connectionId.
void SetOwningConnectionId(AzNetworking::ConnectionId owningConnectionId);
//! Const base type operator.
//! @return value in const base type form
operator const BASE_TYPE&() const;
//! Const base type retriever.
//! @return value in const base type form
const BASE_TYPE& Get() const;
//! Base type retriever.
//! @return value in base type form
BASE_TYPE& Modify();
//! Equality operator.
//! @param rhs base type value to compare against
//! @return boolean true if this == rhs
bool operator == (const BASE_TYPE& rhs) const;
//! Inequality operator.
//! @param rhs base type value to compare against
//! @return boolean true if this != rhs
bool operator != (const BASE_TYPE& rhs) const;
//! Base serialize method for all serializable structures or classes to implement
//! @param serializer ISerializer instance to use for serialization
//! @return boolean true for success, false for serialization failure
bool Serialize(AzNetworking::ISerializer& serializer);
private:
//! Returns what the appropriate current time is for this rewindable property.
//! @return the appropriate current time is for this rewindable property
HostFrameId GetCurrentTimeForProperty() const;
//! Updates the latest value for this object instance, if frameTime represents a current or future time.
//! Any attempts to set old values on the object will fail
//! @param value the new value to set in the object history
//! @param frameTime the time to set the value for
void SetValueForTime(const BASE_TYPE& value, HostFrameId frameTime);
//! Const value accessor, returns the correct value for the provided input time.
//! @param frameTime the frame time to return the associated value for
//! @return value given the current input time
const BASE_TYPE& GetValueForTime(HostFrameId frameTime) const;
//! Helper method to compute clamped array index values accounting for the offset head index.
AZStd::size_t GetOffsetIndex(AZStd::size_t absoluteIndex) const;
AZStd::array<BASE_TYPE, REWIND_SIZE> m_history;
AzNetworking::ConnectionId m_owningConnectionId = AzNetworking::InvalidConnectionId;
HostFrameId m_headTime = HostFrameId{0};
uint32_t m_headIndex = 0;
};
}
namespace AZ
{
AZ_TYPE_INFO_TEMPLATE(Multiplayer::RewindableObject, "{B2937B44-FEE1-4277-B1E0-863DE76D363F}", AZ_TYPE_INFO_TYPENAME, AZ_TYPE_INFO_AUTO);
}
#include <Source/NetworkTime/RewindableObject.inl>
@@ -1,178 +0,0 @@
/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
#pragma once
namespace Multiplayer
{
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline RewindableObject<BASE_TYPE, REWIND_SIZE>::RewindableObject(const BASE_TYPE& value)
{
m_history.fill(value);
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline RewindableObject<BASE_TYPE, REWIND_SIZE>::RewindableObject(const BASE_TYPE& value, AzNetworking::ConnectionId owningConnectionId)
: m_owningConnectionId(owningConnectionId)
, m_history(value)
{
m_history.fill(value);
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline RewindableObject<BASE_TYPE, REWIND_SIZE>::RewindableObject(const RewindableObject<BASE_TYPE, REWIND_SIZE>& rhs)
: m_owningConnectionId(rhs.m_owningConnectionId)
, m_headTime(GetCurrentTimeForProperty())
, m_headIndex(0)
{
m_history.fill(static_cast<BASE_TYPE>(rhs));
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline RewindableObject<BASE_TYPE, REWIND_SIZE> &RewindableObject<BASE_TYPE, REWIND_SIZE>::operator =(const BASE_TYPE& rhs)
{
SetValueForTime(rhs, GetCurrentTimeForProperty());
return *this;
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline RewindableObject<BASE_TYPE, REWIND_SIZE> &RewindableObject<BASE_TYPE, REWIND_SIZE>::operator =(const RewindableObject<BASE_TYPE, REWIND_SIZE>& rhs)
{
INetworkTime* networkTime = GetNetworkTime();
SetValueForTime(rhs.GetValueForTime(networkTime->GetHostFrameId()), GetCurrentTimeForProperty());
return *this;
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline void RewindableObject<BASE_TYPE, REWIND_SIZE>::SetOwningConnectionId(AzNetworking::ConnectionId owningConnectionId)
{
m_owningConnectionId = owningConnectionId;
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline RewindableObject<BASE_TYPE, REWIND_SIZE>::operator const BASE_TYPE& () const
{
return Get();
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline const BASE_TYPE& RewindableObject<BASE_TYPE, REWIND_SIZE>::Get() const
{
return GetValueForTime(GetCurrentTimeForProperty());
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline BASE_TYPE& RewindableObject<BASE_TYPE, REWIND_SIZE>::Modify()
{
const HostFrameId frameTime = GetCurrentTimeForProperty();
if (frameTime < m_headTime)
{
AZ_Assert(false, "Trying to mutate a rewindable in the past");
}
else if (m_headTime < frameTime)
{
SetValueForTime(GetValueForTime(frameTime), frameTime);
}
const BASE_TYPE& returnValue = GetValueForTime(frameTime);
return const_cast<BASE_TYPE&>(returnValue);
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline bool RewindableObject<BASE_TYPE, REWIND_SIZE>::operator == (const BASE_TYPE& rhs) const
{
const BASE_TYPE lhs = GetValueForTime(GetCurrentTimeForProperty());
return (lhs == rhs);
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline bool RewindableObject<BASE_TYPE, REWIND_SIZE>::operator != (const BASE_TYPE& rhs) const
{
const BASE_TYPE lhs = GetValueForTime(GetCurrentTimeForProperty());
return (lhs != rhs);
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline bool RewindableObject<BASE_TYPE, REWIND_SIZE>::Serialize(AzNetworking::ISerializer& serializer)
{
const HostFrameId frameTime = GetCurrentTimeForProperty();
BASE_TYPE value = GetValueForTime(frameTime);
if (serializer.Serialize(value, "Element") && (serializer.GetSerializerMode() == AzNetworking::SerializerMode::WriteToObject))
{
SetValueForTime(value, frameTime);
}
return serializer.IsValid();
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline HostFrameId RewindableObject<BASE_TYPE, REWIND_SIZE>::GetCurrentTimeForProperty() const
{
INetworkTime* networkTime = GetNetworkTime();
return networkTime->GetHostFrameIdForRewindingConnection(m_owningConnectionId);
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline void RewindableObject<BASE_TYPE, REWIND_SIZE>::SetValueForTime(const BASE_TYPE& value, HostFrameId frameTime)
{
if (frameTime < m_headTime)
{
// Don't try and set values older than our current head value
return;
}
// Keeping a reference to copy to head so that delta bitset differences are only applied from the prev version
const BASE_TYPE& prevHead = m_history[m_headIndex];
if (static_cast<size_t>(frameTime - m_headTime) >= m_history.size())
{
// This update represents a large enough time delta that we'll just flush the whole buffer with the new value
m_headTime = frameTime;
m_headIndex = 0;
for (uint32_t i = 0; i < m_history.size(); ++i)
{
m_history[i] = value;
}
return;
}
while (m_headTime < frameTime)
{
m_history[m_headIndex] = prevHead;
m_headIndex = (m_headIndex + 1) % m_history.size();
m_headTime++;
}
m_history[m_headIndex] = value;
AZ_Assert(m_headTime == frameTime, "Invalid head value");
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline const BASE_TYPE &RewindableObject<BASE_TYPE, REWIND_SIZE>::GetValueForTime(HostFrameId frameTime) const
{
if (frameTime > m_headTime)
{
return m_history[m_headIndex];
}
const AZStd::size_t frameDelta = static_cast<AZStd::size_t>(m_headTime) - static_cast<AZStd::size_t>(frameTime);
return m_history[GetOffsetIndex(frameDelta)];
}
template <typename BASE_TYPE, AZStd::size_t REWIND_SIZE>
inline AZStd::size_t RewindableObject<BASE_TYPE, REWIND_SIZE>::GetOffsetIndex(AZStd::size_t absoluteIndex) const
{
if (absoluteIndex >= m_history.size())
{
AZLOG(NET_Rewind, "Request for value which is too old");
absoluteIndex = m_history.size() - 1;
}
return ((m_headIndex + m_history.size()) - absoluteIndex) % m_history.size();
}
}