NetObjectFactoryRegistry.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/ArrayView.h"
#include "UObject/Class.h"
#include "UObject/NameTypes.h"
#include "UObject/WeakObjectPtrTemplates.h"
 
// Define this to increase the maximum amount of NetObjectFactories that can exist
#ifndef UE_IRIS_MAX_NETOBJECT_FACTORIES
    #define UE_IRIS_MAX_NETOBJECT_FACTORIES 16
#endif
 
namespace UE::Net
{
 
typedef uint8 FNetObjectFactoryId;
enum { InvalidNetObjectFactoryId = MAX_uint8 };
 
 
class FNetObjectFactoryRegistry
{
public:
 
    IRISCORE_API static void RegisterFactory(UClass* FactoryClass, FName FactoryName);
 
    IRISCORE_API static void UnregisterFactory(FName FactoryName);
 
    IRISCORE_API static FNetObjectFactoryId GetFactoryIdFromName(FName FactoryName);
 
    IRISCORE_API static bool IsValidFactoryId(FNetObjectFactoryId Id);
 
    IRISCORE_API static void SetFactoryRegistrationAllowed(bool bAllowed);
 
    static constexpr uint32 MaxFactories = UE_IRIS_MAX_NETOBJECT_FACTORIES;
 
    static constexpr uint32 GetMaxBits() { return GetNumBits(MaxFactories-1); }
 
    struct FFactoryData
    {
        FName Name;
        FNetObjectFactoryId Id = InvalidNetObjectFactoryId;
        TWeakObjectPtr<UClass> NetFactoryClass;
    };
 
    static const TConstArrayView<FFactoryData> GetRegisteredFactories() { return MakeConstArrayView(NetFactories.GetData(), NetFactories.Num()); }
 
private:
    
    FNetObjectFactoryRegistry() = delete;
    ~FNetObjectFactoryRegistry() = delete;
 
    static constexpr uint32 GetNumBits(uint32 Number)
    {
        return Number==0 ? 0 : 1 + GetNumBits(Number >> 1);
    }
 
private:
 
    static TArray<FFactoryData, TFixedAllocator<MaxFactories>> NetFactories;
};
 
} // end namespace UE::Net