Table of Contents

Class BlendedOverlayTexture

Namespace
Vintagestory.API.Client
Assembly
VintagestoryAPI.dll

Defines a texture to be overlayed on another texture. Overlay textures no longer have to be of same size. Overlays are applied in reverse order, from last to first. Open in GitHub

[DocumentAsJson]
public class BlendedOverlayTexture
Inheritance
BlendedOverlayTexture

Fields

Base (Required)

The path to the texture to use as an overlay.

[DocumentAsJson("Required", "", false)]
public AssetLocation Base

Field Value

AssetLocation

Alpha (Optional) (Default: 255)

[DocumentAsJson("Optional", "255", false)]
public int Alpha

Field Value

int

AppliedTo (Optional) (Default: 0)

Index of overlay this overlay will be applied to.
Value of '0' targets base texture.
Cannot be equal or higher than index of overlay it is specified in.
Cannot target overlays with indexes '16' or higher.

[DocumentAsJson("Optional", "0", false)]
public byte AppliedTo

Field Value

byte

BlendMode (Optional) (Default: Normal)

The type of blend for each pixel.

[DocumentAsJson("Optional", "Normal", false)]
public EnumColorBlendMode BlendMode

Field Value

EnumColorBlendMode

OffsetX (Optional) (Default: 0)

Offsets texture by X axis by set amount of pixels.
Value must be between -2048 and 2047.

[DocumentAsJson("Optional", "0", false)]
public short OffsetX

Field Value

short

OffsetY (Optional) (Default: 0)

Offsets texture by Y axis by set amount of pixels.
Value must be between -2048 and 2047.

[DocumentAsJson("Optional", "0", false)]
public short OffsetY

Field Value

short