Class AssetGraphUtility

The helper utility to execute graph and graph collection from API.

Inheritance

Object

AssetGraphUtility

Namespace: UnityEngine.AssetGraph

Syntax

public class AssetGraphUtility

Methods

ExecuteAllGraphs(List<String>, Boolean)

Executes all given graphs

Declaration

public static List<ExecuteGraphResult> ExecuteAllGraphs(List<string> graphGuids, bool sortExecuteOrder = true)

Parameters

Type	Name	Description
List<String>	graphGuids	List of graph asset's guid.
Boolean	sortExecuteOrder	Wheather to sort execute order by ExecuteOrderPriority.

Returns

Type	Description
List<ExecuteGraphResult>	collection of graph execute result.

ExecuteGraph(BuildTarget, String, Boolean, Action<NodeData, String, Single>)

Executes the graph.

Declaration

public static ExecuteGraphResult ExecuteGraph(BuildTarget target, string graphAssetPath, bool clearRecord = false, Action<NodeData, string, float> updateHandler = null)

Parameters

Type	Name	Description
BuildTarget	target	Target.
String	graphAssetPath	Graph asset path.
Boolean	clearRecord
Action<NodeData, String, Single>	updateHandler

Returns

Type	Description
ExecuteGraphResult	The graph.

ExecuteGraph(BuildTarget, ConfigGraph, Boolean, Action<NodeData, String, Single>)

Executes the graph.

Declaration

public static ExecuteGraphResult ExecuteGraph(BuildTarget target, ConfigGraph graph, bool clearRecord = false, Action<NodeData, string, float> updateHandler = null)

Parameters

Type	Name	Description
BuildTarget	target	Target.
ConfigGraph	graph	Graph.
Boolean	clearRecord
Action<NodeData, String, Single>	updateHandler

Returns

Type	Description
ExecuteGraphResult	The graph.

ExecuteGraph(String, Boolean, Action<NodeData, String, Single>)

Executes the graph.

Declaration

public static ExecuteGraphResult ExecuteGraph(string graphAssetPath, bool clearRecord = false, Action<NodeData, string, float> updateHandler = null)

Parameters

Type	Name	Description
String	graphAssetPath	Graph asset path.
Boolean	clearRecord
Action<NodeData, String, Single>	updateHandler

Returns

Type	Description
ExecuteGraphResult	The graph.

ExecuteGraph(ConfigGraph, Boolean, Action<NodeData, String, Single>)

Executes the graph.

Declaration

public static ExecuteGraphResult ExecuteGraph(ConfigGraph graph, bool clearRecord = false, Action<NodeData, string, float> updateHandler = null)

Parameters

Type	Name	Description
ConfigGraph	graph	Graph.
Boolean	clearRecord
Action<NodeData, String, Single>	updateHandler

Returns

Type	Description
ExecuteGraphResult	The graph.

ExecuteGraphByGuid(String, Boolean, Action<NodeData, String, Single>)

Executes the graph.

Declaration

public static ExecuteGraphResult ExecuteGraphByGuid(string graphGuid, bool clearRecord = false, Action<NodeData, string, float> updateHandler = null)

Parameters

Type	Name	Description
String	graphGuid	Graph asset guid.
Boolean	clearRecord
Action<NodeData, String, Single>	updateHandler

Returns

Type	Description
ExecuteGraphResult	The graph.

ExecuteGraphCollection(BuildTarget, String)

Executes the graph collection.

Declaration

public static List<ExecuteGraphResult> ExecuteGraphCollection(BuildTarget t, string collectionName)

Parameters

Type	Name	Description
BuildTarget	t	T.
String	collectionName	Collection name.

Returns

Type	Description
List<ExecuteGraphResult>	The graph collection.

ExecuteGraphCollection(BuildTarget, BatchBuildConfig.GraphCollection, Action<NodeData, String, Single>)

Executes the graph collection.

Declaration

public static List<ExecuteGraphResult> ExecuteGraphCollection(BuildTarget t, BatchBuildConfig.GraphCollection c, Action<NodeData, string, float> updateHandler = null)

Parameters

Type	Name	Description
BuildTarget	t	T.
BatchBuildConfig.GraphCollection	c	C.
Action<NodeData, String, Single>	updateHandler

Returns

Type	Description
List<ExecuteGraphResult>	The graph collection.

ExecuteGraphCollection(String)

Executes the graph collection.

Declaration

public static List<ExecuteGraphResult> ExecuteGraphCollection(string collectionName)

Parameters

Type	Name	Description
String	collectionName	Collection name.

Returns

Type	Description
List<ExecuteGraphResult>	The graph collection.

ExecuteGraphCollection(BatchBuildConfig.GraphCollection)

Executes the graph collection.

Declaration

public static List<ExecuteGraphResult> ExecuteGraphCollection(BatchBuildConfig.GraphCollection c)

Parameters

Type	Name	Description
BatchBuildConfig.GraphCollection	c	C.

Returns

Type	Description
List<ExecuteGraphResult>	The graph collection.

ExecuteGraphSetup(BuildTarget, String)

Execute Graph in Setup mode, and do not do Build.

Declaration

public static ExecuteGraphResult ExecuteGraphSetup(BuildTarget target, string graphAssetPath)

Parameters

Type	Name	Description
BuildTarget	target	Target.
String	graphAssetPath	Graph asset path.

Returns

Type	Description
ExecuteGraphResult	The graph.

ExecuteGraphSetup(BuildTarget, ConfigGraph)

Execute Graph in Setup mode, and do not do Build.

Declaration

public static ExecuteGraphResult ExecuteGraphSetup(BuildTarget target, ConfigGraph graph)

Parameters

Type	Name	Description
BuildTarget	target	Target.
ConfigGraph	graph	Graph.

Returns

Type	Description
ExecuteGraphResult	The graph.

ExecuteGraphSetup(String)

Execute Graph in Setup mode, and do not do Build.

Declaration

public static ExecuteGraphResult ExecuteGraphSetup(string graphAssetPath)

Parameters

Type	Name	Description
String	graphAssetPath	Graph asset path.

Returns

Type	Description
ExecuteGraphResult	The graph.

ExecuteGraphSetup(ConfigGraph)

Execute Graph in Setup mode, and do not do Build.

Declaration

public static ExecuteGraphResult ExecuteGraphSetup(ConfigGraph graph)

Parameters

Type	Name	Description
ConfigGraph	graph	Graph.

Returns

Type	Description
ExecuteGraphResult	The graph.

ExecuteGraphSetupByGuid(String)

Execute Graph in Setup mode, and do not do Build.

Declaration

public static ExecuteGraphResult ExecuteGraphSetupByGuid(string graphGuid)

Parameters

Type	Name	Description
String	graphGuid	Graph asset guid.

Returns

Type	Description
ExecuteGraphResult	The graph.