『FOAMSTARS』で実装したエフェクトプール機能の紹介

// ------------------------------------------------------------------------------------------------------------------------------
// エフェクトの生成時にプール使用を宣言する
// ------------------------------------------------------------------------------------------------------------------------------
UGameplayStatics::SpawnEmitterAtLocation
(
    const UObject* WorldContextObject, 
    UParticleSystem* EmitterTemplate, 
    FVector SpawnLocation, 
    FRotator SpawnRotation,
    // プール使用宣言をしている場合は無視されます
     bool bAutoDestroy, 
     // プール機能を使用する場合、「EPSCPoolMethod::AutoRelease」または「EPSCPoolMethod::ManualRelease」を指定します
     // 再生するだけなら「AutoRelease」、再生開始後にパラメータ制御を行うなら「ManualRelease」と用途によって使い分けます
     EPSCPoolMethod PoolingMethod,
     bool bAutoActivateSystem
)

// ------------------------------------------------------------------------------------------------------------------------------
// エフェクトの再生終了後に、プールへと保持される
// ------------------------------------------------------------------------------------------------------------------------------
UParticleSystemComponent::Complete()
{
    ・・・
    // AutoReleaseの場合は、完了後に自動的にプールへと保持されます
    if (PoolingMethod == EPSCPoolMethod::AutoRelease)
	{
		World->GetPSCPool().ReclaimWorldParticleSystem(this);
	}
    // ManualReleaseの場合、ReleaseToPool()を実行した後にプールへと保持されます
	else if (PoolingMethod == EPSCPoolMethod::ManualRelease_OnComplete)
	{
		PoolingMethod = EPSCPoolMethod::ManualRelease;
		World->GetPSCPool().ReclaimWorldParticleSystem(this);
	}
    ・・・
}

FWorldPSCPool::ReclaimWorldParticleSystem(UParticleSystemComponent* PSC)
{
    ・・・
    // プールはパーティクルシステムをキーとしたTMapで保持されています
    FPSCPool* PSCPool = WorldParticleSystemPools.Find(PSC->Template);	
	PSCPool->Reclaim(PSC, CurrentTime);
    ・・・
}

FPSCPool::Reclaim(UParticleSystemComponent* PSC, const float CurrentTimeSeconds)
{
    ・・・
    // 上限数未満の場合はプールで保持し、 既にプール上限数以上であれば、破棄されます
    if (GbEnableParticleSystemPooling != 0 && FreeElements.Num() < (int32)PSC->Template->MaxPoolSize)
    {
        PSC->PoolingMethod = EPSCPoolMethod::FreeInPool;
		FreeElements.Push(FPSCPoolElem(PSC, CurrentTimeSeconds));
    }
    else
    {
        PSC->PoolingMethod = EPSCPoolMethod::None;
		PSC->DestroyComponent();
    }
    ・・・
}

// ------------------------------------------------------------------------------------------------------------------------------
// // エフェクトの未使用時間が一定時間以上経っていれば、破棄します
// ------------------------------------------------------------------------------------------------------------------------------
FPSCPool::KillUnusedComponents(float KillTime, UParticleSystem* Template)
{
    ・・・
    int32 i = 0;
	while (i < FreeElements.Num())
	{
		// エフェクトの使用終了時刻から、GParticleSystemPoolKillUnusedTime（デフォルトは180秒）時間経っていたら削除
		if (FreeElements[i].LastUsedTime < KillTime)
		{
			UParticleSystemComponent* PSC = FreeElements[i].PSC;
			if (PSC)
			{
				PSC->PoolingMethod = EPSCPoolMethod::None;
				PSC->DestroyComponent();
			}

			FreeElements.RemoveAtSwap(i, 1, false);
		}
	}
    ・・・
}

// --------------------------------------------------
// パーティクルの上限数の設定方法を変更
// --------------------------------------------------
UCLASS(Abstract, MinimalAPI, BlueprintType)
class UFXSystemAsset : public UObject
{
	GENERATED_UCLASS_BODY()
public:

    // エディタからの変更を禁止
	// UPROPERTY(EditAnywhere, Category = Performance)
	uint32 MaxPoolSize;

    // その代わりにParticleTypeを用意
    // DTでParticleTypeごとに設定したプール上限数を反映するように変更
	UPROPERTY(EditAnywhere, Category = Performance)
	FName ParticleType = TEXT("Common");
    ...
};

// --------------------------------------------------
// アセットの探索
// --------------------------------------------------
{
	// 検索されたアセットの配列
	TArray AssetDatas;

	// モジュールを名前で検索して取得する
	FAssetRegistryModule& AssetRegistryModule = FModuleManager::LoadModuleChecked(FName("AssetRegistry"));
    IAssetRegistry& AssetRegistry = AssetRegistryModule.Get();

	// 検索フィルターの作成
	FARFilter Filter;
	// 全ファルダを検索するパス
	FName FilePath = TEXT("検索したいパス");
	Filter.PackagePaths.Add(FilePath);

	// 再帰的にパスを検索
	Filter.bRecursivePaths = true;
	// 検索対象のクラス
	Filter.ClassNames.Add(UParticleSystem::StaticClass()->GetFName());

	// アセットの取得
	AssetRegistry.GetAssets(Filter,AssetDatas);
}

// --------------------------------------------------
// 取得したアセットのParticleTypeを一括変更
// --------------------------------------------------
{
	// 新しいParticleTypeを取得
	FString NewType;
	TArray   PackagesToSave;
	for(int32 AssetIdx = 0; AssetIdx < AssetDatas.Num(); ++AssetIdx)
	{
		// アセットデータからパーティクルを取得
		UParticleSystem* Particle = Cast(AssetDatas[AssetIdx].GetAsset());
		if(Particle == nullptr)
		{
			continue;
		}

		// 同じタイプであれば処理しない
		if(Particle->GetFName() != *NewType)
		{
			continue;
		}

		// 指定されたParticleTypeに変更
		Particle->ParticleType = *NewType;
		Particle->MarkPackageDirty();
		
		// セーブリストに追加
		PackagesToSave.Add(AssetDatas[AssetIdx].GetPackage());
	}

	// 保存
	if(PackagesToSave.Num() > 0)
	{
		FEditorFileUtils::PromptForCheckoutAndSave(PackagesToSave,true,true);
	}
}