Api Sandbox Decal
class

Decal

public sealed class Decal : Component

The Decal component projects textures onto model's opaque or transparent surfaces. They inherit and modify the PBR properties of the surface they're projected on.

Constructors

Decal()

Properties

Name Type Description
Decals List<DecalDefinition>
ColorTexture Texture
NormalTexture Texture
RMOTexture Texture
LifeTime ParticleFloat How long should this decal live for?
Looped Boolean If true then the decal will repeat itself forever
Transient Boolean If true then this decal will automatically get removed when maxdecals are exceeded. This is good for things like bullect impacts, where you want to keep them around for as long as possible but also don't want to have an unlimited amount of them hanging around. Note that while the component will be destroyed, you probably want a TemporaryEffect component on the GameObject to make sure it all gets fully deleted.
Size Vector2 A 2D size of the decal in world units.
Scale ParticleFloat Scale the width and height by this value
Rotation ParticleFloat Rotation angle of the decal in degrees
Depth Single The depth of the decal in world units. This is how far the decal extends into the surface it is projected onto.
Parallax ParticleFloat Parallax depth strength of the decal
ColorTint ParticleGradient Tints the color of the decal's albedo and can be used to adjust the overall opacity of the decal.
ColorMix ParticleFloat Controls the opacity of the decal's color texture without reducing the impact of the normal or rmo texture. Set to 0 to create a normal/rmo only decal masked by the color textures alpha.
AttenuationAngle Single Attenuation angle controls how much the decal fades at an angle. At 0 it does not fade at all. Up to 1 it fades the most.
SortLayer UInt32 Determines the order the decal gets rendered in, the higher the layer the more priority it has. Decals on the same layer get automatically sorted by their GameObject ID.
SheetSequence Boolean
SequenceId UInt32 Which sequence to use
WorldBounds BBox Get the world bounds of this decal
ComponentVersion virtual Int32

Methods

static Void Upgrader_v2(JsonObject json)
static Void Upgrader_v3(JsonObject json)
Assembly: Sandbox.Engine Namespace: Sandbox Full Name: Sandbox.Decal