Quartz UI ↗
Browse docs
On this page
Private preview · 0.57.0-devView Markdown

QuartzUIProjectCookStaging: declaration reference

0.57.0-dev · beta source documentation. Native, Blueprint, Editor and rendering examples are source-reviewed, not executed in Unreal during this scan. See validation and limits.

Pinned source (source: Source/QuartzUIRuntime/Public/QuartzUIProjectCookStaging.h) · integration recipe · practical guide

FQuartzUIAuditedCookFile

Internal type. One file admitted by the shared project-app audit for the active cook.

Prerequisites / integration: Installed source plugin; Editor tools additionally require a compiled compatible host Editor target. Use the QuartzUIProjectCookStaging recipe in the host module QuartzUIRuntime.

Minimal example / lifecycle: Register apps; audit; cook through the plugin hook. Cook-owned admitted file list; no loose fallback.

Avoid: Manually staging unreviewed app trees as NonUFS. This named helper is runtime-owned; inspect/use it through the owner above rather than constructing it in gameplay.

Exact source line (source: Source/QuartzUIRuntime/Public/QuartzUIProjectCookStaging.h#L8)

FQuartzUIProjectCookStaging

Internal type. Process-local handoff from the shared audit to UObject cook file emission. The registry contains only exact paths, sizes, and hashes admitted before cook.

Prerequisites / integration: Installed source plugin; Editor tools additionally require a compiled compatible host Editor target. Use the QuartzUIProjectCookStaging recipe in the host module QuartzUIRuntime.

Minimal example / lifecycle: Register apps; audit; cook through the plugin hook. Cook-owned admitted file list; no loose fallback.

Avoid: Manually staging unreviewed app trees as NonUFS. This named helper is runtime-owned; inspect/use it through the owner above rather than constructing it in gameplay.

Exact source line (source: Source/QuartzUIRuntime/Public/QuartzUIProjectCookStaging.h#L21)

Complete header

Source snapshot, not an additional example. Unreal annotations distinguish exposed Blueprint nodes from native-only/private methods.

#pragma once

#include "CoreMinimal.h"

#if WITH_EDITOR

/** One file admitted by the shared project-app audit for the active cook. */
struct QUARTZUIRUNTIME_API FQuartzUIAuditedCookFile
{
	FName AppId;
	FString AbsoluteSourcePath;
	FString AppRelativePath;
	int64 Size = 0;
	FString Sha256;
};

/**
 * Process-local handoff from the shared audit to UObject cook file emission.
 * The registry contains only exact paths, sizes, and hashes admitted before cook.
 */
class QUARTZUIRUNTIME_API FQuartzUIProjectCookStaging final
{
public:
	static void InstallAuditedFiles(TArray<FQuartzUIAuditedCookFile> Files);
	static void Reset();
	static bool TryGetAppFiles(
		FName AppId,
		TArray<FQuartzUIAuditedCookFile>& OutFiles,
		FString& OutError);
	static bool TryReadVerifiedFile(
		const FQuartzUIAuditedCookFile& File,
		TArray<uint8>& OutBytes,
		FString& OutError);
	static bool TryBuildCookedDestination(
		const TCHAR* PackageFilename,
		FName AppId,
		const FString& AppRelativePath,
		FString& OutFilename,
		FString& OutError);
};

#endif