Class Renderer

Core system for draw artwork on screen for current frame

Fields

MainSheet

Instance of main/default artwork sheet

Declaration

public static readonly Sheet MainSheet

Properties

AltSheetCount

Total alt sheet count

Declaration

public static int AltSheetCount { get; }

CameraRange

Local range for the actual range for content on screen (black bar appears when window too wide)

Declaration

public static FRect CameraRange { get; }

CameraRect

Current rect position in global space for rendering the screen

Declaration

public static IRect CameraRect { get; }

CurrentFontIndex

Index of current using font

Declaration

public static int CurrentFontIndex { get; }

CurrentLayerIndex

Index of current using rendering layer

Declaration

public static int CurrentLayerIndex { get; }

CurrentSheet

Instance of current using artwork sheet

Declaration

public static Sheet CurrentSheet { get; }

CurrentSheetIndex

Index of current using artwork sheet

Declaration

public static int CurrentSheetIndex { get; set; }

IsReady

True if the system is ready to use

Declaration

public static bool IsReady { get; }

LayerCount

Total rendering layer count

Declaration

public static int LayerCount { get; }

ScreenRenderRect

Rendering rect position in screen position

Declaration

public static IRect ScreenRenderRect { get; }

Methods

AbandonLayerSort(int)

Do not sort the unsorted cells inside this layer

Declaration

public static void AbandonLayerSort(int layerIndex)

Parameters

Type	Name	Description
int	layerIndex	Use RenderLayer.XXX to get this value

AddAltSheet(Sheet)

Add alt sheet into the system

Declaration

public static int AddAltSheet(Sheet sheet)

Returns

Type	Description
int	Index of the added alt sheet

ClampCells(Cell[], IRect, int, int)

Clamp cells inside rect range

Declaration

public static void ClampCells(Cell[] cells, IRect rect, int startIndex = 0, int endIndex = -1)

IRect rect

Target range in global space

int endIndex

(excluded)

ClampCells(IRect, int, int)

Clamp cells in using layer inside rect range

Declaration

public static void ClampCells(IRect rect, int startIndex, int endIndex = -1)

Parameters

Type	Name	Description
IRect	rect	Target range in global space
int	endIndex	(excluded)

ClampCells(int, IRect, int, int)

Clamp cells for given layer inside rect range

Declaration

public static void ClampCells(int layerIndex, IRect rect, int startIndex, int endIndex = -1)

Parameters

Type	Name	Description
int	layerIndex	Use RenderLayer.XXX to get this value
IRect	rect	Target range in global space
int	endIndex	(excluded)

ClearCharSpritePool()

Reset internal pool for rendering character and unload the textures for them

Declaration

public static void ClearCharSpritePool()

ClearFontIndexIdMap()

Reset internal cache for font id with index

Declaration

public static void ClearFontIndexIdMap()

Draw(AngeSprite, IRect, Color32, int)

Draw a artwork sprite into using render layer

Declaration

