SilverSharpAPI

SilverSharp.FONT_NODE

Structure

An object that stores font information for use with entities

C# Code

class FONT_NODE

{

enum FontTypes

{

FT_VECTOR2D = 1,

FT_3D = 2,

FT_CHINESE = 3,

FT_JAPANESE_KANJI = 4,

FT_KOREAN = 5,

FT_FILLED = 9,

FT_TRUETYPE = 10,

};

property FontTypes font_type { get; }

readonly FontStyle style;

readonly FontStyle screen_style;

property bool is_monospaced { get; }

property BosList Characters { get; }

property int first_char { get; }

property int last_char { get; }

property int default_char { get; }

property double row_spacing_ratio { get; }

BOS_NODE FONT_NODE[int char_index];

string ToString();

};

Properties

The following read-only properties mimic the purpose of their counter-parts in the SilverC FONT_NODE data type:

Member	Description
default_char	index of default character in font
first_char	index of first character in font
font_name	name of font
last_char	index of last character in font

The following read-only properties extend FONT_NODE for SilverSharp:

Member

Description

Characters

Enumerates a list of BOS_NODE entities that represent font characters

FONT_NODE[int ch_index];

A read-only indexer that returns a BOS_NODE entity that represents a font character. ch_index must be between first_char and last_char. See also the Characters enumerator

font_type

A value whose meaning is as follows:

Name	Description
FT_3D	The font is a 3D font
FT_CHINESE	The font uses two-byte Chinese characters
FT_FILLED	The font is a 3D font with fill enabled
FT_JAPANESE_KANJI	The font uses two-byte Japanese characters
FT_KOREAN	The font uses two-byte Korean characters
FT_TRUETYPE	The font is a truetype font
FT_VECTOR2D	The font is a 2D vector font

is_monospaced

true if the font is mono-spaced

row_spacing_ratio

A ratio used when calculating the distance between rows of text

screen_style

Style of font used for rendering (i.e. to the screen). It is possible the font does not exist on the current system, in which case a substitution is made for the purpose of rendering. If the font does exist, then style and screen_style will refer to the same underlying font.

style

Desired style of font

Methods

Name	Description
ToString	Formats the FONT_NODE as a string suitable for use in a command