Class SceneDataWriteOperation

Explicit implementation for writing a scene serialized file that can be used with the player data systems.

Inheritance

object

SceneDataWriteOperation

Implements

IWriteOperation

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEditor.Build.Pipeline.WriteTypes

Assembly: Unity.ScriptableBuildPipeline.Editor.dll

Syntax

[Serializable]
public class SceneDataWriteOperation : IWriteOperation

Properties

Command

The specific write command containing the details about what to write to disk. WriteCommand

Declaration

public WriteCommand Command { get; set; }

Property Value

Type	Description
WriteCommand

DependencyHash

The hash that represents the unique set of input dependencies for caching this write command.

Declaration

public Hash128 DependencyHash { get; set; }

Property Value

Type	Description
Hash128

PreloadInfo

Information needed for scene preloadeding. PreloadInfo

Declaration

public PreloadInfo PreloadInfo { get; set; }

Property Value

Type	Description
PreloadInfo

ProcessedScene

Processed scene path returned by the ProcessScene API. PrepareScene(string, BuildSettings, BuildUsageTagSet, string)

Declaration

[Obsolete("ProcessedScene has been deprecated.")]
public string ProcessedScene { get; set; }

Property Value

Type	Description
string

ReferenceMap

The specific reference data for objects in the write command. BuildReferenceMap

Declaration

public BuildReferenceMap ReferenceMap { get; set; }

Property Value

Type	Description
BuildReferenceMap

Scene

Source scene asset path

Declaration

public string Scene { get; set; }

Property Value

Type	Description
string

UsageSet

The specific usage data for objects in the write command. BuildUsageTagSet

Declaration

public BuildUsageTagSet UsageSet { get; set; }

Property Value

Type	Description
BuildUsageTagSet

Methods

GetHash128()

Optimized hash function for use with the Build Cache system.

Declaration

public Hash128 GetHash128()

Returns

Type	Description
Hash128	Unique hash for the contents of this write operation.

GetHash128(IBuildLogger)

Optimized hash function for use with the Build Cache system.

Declaration

public Hash128 GetHash128(IBuildLogger log)

Parameters

Type	Name	Description
IBuildLogger	log	The build log.

Returns

Type	Description
Hash128	Unique hash for the contents of this write operation.

Write(string, BuildSettings, BuildUsageTagGlobal)

Write function that wraps the low level WriteSerializeFile APIs that takes the common minimum set of parameters.

Declaration

public WriteResult Write(string outputFolder, BuildSettings settings, BuildUsageTagGlobal globalUsage)

Parameters

Type	Name	Description
string	outputFolder	The location to write data to disk.
BuildSettings	settings	The build settings to use for writing data.
BuildUsageTagGlobal	globalUsage	The global usage to use for writing data.

Returns

Type	Description
WriteResult	The write results struct containing details about what was written to disk

Implements

IWriteOperation