Class Playscii

Playscii converter. Check this excellent ascii editor out at http://vectorpoem.com/playscii/

Inheritance
object
Playscii
Inherited Members
Namespace: SadConsole.Readers
Assembly: SadConsole.dll
Syntax
public class Playscii

Constructors

Playscii()

Declaration
public Playscii()

Fields

charset

Name of the font file.

Declaration
public string charset
Field Value
Type Description
string

frames

Hold all the animation frames.

Declaration
public Playscii.Frame[] frames
Field Value
Type Description
Frame[]

height

Surface height.

Declaration
public int height
Field Value
Type Description
int

palette

Name of the palette file.

Declaration
public string palette
Field Value
Type Description
string

width

Surface width.

Declaration
public int width
Field Value
Type Description
int

Methods

ToScreenSurface(string, IFont, string, string)

Converts a Playscii file to a SadConsole ScreenSurface.

Declaration
public static ScreenSurface ToScreenSurface(string fileName, IFont font, string paletteFileName = "", string zipArchiveName = "")
Parameters
Type Name Description
string fileName

Name and path of the Playscii file (give only file name if zipArchiveName is used).
IFont font

IFont to be used when converting the Playscii file.
string paletteFileName

Path to an alternative palette file rather than the one specified in the playscii records.
string zipArchiveName

If specified, the playscii file will be read from this zip archive.
Returns
Type Description
ScreenSurface

ScreenSurface containing the first frame from the Playscii file.
Remarks

SadConsole does not support all the Playscii features at the moment, so the conversion will not be perfect.
Do not use tile rotation and set Z-Depth to 0 on all Playscii layers.
Transparent glyph foreground is fine, but it will not cut through the ColoredGlyphBase background like it does in Playscii.

Extension Methods