unreal.Text3DDefaultRenderingExtension

class unreal.Text3DDefaultRenderingExtension(outer: Object | None = None, name: Name | str = 'None')

Bases: Text3DRenderingExtensionBase

Extension that handles rendering data for Text3D

C++ Source:

  • Plugin: Text3D

  • Module: Text3D

  • File: Text3DDefaultRenderingExtension.h

Editor Properties: (see get_editor_property/set_editor_property)

  • affect_dynamic_indirect_lighting (bool): [Read-Write] Controls whether the primitive should influence indirect lighting.

  • affect_indirect_lighting_while_hidden (bool): [Read-Write] Controls whether the primitive should affect indirect lighting when hidden. This flag is only used if bAffectDynamicIndirectLighting is true.

  • cast_hidden_shadow (bool): [Read-Write] Controls whether the text glyphs should cast a shadow or not.

  • cast_shadow (bool): [Read-Write] Controls whether the text glyphs should cast a shadow or not.

  • holdout (bool): [Read-Write] If this is True, this primitive will render black with an alpha of 0, but all secondary effects (shadows, reflections, indirect lighting) remain. This feature requires activating the project setting(s) “Alpha Output”, and “Support Primitive Alpha Holdout” if using the deferred renderer.

get_affect_dynamic_indirect_lighting() → bool

Get the value of AffectDynamicIndirectLighting.

Return type:

bool

get_affect_indirect_lighting_while_hidden() → bool

Get the value of AffectIndirectLightingWhileHidden.

Return type:

bool

get_cast_hidden_shadow() → bool

Get the value of CastHiddenShadow.

Return type:

bool

get_cast_shadow() → bool

Get the value of CastShadow.

Return type:

bool

get_holdout() → bool

Get the value of Holdout.

Return type:

bool

set_affect_dynamic_indirect_lighting(value) → None

Set the value of AffectDynamicIndirectLighting.

Parameters:

value (bool)

set_affect_indirect_lighting_while_hidden(value) → None

Set the value of AffectIndirectLightingWhileHidden.

Parameters:

value (bool)

set_cast_hidden_shadow(cast_shadow) → None

Set the value of CastHiddenShadow.

Parameters:

cast_shadow (bool)

set_cast_shadow(cast_shadow) → None

Set the value of CastShadow.

Parameters:

cast_shadow (bool)

set_holdout(holdout) → None

Set the value of Holdout.

Parameters:

holdout (bool)