Graphics

10 tools. Back to the index.

get_decal_info

Read-only.

Read the full UDecalComponent state (size, sort order, fade screen size, fade-out/in timing, color, material) of a named DecalActor.

Parameter	Type	Required	Description
actor_label	string	yes	Label of the ADecalActor in the editor world.

Returns: { actor_label: string, actor_name: string, decal_size_x: float, decal_size_y: float, decal_size_z: float, sort_order: int, fade_screen_size: float, fade_start_delay: float, fade_duration: float, fade_in_start_delay: float, fade_in_duration: float, destroy_owner_after_fade: bool, r: float, g: float, b: float, a: float, decal_material: string }

set_decal_color

Destructive, idempotent.

Set DecalColor on an editor-world ADecalActor found by label; it only shows if the decal material uses a Decal Color node. A color that is not a 4-number array is ignored (current color kept). No undo, dirty flag or save; returns the resulting r, g, b, a.

Parameter	Type	Required	Description
actor_label	string	yes	Label of the ADecalActor in the editor world.
color	array	no	Array of exactly 4 numbers [r, g, b, a], a linear color such as [1, 0.5, 0, 1]; missing or another length keeps the current DecalColor.

Returns: { actor_label: string, r: float, g: float, b: float, a: float }

set_decal_destroy_owner_after_fade

Destructive, idempotent.

Toggle the bDestroyOwnerAfterFade bit on a UDecalComponent. The existing set_decal_fade cmd always passes DestroyOwnerAfterFade=true to SetFadeOut; this cmd lets callers flip it independently and read it back. Implementation: writes the FadeOut triad through SetFadeOut(start, duration, destroy) using the current FadeStartDelay/FadeDuration so the other two fields are preserved.

Parameter	Type	Required	Description
actor_label	string	yes	Label of the ADecalActor in the editor world.
destroy_owner_after_fade	boolean	no	New value for the bDestroyOwnerAfterFade bit (true = auto-destroy the actor once fully faded).

Returns: { actor_label: string, destroy_owner_after_fade: bool, fade_start_delay: float, fade_duration: float }

set_decal_fade

Destructive, idempotent.

Set a UDecalComponent's fade-out/fade-in timing fields on a named DecalActor. Writes the EditAnywhere fields directly (mirrors the details panel) so values round-trip exactly, avoiding SetFadeOut's global fade-scale CVar and SetLifeSpan side effect. Only provided fields change (partial, idempotent).

Parameter	Type	Required	Description
actor_label	string	yes	Label of the ADecalActor in the editor world.
fade_start_delay	number	no	Optional seconds before fade-out begins (FadeStartDelay; 0 + fade_duration 0 = persistent).
fade_duration	number	no	Optional fade-out duration in seconds (FadeDuration).
fade_in_start_delay	number	no	Optional seconds before fade-in begins (FadeInStartDelay).
fade_in_duration	number	no	Optional fade-in duration in seconds (FadeInDuration).
destroy_owner_after_fade	boolean	no	Optional: destroy the owning actor after fully fading out (bDestroyOwnerAfterFade).

Returns: { actor_label: string, fade_start_delay: float, fade_duration: float, fade_in_start_delay: float, fade_in_duration: float, destroy_owner_after_fade: bool, applied_count: int }

set_decal_fade_in

Destructive, idempotent.

Set the FadeInStartDelay and FadeInDuration on a UDecalComponent via UDecalComponent::SetFadeIn (the existing SetFadeOut cmd only sets the out fields; this cmd sets the in pair).

Parameter	Type	Required	Description
actor_label	string	yes	Label of the ADecalActor in the editor world.
start_delay	number	no	Time in seconds before the decal begins fading in (default 0).
duration	number	no	Time in seconds for the fade-in to complete (default 0 = no fade-in).

Returns: { actor_label: string, fade_in_start_delay: float, fade_in_duration: float }

set_decal_fade_screen_size

Destructive, idempotent.

Set the FadeScreenSize on a UDecalComponent (the screen-size fraction below which the decal fades out). The writer for the value get_decal_info already reads.

Parameter	Type	Required	Description
actor_label	string	yes	Label of the ADecalActor in the editor world.
fade_screen_size	number	yes	New FadeScreenSize (0..1; smaller fades the decal only when it gets very small on screen).

Returns: { actor_label: string, fade_screen_size: float }

set_decal_material

Destructive, idempotent.

Assign a UMaterialInterface to the UDecalComponent on a named DecalActor.

Parameter	Type	Required	Description
actor_label	string	yes	Label of the ADecalActor in the editor world.
material_path	string	yes	Content path of the UMaterialInterface.

Returns: { actor_label: string, material_path: string }

set_decal_size

Destructive, idempotent.

Set the DecalSize half-extent on a UDecalComponent parented under a DecalActor.

Parameter	Type	Required	Description
actor_label	string	yes	Label of the ADecalActor in the editor world.
decal_size	string	no	Optional [x, y, z] half-extent (overrides size_x/size_y/size_z).
size_x	number	no	Optional X half-extent.
size_y	number	no	Optional Y half-extent.
size_z	number	no	Optional Z half-extent.

Returns: { actor_label: string, size_x: float, size_y: float, size_z: float }

set_decal_sort_order

Destructive, idempotent.

Set the SortOrder int on a UDecalComponent (lower draws first within the same decal bucket).

Parameter	Type	Required	Description
actor_label	string	yes	Label of the ADecalActor in the editor world.
sort_order	number	no	New sort order value.

Returns: { actor_label: string, sort_order: int }

spawn_decal_actor

Additive.

Spawns a DecalActor into the editor world. If material_path loads as a UMaterialInterface it is assigned to the UDecalComponent (SetDecalMaterial). Size may be a uniform number or an [x, y, z] half-extent applied to DecalSize (read back).

Parameter	Type	Required	Description
actor_label	string	yes	Label for the spawned (or re-used) ADecalActor.
location	string	no	Optional [x, y, z] world location (default 0,0,0).
rotation	array	no	Optional [pitch, yaw, roll] world rotation.
decal_size	string	no	Optional [x, y, z] half-extent for DecalSize (default 128,256,256).
material_path	string	no	Optional content path of a UMaterialInterface to assign to the decal.

Returns: { actor_label: string, actor_name: string, reused: bool, decal_size_x: float, decal_size_y: float, decal_size_z: float, decal_material: string }