Navigation
API > API/Runtime > API/Runtime/Engine
A metrics mutator is a component of a UNetworkMetricsBaseListener that receices a metrics snapshot every frame. This enables a mutator to accumulate and/or transform (possibly multiple) input metrics into a single output value over the reporting interval of its owning listener. For example, FNetworkMetricsMutatorAvg allows a listener to report the average of a metric over a whole reporting interval.
| Name | FNetworkMetricsMutator |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Public/Net/NetworkMetricsMutators.h |
| Include Path | #include "Net/NetworkMetricsMutators.h" |
Syntax
USTRUCT ()
struct FNetworkMetricsMutator
Derived Classes
- FNetworkMetricsMutatorAvg
- FNetworkMetricsMutatorMax
- FNetworkMetricsMutatorMin
- FNetworkMetricsMutatorPercent
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FNetworkMetricsMutator() |
Net/NetworkMetricsMutators.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FValueVariant | TVariant< float, int64 > | Net/NetworkMetricsMutators.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| NameOverride | FName | User-configurable name for this mutator that if set, will override the internal name returned by GetNameInternal(). | Net/NetworkMetricsMutators.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TArrayView< const FName > GetAllMetricNames() |
Returns a list of all metrics used by this mutator. | Net/NetworkMetricsMutators.h | |
| Returns the name of this mutator. | Net/NetworkMetricsMutators.h | ||
virtual FValueVariant GetValue() |
Returns this mutator's current computed value | Net/NetworkMetricsMutators.h | |
virtual void ProcessFrame
(
const UE::Net::FNetworkMetricSnapshot& Snapshot |
Called every frame with a snapshot containing this mutator's metrics. | Net/NetworkMetricsMutators.h | |
virtual void Reset() |
Clears internal data, typically used after a listener reports its metrics. | Net/NetworkMetricsMutators.h |