UE::Cook Namespace Reference

Classes
struct	FCookOnTheFlyHostOptions
class	FCookOnTheFlyMessage
struct	FCookOnTheFlyMessageHeader
class	FCookOnTheFlyRequest
class	FCookOnTheFlyResponse
class	ICookOnTheFlyModule
class	ICookOnTheFlyServerConnection

Enumerations
enum class	ECookOnTheFlyMessage : uint32 {   None = 0x00 , Request = 0x02 , Response = 0x04 , TypeFlags = 0x0F ,   CookPackage = 0x20 , GetCookedPackages = 0x30 , RecompileShaders = 0x40 , PackagesCooked = 0x50 ,   FilesAdded = 0x60 , RecookPackages = 0x70 , NetworkPlatformFile = 0x80 , GetAllOnDiskPackages = 0x90 }
enum class	ECookOnTheFlyMessageStatus : uint32 { None , Ok , Error }
enum class	ECookType { Unknown , OnTheFly , ByTheBook }
enum class	ECookingDLC { Unknown , Yes , No }
enum class	EProcessType { SingleProcess , Director , Worker , AllMPCook }
enum class	ECookResult : uint8 {   NotAttempted , Succeeded , Failed , NeverCookPlaceholder ,   Invalid , Count , NumBits = FPlatformMath::ConstExprCeilLogTwo(ECookResult::Count) }
enum class	ECookValidationOptions { None = 0 , RunAssetValidation = 1<<0 , RunMapValidation = 1<<1 , ValidationErrorsAreFatal = 1<<2 }

Functions
	ENUM_CLASS_FLAGS (ECookOnTheFlyMessage)
const TCHAR *	LexToString (ECookOnTheFlyMessage Message)
const TCHAR *	LexToString (ECookOnTheFlyMessageStatus Status)
FArchive &	operator<< (FArchive &Ar, FCookOnTheFlyMessageHeader &Header)
FArchive &	operator<< (FArchive &Ar, FCookOnTheFlyMessage &Message)
	ENUM_CLASS_FLAGS (ECookValidationOptions)

Enumeration Type Documentation

ECookingDLC

enum class UE::Cook::ECookingDLC

strong

Enumerator
Unknown
Yes
No

ECookOnTheFlyMessage

enum class UE::Cook::ECookOnTheFlyMessage : uint32

strong

Flags and message types to be used with the cook-on-the-fly server.

The first 8 bits specifies the message type, i.e request, response or a on-way message.

Enumerator
None
Request
Response
TypeFlags
CookPackage
GetCookedPackages
RecompileShaders
PackagesCooked
FilesAdded
RecookPackages
NetworkPlatformFile
GetAllOnDiskPackages

ECookOnTheFlyMessageStatus

enum class UE::Cook::ECookOnTheFlyMessageStatus : uint32

strong

Cook-on-the-fly message status.

Enumerator
None	No status.
Ok	The message is successful.
Error	The message failed.

ECookResult

enum class UE::Cook::ECookResult : uint8

strong

Enumerator
NotAttempted
Succeeded
Failed
NeverCookPlaceholder	The package is a NeverCook package that needs to be added to cookresults for dependency tracking.
Invalid	No information for this platform (used in CookWorker replication)
Count
NumBits

ECookType

enum class UE::Cook::ECookType

strong

Enumerator
Unknown
OnTheFly
ByTheBook

ECookValidationOptions

enum class UE::Cook::ECookValidationOptions

strong

Validation options used when cooking (

See also

ECookByTheBookOptions for the validation flags used when initializing the cooker)

Enumerator
None	No flags
RunAssetValidation	Run asset validation (EditorValidatorSubsystem) on assets loaded during cook
RunMapValidation	Run map validation (MapCheck) on maps loaded during cook
ValidationErrorsAreFatal	Consider validation errors (from RunAssetValidation or RunMapValidation) as fatal (preventing the package from being cooked)

EProcessType

enum class UE::Cook::EProcessType

strong

The cookcommandlet can run in MPCook mode, where it creates worker processes to use more parallelism and reduce wall time of the cook. This enum is reported or received by some API functions on the cooker, and describes whether the current process the cooker and caller are in is the MPCook director, or an MPCook worker, or a cooker running as a singleprocess without MPCook.

Enumerator
SingleProcess
Director
Worker
AllMPCook	Used only when passed as a filter: matches either Director or Worker.

Function Documentation

ENUM_CLASS_FLAGS() [1/2]

UE::Cook::ENUM_CLASS_FLAGS

(

ECookOnTheFlyMessage

)

ENUM_CLASS_FLAGS() [2/2]

UE::Cook::ENUM_CLASS_FLAGS

(

ECookValidationOptions

)

LexToString() [1/2]

const TCHAR * UE::Cook::LexToString ( ECookOnTheFlyMessage  Message )

inline

Returns a string from the specified message.

LexToString() [2/2]

const TCHAR * UE::Cook::LexToString ( ECookOnTheFlyMessageStatus  Status )

inline

Returns a string from the specified message status.

operator<<() [1/2]

FArchive & UE::Cook::operator<<	(	FArchive &	Ar,
		FCookOnTheFlyMessage &	Message
	)

operator<<() [2/2]

FArchive & UE::Cook::operator<<	(	FArchive &	Ar,
		FCookOnTheFlyMessageHeader &	Header
	)