unreal.CompileParams

class unreal.CompileParams(skip_if_compiled: bool = False, skip_if_not_out_of_date: bool = False, gather_references: bool = False, async_: bool = False, compile_only_selected_instance: CustomizableObjectInstance = Ellipsis, optimization_level: CustomizableObjectOptimizationLevel = Ellipsis, texture_compression: CustomizableObjectTextureCompression = Ellipsis, callback: CompileDelegate = Ellipsis)

Bases: StructBase

Compile Params

C++ Source:

  • Plugin: Mutable

  • Module: CustomizableObject

  • File: CustomizableObject.h

Editor Properties: (see get_editor_property/set_editor_property)

  • async_ (bool): [Read-Write] If true, compile the Customizable Object asynchronously. If synchronously and the Customizable Object is not ready the compilation will fail.

  • callback (CompileDelegate): [Read-Write] Called once the compilation request has finished (successfully or not).

  • compile_only_selected_instance (CustomizableObjectInstance): [Read-Write] If assigned, compile the Customizable Object only the selected parameter of the given Instance.

  • gather_references (bool): [Read-Write] Gathers all asset references used in this Customizable Object. Marks the object as modified.

  • optimization_level (CustomizableObjectOptimizationLevel): [Read-Write]

  • skip_if_compiled (bool): [Read-Write] If true, skip the compilation if the Customizable Object is already compiled.

  • skip_if_not_out_of_date (bool): [Read-Write] If true, skip the compilation if the Customizable Object or its contents are not out of date (child Customizable Objects, Data Tables, referenced Materials…).

  • texture_compression (CustomizableObjectTextureCompression): [Read-Write]

property async_: bool

[Read-Write] If true, compile the Customizable Object asynchronously. If synchronously and the Customizable Object is not ready the compilation will fail.

Type:

(bool)

property b_gather_referneces: bool

‘b_gather_referneces’ was renamed to ‘gather_references’.

Type:

deprecated

property b_skip_if_out_of_date: bool

‘b_skip_if_out_of_date’ was renamed to ‘skip_if_not_out_of_date’.

Type:

deprecated

property callback: CompileDelegate

[Read-Write] Called once the compilation request has finished (successfully or not).

Type:

(CompileDelegate)

property compile_only_selected_instance: CustomizableObjectInstance

[Read-Write] If assigned, compile the Customizable Object only the selected parameter of the given Instance.

Type:

(CustomizableObjectInstance)

property gather_references: bool

[Read-Write] Gathers all asset references used in this Customizable Object. Marks the object as modified.

Type:

(bool)

property optimization_level: CustomizableObjectOptimizationLevel

[Read-Write]

Type:

(CustomizableObjectOptimizationLevel)

property skip_if_compiled: bool

[Read-Write] If true, skip the compilation if the Customizable Object is already compiled.

Type:

(bool)

property skip_if_not_out_of_date: bool

[Read-Write] If true, skip the compilation if the Customizable Object or its contents are not out of date (child Customizable Objects, Data Tables, referenced Materials…).

Type:

(bool)

property texture_compression: CustomizableObjectTextureCompression

[Read-Write]

Type:

(CustomizableObjectTextureCompression)