Catlike Coding
Unity Code Documentation
Public Member Functions | Public Attributes | Properties | List of all members
CatlikeCoding.TextBox.BitmapFont Class Reference

Bitmap font definition. Supports all non-control non-modifier characters in the Basic Multilingual Plane. More...

Inherits ScriptableObject.

Public Member Functions

void UpdateAllTextBoxes ()
 Update all text boxes. Used in the editor. More...
 

Public Attributes

BitmapFontChar[] asciiChars
 ASCII characters, from '!' to '~'. Characters missing from the font have zeros for all their values. More...
 
float baseline
 Distance from the top of the line to the baseline. More...
 
float baselineToBottom
 Distance from the baseline to the bottom of the line. More...
 
bool hasImportedKerningData
 Whether kerning data has been imported. Purely informational. More...
 
int importOffsetX
 Import adjustment settings, in case you need to tweak your source data. Used in the editor. More...
 
BitmapFontChar[] otherChars
 All non-ASCII characters included in the font. More...
 
int pixelLineHeight
 Original line height in pixels. More...
 
float spaceAdvance
 Amount to advance the caret for a space. More...
 

Properties

bool IsValid [get]
 Get whether this is a valid imported font. More...
 
BitmapFontChar this[char c] [get]
 Get the data for a character in this font. Missing characters have zeros for all values. More...
 

Detailed Description

Bitmap font definition. Supports all non-control non-modifier characters in the Basic Multilingual Plane.

Member Function Documentation

void CatlikeCoding.TextBox.BitmapFont.UpdateAllTextBoxes ( )

Update all text boxes. Used in the editor.

Member Data Documentation

BitmapFontChar [] CatlikeCoding.TextBox.BitmapFont.asciiChars

ASCII characters, from '!' to '~'. Characters missing from the font have zeros for all their values.

float CatlikeCoding.TextBox.BitmapFont.baseline

Distance from the top of the line to the baseline.

float CatlikeCoding.TextBox.BitmapFont.baselineToBottom

Distance from the baseline to the bottom of the line.

bool CatlikeCoding.TextBox.BitmapFont.hasImportedKerningData

Whether kerning data has been imported. Purely informational.

int CatlikeCoding.TextBox.BitmapFont.importOffsetX

Import adjustment settings, in case you need to tweak your source data. Used in the editor.

BitmapFontChar [] CatlikeCoding.TextBox.BitmapFont.otherChars

All non-ASCII characters included in the font.

int CatlikeCoding.TextBox.BitmapFont.pixelLineHeight

Original line height in pixels.

float CatlikeCoding.TextBox.BitmapFont.spaceAdvance

Amount to advance the caret for a space.

Property Documentation

bool CatlikeCoding.TextBox.BitmapFont.IsValid
get

Get whether this is a valid imported font.

BitmapFontChar CatlikeCoding.TextBox.BitmapFont.this[char c]
get

Get the data for a character in this font. Missing characters have zeros for all values.

Parameters
cA character.