unreal.MaterialInstanceConstant

class unreal.MaterialInstanceConstant(outer=None, name='None')

Bases: unreal.MaterialInstance

Material Instances may be used to change the appearance of a material without incurring an expensive recompilation of the material. General modification of the material cannot be supported without recompilation, so the instances are limited to changing the values of predefined material parameters. The parameters are statically defined in the compiled material by a unique name, type and default value.

C++ Source:

  • Module: Engine

  • File: MaterialInstanceConstant.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_import_data (AssetImportData): [Read-Write] Importing data and options used for this material

  • asset_user_data (Array(AssetUserData)): [Read-Write] Array of user data stored with the asset

  • base_property_overrides (MaterialInstanceBasePropertyOverrides): [Read-Write] Base Property Overrides

  • font_parameter_values (Array(FontParameterValue)): [Read-Write] Font parameters.

  • lightmass_settings (LightmassMaterialInterfaceSettings): [Read-Write] The Lightmass settings for this object.

  • override_subsurface_profile (bool): [Read-Write] Defines if SubsurfaceProfile from this instance is used or it uses the parent one.

  • parent (MaterialInterface): [Read-Write] Parent material.

  • phys_material (PhysicalMaterial): [Read-Write] Physical material to use for this graphics material. Used for sounds, effects etc.

  • phys_material_mask (PhysicalMaterialMask): [Read-Write] Physical material mask to use for this graphics material. Used for sounds, effects etc.

  • physical_material_map (PhysicalMaterial): [Read-Write] Physical material map used with physical material mask, when it exists.

  • preview_mesh (SoftObjectPath): [Read-Write] The mesh used by the material editor to preview the material.

  • runtime_virtual_texture_parameter_values (Array(RuntimeVirtualTextureParameterValue)): [Read-Write] RuntimeVirtualTexture parameters.

  • scalar_parameter_values (Array(ScalarParameterValue)): [Read-Write] Scalar parameters.

  • subsurface_profile (SubsurfaceProfile): [Read-Write] SubsurfaceProfile, for Screen Space Subsurface Scattering

  • texture_parameter_values (Array(TextureParameterValue)): [Read-Write] Texture parameters.

  • thumbnail_info (ThumbnailInfo): [Read-Only] Information for thumbnail rendering

  • vector_parameter_values (Array(VectorParameterValue)): [Read-Write] Vector parameters.

get_scalar_parameter_value(parameter_name) → float

Get the scalar (float) parameter value from an MIC

Parameters

parameter_name (Name) –

Returns

Return type

float

get_texture_parameter_value(parameter_name) → Texture

Get the MIC texture parameter value

Parameters

parameter_name (Name) –

Returns

Return type

Texture

get_vector_parameter_value(parameter_name) → LinearColor

Get the MIC vector parameter value

Parameters

parameter_name (Name) –

Returns

Return type

LinearColor