Class: USystemsPipeline

class SYSTEMS_API USystemsPipeline
    : public UDataAsset;

Reflection-enabled

Specifiers:

  • BlueprintType

Data asset used to describe Systems pipeline.

Properties

  • AssetResourcesToInstall

    public:
TMap<TObjectPtr<UDataAsset>, FSystemsPipelineAssetResource> AssetResourcesToInstall;

    Reflection-enabled

    Specifiers:

    • EditAnywhere
    • Category = Resources|Assets

    Asset resources to be registered into systems world.

    Usually these are used as settings/config data sources.

  • CleanupSystemsToRun

    public:
TArray<FSystemsPipelineSystem> CleanupSystemsToRun;

    Reflection-enabled

    Specifiers:

    • EditAnywhere
    • Category = Systems|Cleanup

    System templates to instantiate and run on systems world destruction.

    Order in the list represents order of execution.

  • ComponentsToRegister

    public:
TMap<TSubclassOf<UActorComponent>, FSystemsPipelineComponent> ComponentsToRegister;

    Reflection-enabled

    Specifiers:

    • EditAnywhere
    • Category = Components|Types

    Typed components to be registered into systems world.

  • PersistentSystemsToInstall

    public:
TArray<FSystemsPipelineSystem> PersistentSystemsToInstall;

    Reflection-enabled

    Specifiers:

    • EditAnywhere
    • Category = Systems|Persistent

    System templates to instantiate and register into systems world to run every tick.

    Order in the list represents order of execution.

  • PipelinesToImport

    public:
TArray<TObjectPtr<USystemsPipeline>> PipelinesToImport;

    Reflection-enabled

    Specifiers:

    • EditAnywhere
    • Category = Pipelines

    List of additional pipelines to import setup from when installing into systems world.

  • StartupSystemsToRun

    public:
TArray<FSystemsPipelineSystem> StartupSystemsToRun;

    Reflection-enabled

    Specifiers:

    • EditAnywhere
    • Category = Systems|Startup

    System templates to instantiate and run on systems world creation.

    Order in the list represents order of execution.

  • TypeResourcesToInstall

    public:
TMap<TSubclassOf<UObject>, FSystemsPipelineTypeResource> TypeResourcesToInstall;

    Reflection-enabled

    Specifiers:

    • EditAnywhere
    • Category = Resources|Types

    Typed resources to be registered into systems world.

    Usually these are used as game managers.

Methods

  • Install

    public:
void Install(
    UWorld* World
) const;

    Creates new global systems world under USystemsPipeline::WorldId name and installs this pipeline content into that systems world.

    Arguments

  • InstallInto

    public:
void InstallInto(
    USystemsWorld& Systems,
    TSet<TObjectPtr<USystemsPipeline>>& PipelinesToIgnore
) const;

    Installs this pipeline content into given systems world.

    Arguments

    • Systems

      USystemsWorld& Systems

      Target USystemsWorld.

      NOTE: Make sure to install pipeline in its Setup phase, before it gets sealed.

    • PipelinesToIgnore

      TSet<TObjectPtr<USystemsPipeline>>& PipelinesToIgnore

      List of pipelines to ignore when installing.

      This is needed for internal importing mechanism to avoid cycles of cross-referencing pipelines. You most likely might want to leave it empty when called yourself.

  • Uninstall

    public:
void Uninstall(
    UWorld* World
) const;

    Destroys systems world registered under USystemsPipeline::WorldId name.

    Arguments

Documentation built with Unreal-Doc v1.0.8 tool by PsichiX