UCookCommandlet

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Classes/Commandlets/CookCommandlet.h

Include

#include "Commandlets/CookCommandlet.h"

Syntax

class UCookCommandlet : public UCommandlet

Variables

Name Description

Public variable

bool

 

bCookAll

Cook everything

Public variable

bool

 

bCookOnTheFly

Prototype cook-on-the-fly server

Public variable

bool

 

bCookSinglePackage

Only cook packages specified on commandline options (for debugging)

Public variable

bool

 

bErrorOnEngineContentUse

Error if we access engine content (useful for dlc)

Public variable

bool

 

bGenerateStreamingInstallManifests

Generate manifests for building streaming install packages

Public variable

bool

 

bIterativeCooking

If true, iterative cooking is being done

Public variable

bool

 

bPartialGC

Only clean up objects which are not in use by the cooker when we gc (false will enable full gc)

Public variable

bool

 

bSkipEditorContent

Skip saving any packages in Engine/Content/Editor* UNLESS TARGET HAS EDITORONLY DATA (in which case it will save those anyway)

Public variable

bool

 

bUnversioned

Save all cooked packages without versions.

Public variable

bool

 

bUseSerializationForGeneratingPackageDependencies

Use historical serialization system for generating package dependencies (use for historical reasons only this method has been depricated, only affects cooked manifests)

Public variable

bool

 

bVerboseCookerWarnings

Should we output additional verbose cooking warnings

Public variable

TArray< FString...

 

FullGCAssetClassNames

List of asset types that will force GC after loading them during cook

Public variable

FString

 

Params

All commandline params

Public variable

TArray< FString...

 

Switches

All commandline switches

Public variable

TArray< FString...

 

Tokens

All commandline tokens

Constructors

Name Description

Public function

UCookCommandlet

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

bool

 

CookByTheBook

(
    const TArray< ITargetPlatform*...,
    TArray< FString >& FilesInPath
)

Cooks specified list of files

Public function

bool

 

CookOnTheFly

(
    FGuid InstanceId,
    int32 Timeout,
    bool bForceClose
)

Cook on the fly routing for the commandlet

Public function Const

bool

 

HasExceededMaxMemory

(
    uint64 MaxMemoryAllowance
)

See if the cooker has exceeded max memory allowance in this case the cooker should force a garbage collection

Public function

void

 

ProcessDeferredCommands()

Process deferred commands

Overridden from UCommandlet

Name Description

Public function Virtual

int32

 

Main

(
    const FString& Params
)

Entry point for your commandlet

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback