UCustomizableObjectSystem

API > API/Plugins > API/Plugins/CustomizableObject

   
Name UCustomizableObjectSystem
Type class
Header File /Engine/Plugins/Mutable/Source/CustomizableObject/Public/MuCO/CustomizableObjectSystem.h
Include Path #include "MuCO/CustomizableObjectSystem.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UCustomizableObjectSystem : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCustomizableObjectSystem()

   MuCO/CustomizableObjectSystem.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Private TObjectPtr< UCustomizableObjectSystemPrivate >   MuCO/CustomizableObjectSystem.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddUncompiledCOWarning ( const UCustomizableObject& InObject,
FString const* OptionalLogInfo
)

 Show a warning on-screen and via a notification (if in Editor) and log an error when a CustomizableObject is being used and it's not compiled. MuCO/CustomizableObjectSystem.h  

void AddViewCenter ( const AActor*const InCentralActor
)

 Add ViewCenters. Used to generate instances around when generating instances within a range. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • Category=CustomizableObjectSystem

bool CheckIfDiskOrMipUpdateOperationsPending ( const UCustomizableObject& Object
) const

 Checks if there are any outstanding disk or mip update operations in flight for the parameter Customizable Object that may make it unsafe to compile at the moment. MuCO/CustomizableObjectSystem.h  

void ClearViewCenters()

 Clear ViewCenters. Used to generate instances around when generating instances within a range. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • Category=CustomizableObjectSystem

void EditorSettingsChanged ( const FEditorCompileSettings& InEditorSettings
)

 Called whenever the Mutable Editor Settings change, copying the new value of the current needed settings to the Customizable Object System. MuCO/CustomizableObjectSystem.h  

void EnableBenchmark()

 Enables the collection of internal Mutable performance data. It has a performance cost. MuCO/CustomizableObjectSystem.h  

void EndBenchmark()

 Disables the reporting of mutable instance benchmarking data. MuCO/CustomizableObjectSystem.h  

int32 GetAverageBuildTime()

 Return the average build/update time of an instance in ms. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • Category=Status

int32 GetNumInstances()

 Get the number of instances built and alive. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • Category=Status

int32 GetNumPendingInstances()

 Get the number of instances waiting to be updated. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • Category=Status

FString GetPluginVersion()

 Find out the version of the plugin. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • Category=Status

UCustomizableObjectSystemPrivate * GetPrivate ()

 Give access to the internal object data. MuCO/CustomizableObjectSystem.h  

const UCustomizableObjectSystemPrivate * GetPrivate ()

   MuCO/CustomizableObjectSystem.h  

int64 GetTextureMemoryUsed()

 Get the amount of GPU memory in use in bytes for textures generated by mutable. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • Category=Status

int32 GetTotalInstances()

 Get the total number of instances including built and not built. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • Category=Status

int32 GetWorkingMemory()

 Get Mutable's working memory limit (kilobytes). See SetWorkingMemory(int32). MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category=CustomizableObjectSystem

void InitSystem()

   MuCO/CustomizableObjectSystem.h  

bool IsAutoCompilationSync()

 If true, uncompiled Customizable Objects will be compiled synchronously. MuCO/CustomizableObjectSystem.h  

bool IsAutoCompileCommandletEnabled()

 Return true if inside commandlets uncompiled Customizable Objects will be compiled whenever an instance update is required. MuCO/CustomizableObjectSystem.h  

bool IsAutoCompileEnabled()

 If true, uncompiled Customizable Objects will be compiled whenever an instance update is required. MuCO/CustomizableObjectSystem.h  

bool IsProgressiveMipStreamingEnabled()

   MuCO/CustomizableObjectSystem.h  

bool IsSupport16BitBoneIndexEnabled()

   MuCO/CustomizableObjectSystem.h  

bool IsUpdating ( const UCustomizableObjectInstance* Instance
) const

 Return true if the instance is being updated. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category=CustomizableObjectSystem

bool LockObject ( UCustomizableObject*
)

 Lock a CustomizableObjects, preventing the generation or update of any of its instances Will return true if successful, false if it fails to lock because an update is already underway This is usually only used in the editor MuCO/CustomizableObjectSystem.h  

void RemoveViewCenter ( const AActor*const InCentralActor
)

 Remove ViewCenters. Used to generate instances around when generating instances within a range. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • Category=CustomizableObjectSystem

void SetAutoCompileCommandletEnabled ( bool bValue
)

 Set if inside commandlets uncompiled Customizable Objects will be compiled whenever an instance update is required. MuCO/CustomizableObjectSystem.h  

void SetGenerateInstancesWithinRange ( bool bActive
)

 Instances within the generation range to the ViewCenters will be generated, When an instance falls outside the generation range the generated resources (meshes, textured, etc) will be dereferenced, and meshes on the components cleared. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • Category=CustomizableObjectSystem

void SetInstanceGenerationRange ( float Distance
)

 Instance generation range around view centers when mutable.GenerateInstancesWithinRange is true. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • Category=CustomizableObjectSystem

void SetProgressiveMipStreamingEnabled ( bool bIsEnabled
)

   MuCO/CustomizableObjectSystem.h  

void SetWorkingMemory ( int32 KiloBytes
)

 Set Mutable's working memory limit (kilobytes). MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • Category=CustomizableObjectSystem

void UnlockObject ( UCustomizableObject*
)

   MuCO/CustomizableObjectSystem.h  

Public Virtual

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   MuCO/CustomizableObjectSystem.h  

virtual FString GetDesc()

   MuCO/CustomizableObjectSystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static UCustomizableObjectSystem * GetInstance()

 Get the singleton object. It will be created if it doesn't exist yet. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category=Status

static UCustomizableObjectSystem * GetInstanceChecked()

   MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category=Status

static bool IsActive ()

 Returns the current status of Mutable. MuCO/CustomizableObjectSystem.h  

static bool IsCreated()

 Return true if the singleton has been created. It is different than GetInstance in that GetInstance will create it if it doesn't exist. MuCO/CustomizableObjectSystem.h  

static bool IsUpdateResultValid ( const EUpdateResult UpdateResult
)

 Determines if the result of the instance update is valid or not. MuCO/CustomizableObjectSystem.h
  • BlueprintCallable
  • Category=Status

static bool ShouldClearWorkingMemoryOnUpdateEnd()

 Get if mutable should clear its working memory between instance updates. MuCO/CustomizableObjectSystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page