Class CookingData

Game cooking temporary data.

CookingData

Inherited Members

ScriptingObject::_gcHandle

ScriptingObject::_id

ScriptingObject::_type

ScriptingObject::CanCast(const ScriptingTypeHandle& from, const ScriptingTypeHandle& to)

ScriptingObject::CanCast(const MClass* from, const MClass* to)

ScriptingObject::Cast(ScriptingObject* obj)

ScriptingObject::ChangeID(const Guid& newId)

ScriptingObject::CreateManaged()

ScriptingObject::CreateManagedInternal()

ScriptingObject::Deleted

Object::DeleteObject(float timeToLive = 0.0f, bool useGameTime=false)

Object::DeleteObjectNow()

ScriptingObject::DestroyManaged()

Object::Flags

ScriptingObject::FromInterface(void* interfaceObj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::FromInterface(T* interfaceObj)

ScriptingObject::GetClass()

ScriptingObject::GetID()

ScriptingObject::GetManagedInstance()

ScriptingObject::GetOrCreateManagedInstance()

ScriptingObject::GetType()

ScriptingObject::GetTypeHandle()

ScriptingObject::HasManagedInstance()

ScriptingObject::Is(const ScriptingTypeHandle& type)

ScriptingObject::Is(const MClass* type)

ScriptingObject::Is()

ScriptingObject::IsRegistered()

ScriptingObject::NewObject(const ScriptingTypeHandle& typeHandle)

ScriptingObject::NewObject()

ScriptingObject::OnDeleteObject()

ScriptingObject::OnManagedInstanceDeleted()

ScriptingObject::OnScriptingDispose()

ScriptingObject::RegisterObject()

ScriptingObject::ScriptingObject(const SpawnParams& params)

ScriptingObject::SetManagedInstance(MObject* instance)

CookingData

ScriptingObject::ToInterface(ScriptingObject* obj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::ToInterface(ScriptingObject* obj)

ScriptingObject::ToManaged(const ScriptingObject* obj)

ScriptingObject::ToNative(MObject* obj)

ScriptingObject::ToString()

ScriptingObject::UnregisterObject()

Object::~Object()

ScriptingObject::~ScriptingObject()

Assembly: FlaxEngine.dll

File: Editor/Cooker/CookingData.h

Syntax

public class CookingData : public ScriptingObject

Fields

Assets

The final assets collection to include in build (valid only after CollectAssetsStep).

Declaration

public HashSet<Guid> Assets

Field Value

HashSet<Guid>

BinaryModules

The binary modules used in the build. Valid after scripts compilation step. This list includes game, all plugins modules and engine module.

Declaration

public Array<BinaryModuleInfo, InlinedAllocation<64>> BinaryModules

Field Value

Array<BinaryModuleInfo, InlinedAllocation<64>>

CacheDirectory

The temporary directory used for the building cache. Can be used for the incremental building.

Declaration

public String CacheDirectory

Field Value

String

Configuration

The configuration.

Declaration

public BuildConfiguration Configuration

Field Value

BuildConfiguration

CurrentStepIndex

The current step index.

Declaration

public int32 CurrentStepIndex

Field Value

int32

CustomDefines

The list of custom defines passed to the build tool when compiling project scripts. Can be used in build scripts for configuration (Configuration.CustomDefines).

Declaration

public Array<String> CustomDefines

Field Value

Array<String>

DataOutputPath

The output path for data files (Content, Dotnet, Mono, etc.).

Declaration

public String DataOutputPath

Field Value

String

Files

The final files collection to include in build (valid only after CollectAssetsStep).

Declaration

public HashSet<String> Files

Field Value

HashSet<String>

ManagedCodeOutputPath

The output path for binaries (C# code libraries).

Declaration

public String ManagedCodeOutputPath

Field Value

String

NativeCodeOutputPath

The output path for binaries (native executable and native code libraries).

Declaration

public String NativeCodeOutputPath

Field Value

String

Options

The options.

Declaration

public BuildOptions Options

Field Value

BuildOptions

OriginalOutputPath

The original output path (actual OutputPath could be modified by the Platform Tools or a plugin for additional layout customizations or packaging). This path is preserved.

Declaration

public String OriginalOutputPath

Field Value

String

Platform

The platform.

Declaration

public BuildPlatform Platform

Field Value

BuildPlatform

Preset

The name of build preset used for cooking (can be used by editor and game plugins).

Declaration

public String Preset

Field Value

String

PresetTarget

The name of build preset target used for cooking (can be used by editor and game plugins).

Declaration

public String PresetTarget

Field Value

String

RootAssets

The root assets collection to include in build in the first place (can be used only before CollectAssetsStep). Game cooker will find dependant assets and deploy them as well.

Declaration

public HashSet<Guid> RootAssets

Field Value

HashSet<Guid>

Stats

The build stats.

Declaration

public Statistics Stats

Field Value

Statistics

StepsCount

The total amount of baking steps to perform.

Declaration

public int32 StepsCount

Field Value

int32

Tools

The platform tools.

Declaration

public PlatformTools* Tools

Field Value

PlatformTools

Methods

AddRootAsset(const Guid& id)

Adds the asset to the build.

Declaration

public void AddRootAsset(const Guid& id)

Parameters

Guid id

The asset id.

AddRootAsset(const String& path)

Adds the asset to the build.

Declaration

public void AddRootAsset(const String& path)

Parameters

String path

The absolute asset path.

AddRootEngineAsset(const String& internalPath)

Adds the internal engine asset to the build.

Declaration

public void AddRootEngineAsset(const String& internalPath)

Parameters

String internalPath

The internal path (relative to the engine content path).

Error(const Char* msg)

Declaration

public void Error(const Char* msg)

Parameters

Char msg

Error(const String& msg)

Declaration

public void Error(const String& msg)

Parameters

String msg

Error(const StringView& msg)

Declaration

public void Error(const StringView& msg)

Parameters

StringView msg

GetBuildPlatformName(const Char& platform, const Char& architecture)

Gets the name of the platform and architecture for the current BuildPlatform.

Declaration

public void GetBuildPlatformName(const Char*& platform, const Char*& architecture) const

Parameters

Char platform

Char architecture

GetGameBinariesPath()

Gets the absolute path to the Platform Data folder that contains the binary files used by the current build configuration.

Declaration

public String GetGameBinariesPath() const

Returns

String

GetPlatformBinariesRoot()

Gets the absolute path to the platform folder that contains the dependency files used by the current build configuration.

Declaration

public String GetPlatformBinariesRoot() const

Returns

String

InitProgress(const int32 stepsCount)

Initializes the progress.

Declaration

public void InitProgress(const int32 stepsCount)

Parameters

int32 stepsCount

The total steps count.

NextStep()

Moves the progress reporting to the next step

Declaration

public void NextStep()

StepProgress(const String& info, const float stepProgress)

Reports the current step progress (normalized 0-1 value)

Declaration

public void StepProgress(const String& info, const float stepProgress) const

Parameters

String info

The step info message.

float stepProgress

The step progress.