Interface IBorderStyle

A border style will draw a border around an entity. It can draw both behind and in front of the entity.

There are several borders that come built in:

1. A solid color border (use SolidColor(Color, Single, Boolean)): allows to set a color, line width and optional rounded corners.
2. A gradient color border (use ): allows to set 4 colors for the 4 corners which will be interpolated across, a line width and optional rounded corners.
3. A 9-slice image border (use AGSSlicedImageBorder): this allows you to use an image, slice it to 9 pieces, and spread it in various ways to create a border. The 9-slice image border is heavily inspired by the border image used by CSS, so you can look at an example in CSS, to see what can be done with a 9-slice image: https://css-tricks.com/almanac/properties/b/border-image/

You can also implement your own custom border style by implementing this interface, which can then be used for all objects.

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IBorderStyle

Properties

WidthBottom

Gets the bottom edge width of the border.

Declaration

float WidthBottom { get; }

Property Value

Type	Description
System.Single	The bottom width.

WidthLeft

Gets the left edge width of the border.

Declaration

float WidthLeft { get; }

Property Value

Type	Description
System.Single	The left width.

WidthRight

Gets the right edge width of the border.

Declaration

float WidthRight { get; }

Property Value

Type	Description
System.Single	The right width.

WidthTop

Gets the top edge width of the border.

Declaration

float WidthTop { get; }

Property Value

Type	Description
System.Single	The top width.

Methods

RenderBorderBack(AGSBoundingBox)

Renders border graphics which will appear behind the entity. This is called on every game tick.

Declaration

void RenderBorderBack(AGSBoundingBox square)

Parameters

Type	Name	Description
AGSBoundingBox	square	Square.

RenderBorderFront(AGSBoundingBox)

Renders border graphics which will appear in front of the entity. This is called on every game tick.

Declaration

void RenderBorderFront(AGSBoundingBox square)

Parameters

Type	Name	Description
AGSBoundingBox	square	Square.