Class DecalComponent
A material that is rendered onto the surface of a mesh.
Inherited Members
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class DecalComponent : SceneComponentRemarks
A kind of 'bumper sticker' for a model.
@see https://docs.unrealengine.com/latest/INT/Engine/Actors/DecalActor @see UDecalActor
Properties
| Improve this Doc View SourcebDestroyOwnerAfterFade
Declaration
public bool bDestroyOwnerAfterFade { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
DecalMaterial
Decal material.
Declaration
public MaterialInterface DecalMaterial { get; }Property Value
| Type | Description |
|---|---|
| MaterialInterface |
DecalSize
Decal size in local space (does not include the component scale), technically redundant but there for convenience
Declaration
public Vector DecalSize { get; }Property Value
| Type | Description |
|---|---|
| Vector |
DefaultObject
Get UE4 Default Object for this Class
Declaration
public static DecalComponent DefaultObject { get; }Property Value
| Type | Description |
|---|---|
| DecalComponent |
FadeDuration
Time in seconds for the decal to fade out. Set fade duration and start delay to 0 to make persistent. Only fades in active simulation or game.
Declaration
public float FadeDuration { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
FadeInDuration
Fade in Duration
Declaration
public float FadeInDuration { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
FadeInStartDelay
Fade in Start Delay
Declaration
public float FadeInStartDelay { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
FadeScreenSize
Fade Screen Size
Declaration
public float FadeScreenSize { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
FadeStartDelay
Time in seconds to wait before beginning to fade out the decal. Set fade duration and start delay to 0 to make persistent.
Declaration
public float FadeStartDelay { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
SortOrder
Controls the order in which decal elements are rendered.
Declaration
public int SortOrder { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Remarks
Higher values draw later (on top). Setting many different sort orders on many different decals prevents sorting by state and can reduce performance.
StaticClass
Get UE4 Class
Declaration
public static Class StaticClass { get; }Property Value
| Type | Description |
|---|---|
| Class |
Methods
| Improve this Doc View SourceCreateDynamicMaterialInstance()
Utility to allocate a new Dynamic Material Instance, set its parent to the currently applied material, and assign it
Declaration
public MaterialInstanceDynamic CreateDynamicMaterialInstance()Returns
| Type | Description |
|---|---|
| MaterialInstanceDynamic |
GetDecalMaterial()
Accessor for decal material
Declaration
public MaterialInterface GetDecalMaterial()Returns
| Type | Description |
|---|---|
| MaterialInterface |
GetFadeDuration()
Get Fade Duration
Declaration
public float GetFadeDuration()Returns
| Type | Description |
|---|---|
| System.Single |
GetFadeInDuration()
Get Fade in Duration
Declaration
public float GetFadeInDuration()Returns
| Type | Description |
|---|---|
| System.Single |
GetFadeInStartDelay()
Get Fade in Start Delay
Declaration
public float GetFadeInStartDelay()Returns
| Type | Description |
|---|---|
| System.Single |
GetFadeStartDelay()
Get Fade Start Delay
Declaration
public float GetFadeStartDelay()Returns
| Type | Description |
|---|---|
| System.Single |
New(UObject, Name)
Spawn an object of this class
Declaration
public static DecalComponent New(UObject obj = null, Name name = default(Name))Parameters
| Type | Name | Description |
|---|---|---|
| UObject | obj | |
| Name | name |
Returns
| Type | Description |
|---|---|
| DecalComponent |
SetDecalMaterial(MaterialInterface)
setting decal material on decal component. This will force the decal to reattach
Declaration
public void SetDecalMaterial(MaterialInterface NewDecalMaterial)Parameters
| Type | Name | Description |
|---|---|---|
| MaterialInterface | NewDecalMaterial |
SetFadeIn(Single, Single)
Set Fade In
Declaration
public void SetFadeIn(float StartDelay, float Duaration)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | StartDelay | |
| System.Single | Duaration |
SetFadeOut(Single, Single, Boolean)
Sets the decal's fade start time, duration and if the owning actor should be destroyed after the decal is fully faded out.
Declaration
public void SetFadeOut(float StartDelay, float Duration, bool DestroyOwnerAfterFade)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | StartDelay | |
| System.Single | Duration | |
| System.Boolean | DestroyOwnerAfterFade |
Remarks
The default value of 0 for FadeStartDelay and FadeDuration makes the decal persistent. See DecalLifetimeOpacity material node to control the look of "fading out."
@param StartDelay - Time in seconds to wait before beginning to fade out the decal. @param Duration - Time in second for the decal to fade out. @param DestroyOwnerAfterFade - Should the owning actor automatically be destroyed after it is completely faded out.
SetFadeScreenSize(Single)
Set the FadeScreenSize for this decal component
Declaration
public void SetFadeScreenSize(float NewFadeScreenSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | NewFadeScreenSize |
SetSortOrder(Int32)
Sets the sort order for the decal component. Higher values draw later (on top). This will force the decal to reattach
Declaration
public void SetSortOrder(int Value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | Value |
Operators
| Improve this Doc View SourceImplicit(IntPtr to DecalComponent)
Convert from IntPtr to UObject
Declaration
public static implicit operator DecalComponent(IntPtr p)Parameters
| Type | Name | Description |
|---|---|---|
| System.IntPtr | p |
Returns
| Type | Description |
|---|---|
| DecalComponent |