public static Cell Draw(AngeSprite sprite, IRect rect, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
AngeSprite	sprite	Artwork sprite
IRect	rect	Rect position in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

Draw(AngeSprite, IRect, int)

Draw a artwork sprite into using render layer

Declaration

public static Cell Draw(AngeSprite sprite, IRect rect, int z = -2147483648)

Parameters

Type	Name	Description
AngeSprite	sprite	Artwork sprite
IRect	rect	Rect position in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

Draw(AngeSprite, int, int, int, int, int, int, int, Color32, int, bool)

Draw a artwork sprite into using render layer

Declaration

public static Cell Draw(AngeSprite sprite, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, Color32 color, int z = -2147483648, bool ignoreAttach = false)

Parameters

Type	Name	Description
AngeSprite	sprite	Artwork sprite
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells
bool	ignoreAttach	True if do not draw attaching sprite

Returns

Type	Description
Cell	Rendering cell for this sprite

Draw(AngeSprite, int, int, int, int, int, int, int, int)

Draw a artwork sprite into using render layer

Declaration

public static Cell Draw(AngeSprite sprite, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int z = -2147483648)

Parameters

Type	Name	Description
AngeSprite	sprite	Artwork sprite
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

Draw(SpriteCode, IRect, Color32, int)

Draw a artwork sprite into using render layer

Declaration

public static Cell Draw(SpriteCode globalID, IRect rect, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
SpriteCode	globalID	Artwork sprite ID
IRect	rect	Rect position in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

Draw(SpriteCode, IRect, int)

Draw a artwork sprite into using render layer

Declaration

public static Cell Draw(SpriteCode globalID, IRect rect, int z = -2147483648)

Parameters

Type	Name	Description
SpriteCode	globalID	Artwork sprite ID
IRect	rect	Rect position in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

Draw(SpriteCode, int, int, int, int, int, int, int, Color32, int)

Draw a artwork sprite into using render layer

Declaration

public static Cell Draw(SpriteCode globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
SpriteCode	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

Draw(SpriteCode, int, int, int, int, int, int, int, int)

Draw a artwork sprite into using render layer

Declaration

public static Cell Draw(SpriteCode globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int z = -2147483648)

Parameters

Type	Name	Description
SpriteCode	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

Draw(int, IRect, Color32, int)

Draw a artwork sprite into using render layer

Declaration

public static Cell Draw(int globalID, IRect rect, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
int	globalID	Artwork sprite ID
IRect	rect	Rect position in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

Draw(int, IRect, int)

Draw a artwork sprite into using render layer

Declaration

public static Cell Draw(int globalID, IRect rect, int z = -2147483648)

Parameters

Type	Name	Description
int	globalID	Artwork sprite ID
IRect	rect	Rect position in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

Draw(int, int, int, int, int, int, int, int, Color32, int)

Draw a artwork sprite into using render layer

Declaration

public static Cell Draw(int globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
int	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

Draw(int, int, int, int, int, int, int, int, int)

Draw a artwork sprite into using render layer

Declaration

public static Cell Draw(int globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int z = -2147483648)

Parameters

Type	Name	Description
int	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

DrawAnimation(SpriteGroup, int, int, int, int, int, int, int, int, int)

Draw the given animation into using render layer

Declaration

public static Cell DrawAnimation(SpriteGroup group, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int frame, int z = -2147483648)

int x

Position in global space

int y

Position in global space

int pivotX

0 means "x" align with left edge. 1000 means "x" align with right edge.

int pivotY

0 means "y" align with bottom edge. 1000 means "y" align with top edge.

int rotation

Rotation in degree. 90 means facing right.

int width

Size in global space

int height

Size in global space

int frame

Animation frame

int z

Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

DrawAnimation(int, int, int, int, int, int, int, int, int, int)

Draw the given animation into using render layer

Declaration

public static Cell DrawAnimation(int chainID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int frame, int z = -2147483648)

int x

Position in global space

int y

Position in global space

int pivotX

0 means "x" align with left edge. 1000 means "x" align with right edge.

int pivotY

0 means "y" align with bottom edge. 1000 means "y" align with top edge.

int rotation

Rotation in degree. 90 means facing right.

int width

Size in global space

int height

Size in global space

int frame

Animation frame

int z

Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

DrawChar(CharSprite, int, int, int, int, Color32)

Draw a text character into using render layer

Declaration

public static Cell DrawChar(CharSprite sprite, int x, int y, int width, int height, Color32 color)

int x

Position in global space

int y

Position in global space

int width

Size in global space

int height

Size in global space

Color32 color

Color tint

Returns

Type	Description
Cell	Rendering cell for this text character

DrawChar(char, int, int, int, int, Color32)

Draw a text character into using render layer

Declaration

public static Cell DrawChar(char c, int x, int y, int width, int height, Color32 color)

int x

Position in global space

int y

Position in global space

int width

Size in global space

int height

Size in global space

Color32 color

Color tint

Returns

Type	Description
Cell	Rendering cell for this text character

DrawPixel(IRect, Color32, int)

Draw a solid rectangle into using render layer

Declaration

public static Cell DrawPixel(IRect rect, Color32 color, int z = -2147483648)

Color32 color

Color tint

int z

Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

DrawPixel(IRect, int)

Draw a solid rectangle into using render layer

Declaration

public static Cell DrawPixel(IRect rect, int z = -2147483648)

int z

Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

DrawPixel(int, int, int, int, int, int, int, Color32, int)

Draw a solid rectangle into using render layer

Declaration

public static Cell DrawPixel(int x, int y, int pivotX, int pivotY, int rotation, int width, int height, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

DrawPixel(int, int, int, int, int, int, int, int)

Draw a solid rectangle into using render layer

Declaration

public static Cell DrawPixel(int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int z = -2147483648)

Parameters

Type	Name	Description
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell	Rendering cell for this sprite

DrawSlice(AngeSprite, IRect)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(AngeSprite sprite, IRect rect)

Parameters

Type	Name	Description
AngeSprite	sprite	Artwork sprite
IRect	rect	Rect position in global space

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(AngeSprite, IRect, Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(AngeSprite sprite, IRect rect, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
AngeSprite	sprite	Artwork sprite
IRect	rect	Rect position in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(AngeSprite, IRect, int, int, int, int, Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(AngeSprite sprite, IRect rect, int borderL, int borderR, int borderD, int borderU, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
AngeSprite	sprite	Artwork sprite
IRect	rect	Rect position in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(AngeSprite, IRect, int, int, int, int, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(AngeSprite sprite, IRect rect, int borderL, int borderR, int borderD, int borderU, int z = -2147483648)

Parameters

Type	Name	Description
AngeSprite	sprite	Artwork sprite
IRect	rect	Rect position in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(AngeSprite, int, int, int, int, int, int, int, Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(AngeSprite sprite, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
AngeSprite	sprite	Artwork sprite
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(AngeSprite, int, int, int, int, int, int, int, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(AngeSprite sprite, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int z = -2147483648)

Parameters

Type	Name	Description
AngeSprite	sprite	Artwork sprite
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(AngeSprite, int, int, int, int, int, int, int, int, int, int, int, Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(AngeSprite sprite, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int borderL, int borderR, int borderD, int borderU, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
AngeSprite	sprite	Artwork sprite
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(AngeSprite, int, int, int, int, int, int, int, int, int, int, int, bool[], Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(AngeSprite sprite, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int borderL, int borderR, int borderD, int borderU, bool[] partIgnore, Color32 color, int z)

Parameters

Type	Name	Description
AngeSprite	sprite	Artwork sprite
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
bool[]	partIgnore	Which part should be ignored. Set to true to exclude that part.
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(AngeSprite, int, int, int, int, int, int, int, int, int, int, int, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(AngeSprite sprite, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int borderL, int borderR, int borderD, int borderU, int z = -2147483648)

Parameters

Type	Name	Description
AngeSprite	sprite	Artwork sprite
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(SpriteCode, IRect)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(SpriteCode globalID, IRect rect)

Parameters

Type	Name	Description
SpriteCode	globalID	Artwork sprite ID
IRect	rect	Rect position in global space

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(SpriteCode, IRect, Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(SpriteCode globalID, IRect rect, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
SpriteCode	globalID	Artwork sprite ID
IRect	rect	Rect position in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(SpriteCode, IRect, int, int, int, int, Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(SpriteCode globalID, IRect rect, int borderL, int borderR, int borderD, int borderU, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
SpriteCode	globalID	Artwork sprite ID
IRect	rect	Rect position in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(SpriteCode, IRect, int, int, int, int, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(SpriteCode globalID, IRect rect, int borderL, int borderR, int borderD, int borderU, int z = -2147483648)

Parameters

Type	Name	Description
SpriteCode	globalID	Artwork sprite ID
IRect	rect	Rect position in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(SpriteCode, int, int, int, int, int, int, int, Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(SpriteCode globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
SpriteCode	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(SpriteCode, int, int, int, int, int, int, int, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(SpriteCode globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int z = -2147483648)

Parameters

Type	Name	Description
SpriteCode	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(SpriteCode, int, int, int, int, int, int, int, int, int, int, int, Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(SpriteCode globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int borderL, int borderR, int borderD, int borderU, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
SpriteCode	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(SpriteCode, int, int, int, int, int, int, int, int, int, int, int, bool[], Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(SpriteCode globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int borderL, int borderR, int borderD, int borderU, bool[] partIgnore, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
SpriteCode	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
bool[]	partIgnore	Which part should be ignored. Set to true to exclude that part.
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(SpriteCode, int, int, int, int, int, int, int, int, int, int, int, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(SpriteCode globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int borderL, int borderR, int borderD, int borderU, int z = -2147483648)

Parameters

Type	Name	Description
SpriteCode	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(int, IRect)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(int globalID, IRect rect)

Parameters

Type	Name	Description
int	globalID	Artwork sprite ID
IRect	rect	Rect position in global space

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(int, IRect, Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(int globalID, IRect rect, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
int	globalID	Artwork sprite ID
IRect	rect	Rect position in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(int, IRect, int, int, int, int, Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(int globalID, IRect rect, int borderL, int borderR, int borderD, int borderU, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
int	globalID	Artwork sprite ID
IRect	rect	Rect position in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(int, IRect, int, int, int, int, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(int globalID, IRect rect, int borderL, int borderR, int borderD, int borderU, int z = -2147483648)

Parameters

Type	Name	Description
int	globalID	Artwork sprite ID
IRect	rect	Rect position in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(int, int, int, int, int, int, int, int, Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(int globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
int	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(int, int, int, int, int, int, int, int, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(int globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int z = -2147483648)

Parameters

Type	Name	Description
int	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(int, int, int, int, int, int, int, int, int, int, int, int, Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(int globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int borderL, int borderR, int borderD, int borderU, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
int	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(int, int, int, int, int, int, int, int, int, int, int, int, bool[], Color32, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(int globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int borderL, int borderR, int borderD, int borderU, bool[] partIgnore, Color32 color, int z = -2147483648)

Parameters

Type	Name	Description
int	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
bool[]	partIgnore	Which part should be ignored. Set to true to exclude that part.
Color32	color	Color tint
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

DrawSlice(int, int, int, int, int, int, int, int, int, int, int, int, int)

Proportionally scale the sprite by dividing it into nine sections, protecting the corners and scaling/tiling the edges and center to maintain the image's integrity and prevent distortion.

Declaration

public static Cell[] DrawSlice(int globalID, int x, int y, int pivotX, int pivotY, int rotation, int width, int height, int borderL, int borderR, int borderD, int borderU, int z = -2147483648)

Parameters

Type	Name	Description
int	globalID	Artwork sprite ID
int	x	Position in global space
int	y	Position in global space
int	pivotX	0 means "x" align with left edge. 1000 means "x" align with right edge.
int	pivotY	0 means "y" align with bottom edge. 1000 means "y" align with top edge.
int	rotation	Rotation in degree. 90 means facing right.
int	width	Size in global space
int	height	Size in global space
int	borderL	Padding left in global space
int	borderR	Padding right in global space
int	borderD	Padding down in global space
int	borderU	Padding up in global space
int	z	Z value for sorting rendering cells

Returns

Type	Description
Cell[]	9 Rendering cells for this sprite

GetAltSheet(int)

Get instance of the alt sheet at given index

Declaration

public static Sheet GetAltSheet(int index)

GetAnimationGroupDuration(SpriteGroup)

Get total duration in frame of an animation group

Declaration

public static int GetAnimationGroupDuration(SpriteGroup group)

GetAnimationGroupDuration(int)

Get total duration in frame of an animation group

Declaration

public static int GetAnimationGroupDuration(int chainID)

GetCells(int, out Span<Cell>, out int)

Get cells inside given layer

Declaration

public static bool GetCells(int layer, out Span<Cell> cells, out int count)

Parameters

Type	Name	Description
int	layer	Use RenderLayer.XXX to get this value

Returns

Type	Description
bool	True if cells founded

GetCells(out Span<Cell>, out int)

Get cells inside using layer

Declaration

public static bool GetCells(out Span<Cell> cells, out int count)

Returns

Type	Description
bool	True if cells founded

GetLayerCapacity(int)

Get total size of the layer

Declaration

public static int GetLayerCapacity(int layerIndex)

Parameters

Type	Name	Description
int	layerIndex	Use RenderLayer.XXX to get this value

GetLayerTint(int)

Get current color tint for given layer

Declaration

public static Color32 GetLayerTint(int layer)

Parameters

Type	Name	Description
int	layer	Use RenderLayer.XXX to get this value

GetUsedCellCount()

Get current cells count inside the using layer

Declaration

public static int GetUsedCellCount()

GetUsedCellCount(int)

Get current cells count inside given layer

Declaration

public static int GetUsedCellCount(int layerIndex)

Parameters

Type	Name	Description
int	layerIndex	Use RenderLayer.XXX to get this value

HasSprite(int)

True if sprite with given ID is founded

Declaration

public static bool HasSprite(int globalID)

HasSpriteGroup(int)

True if sprite group with given ID is founded

Declaration

public static bool HasSpriteGroup(int groupID)

HasSpriteGroup(int, out int)

True if sprite group with given ID is founded

Declaration

public static bool HasSpriteGroup(int groupID, out int groupLength)

LoadMainSheet()

Load main sheet from built-in path

Declaration

public static void LoadMainSheet()

MultLayerTint(int, Color32)

Make current color tint multiply given value for given layer

Declaration

public static void MultLayerTint(int layer, Color32 tint)

Parameters

Type	Name	Description
int	layer	Use RenderLayer.XXX to get this value

OverrideFontIdAndIndex(int, int)

Add/set internal cache for font id with index

Declaration

public static void OverrideFontIdAndIndex(int fontId, int fontIndex)

RemoveAltSheet(int)

Remove alt sheet at index from system

Declaration

public static void RemoveAltSheet(int index)

RequireCharForPool(char, out CharSprite)

Require given text character from internal caching

Declaration

public static bool RequireCharForPool(char c, out CharSprite charSprite)

RequireCharForPool(char, int, out CharSprite)

Require given text character from internal caching

Declaration

public static bool RequireCharForPool(char c, int fontIndex, out CharSprite charSprite)

ResetLayer(int)

Clear the whole render layer

Declaration

public static void ResetLayer(int layerIndex)

Parameters

Type	Name	Description
int	layerIndex	Use RenderLayer.XXX to get this value

ReverseUnsortedCells(int)

Sort cells inside layer reversely with default comparer

Declaration

public static void ReverseUnsortedCells(int layerIndex)

Parameters

Type	Name	Description
int	layerIndex	Use RenderLayer.XXX to get this value

SetFontID(int)

Set current using font from ID

Declaration

public static void SetFontID(int id)

SetFontIndex(int)

Set current using font from index

Declaration

public static void SetFontIndex(int index)

SetLayer(int)

Set current using layer. Use RenderLayer.XXX to get this value.

Declaration

public static void SetLayer(int index)

SetLayerTint(int, Color32)

Set current color tint for given layer

Declaration

public static void SetLayerTint(int layer, Color32 tint)

Parameters

Type	Name	Description
int	layer	Use RenderLayer.XXX to get this value

SetLayerToAdditive()

Declaration

public static void SetLayerToAdditive()

SetLayerToBehind()

Declaration

public static void SetLayerToBehind()

SetLayerToColor()

Declaration

public static void SetLayerToColor()

SetLayerToDefault()

Declaration

public static void SetLayerToDefault()

SetLayerToMultiply()

Declaration

public static void SetLayerToMultiply()

SetLayerToShadow()

Declaration

public static void SetLayerToShadow()

SetLayerToWallpaper()

Declaration

public static void SetLayerToWallpaper()

SortLayer(int)

Sort cells inside layer with default comparer

Declaration

public static void SortLayer(int layerIndex)

Parameters

Type	Name	Description
int	layerIndex	Use RenderLayer.XXX to get this value

TryGetAnimationGroup(int, out SpriteGroup)

Get instance of animation group

Declaration

public static bool TryGetAnimationGroup(int groupID, out SpriteGroup group)

Returns

Type	Description
bool	True if animation group founded

TryGetSprite(int, out AngeSprite, bool)

Get instance of sprite

Declaration

public static bool TryGetSprite(int globalID, out AngeSprite sprite, bool ignoreAnimation = true)

bool ignoreAnimation

True if ignore animation group with "globalID" as chainID

Returns

Type	Description
bool	True if sprite founded

TryGetSpriteForGizmos(int, out AngeSprite)

Get sprite for rendering UI/icon/gizmos

Declaration

public static bool TryGetSpriteForGizmos(int artworkID, out AngeSprite sprite)

Returns

Type	Description
bool	True if sprite founded

TryGetSpriteFromGroup(int, int, out AngeSprite, bool, bool, bool)

Get sprite instance from given group ID and index

Declaration

public static bool TryGetSpriteFromGroup(int groupID, int index, out AngeSprite sprite, bool loopIndex = true, bool clampIndex = true, bool ignoreAnimatedWhenFailback = true)

bool loopIndex

True if the index loop

bool clampIndex

True if clamp the index when out of range

bool ignoreAnimatedWhenFailback

True if don't use animated sprite when returning the failback sprite

Returns

Type	Description
bool	True if sprite founded

TryGetSpriteGroup(int, out SpriteGroup)

Get instance of sprite group

Declaration

public static bool TryGetSpriteGroup(int groupID, out SpriteGroup group)

Returns

Type	Description
bool	True if sprite group founded

TryGetTextureFromSheet<T>(int, int, out T)

Get texture object for given sprite from sheet

Declaration

public static bool TryGetTextureFromSheet<T>(int spriteID, int sheetIndex, out T texture)

Returns

Type	Description
bool	True if the texture founded

Type Parameters

Name	Description
T	Type of texture object