unreal.MaterialLibrary

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

Bases: unreal.BlueprintFunctionLibrary

Kismet Material Library

C++ Source:

• Module: Engine

• File: KismetMaterialLibrary.h

classmethod create_dynamic_material_instance(world_context_object, parent, optional_name='None', creation_flags=MIDCreationFlags.NONE) → MaterialInstanceDynamic

Creates a Dynamic Material Instance which you can modify during gameplay.

Parameters

• world_context_object (Object) –

• parent (MaterialInterface) –

• optional_name (Name) –

• creation_flags (MIDCreationFlags) –

Returns

Return type

MaterialInstanceDynamic

classmethod create_material_instance_dynamic(world_context_object, parent, optional_name='None', creation_flags=MIDCreationFlags.NONE)

deprecated: ‘create_material_instance_dynamic’ was renamed to ‘create_dynamic_material_instance’.

classmethod get_scalar_parameter_value(world_context_object, collection, parameter_name) → float

Gets a scalar parameter value from the material collection instance. Logs if ParameterName is invalid.

Parameters

• world_context_object (Object) –

• collection (MaterialParameterCollection) –

• parameter_name (Name) –

Returns

Return type

float

classmethod get_vector_parameter_value(world_context_object, collection, parameter_name) → LinearColor

Gets a vector parameter value from the material collection instance. Logs if ParameterName is invalid.

Parameters

• world_context_object (Object) –

• collection (MaterialParameterCollection) –

• parameter_name (Name) –

Returns

Return type

LinearColor

classmethod set_scalar_parameter_value(world_context_object, collection, parameter_name, parameter_value) → None

Sets a scalar parameter value on the material collection instance. Logs if ParameterName is invalid.

Parameters

• world_context_object (Object) –

• collection (MaterialParameterCollection) –

• parameter_name (Name) –

• parameter_value (float) –

classmethod set_vector_parameter_value(world_context_object, collection, parameter_name, parameter_value) → None

Sets a vector parameter value on the material collection instance. Logs if ParameterName is invalid.

Parameters

• world_context_object (Object) –

• collection (MaterialParameterCollection) –

• parameter_name (Name) –

• parameter_value (LinearColor) –