Public classes

Controller
DisplayModel
DotMatrix
TextToContent

Commands/

   AbsCmd
   AbsCmdPosition
   AbsCmdSpeed
   CallbackCommand
   ClearCommand
   ContentCommand
   PauseCommand
   TextCommand

Displays/

   Display
   Display_3D
   Display_Sprite
   Display_UI


Introduction page

TextCommand
Derived from AbsCmdPosition


Command to add text on display. This is most common command to be added to Controller.


Enums

public enum FontsList of differents fonts that can be used to display text.
public enum TextAlignmentsList of possible text alignments in case there's multiple lines of text.

Constructors

public TextCommand (string text)Create new text command.
public TextCommand (string[] textLines)Create new text command with multiple lines of text.

Properties

public int BackColorSet or get text background color.
public bool BoldSet or get text to be bold.
public int CharSpacingSet or get character spacing.
public bool FixedWidthSet or get text to be fixed width.
public Fonts FontSet or get font used for this text.
public int LineSpacingSet or get line spacing.
public TextAlignments TextAlignmentSet or get text alignment.
public int TextColorSet or get text color.

Enums

public enum Fonts

List of differents fonts that can be used to display text.

ItemsLargeLarge 9*5 (height*width) font that also have lower case characters.
 NormalNormal 7*5 (height*width) font that have only upper case characters.
 SmallSmall 5*3 (height*width) font that have only upper case characters.


public enum TextAlignments

List of possible text alignments in case there's multiple lines of text.

ItemsCenterText is aligned to center (compared to other lines of text).
 LeftText is aligned to left (all lines first character starts from same position).
 RightText is aligned to right (all lines last character ends to same position).


Constructors

public TextCommand (string text)

Create new text command. By default character spacing is one dot, and used character is 'fixed width' without bolding. Linebreak characters ('\n' or '\r') will cut the text to multiple lines.

ParameterstextSingle or multiple lines of text to be shown on display.


public TextCommand (string[] textLines)

Create new text command with multiple lines of text. By default character and line spacing are one dot, and used character is 'fixed width' without bolding.

ParameterstextLinesMultiple lines of text to be shown on display.


Properties

public int BackColor

Set or get text background color. This is index of color, and colors themselves are defined in DotMatrix Display (typically in Unity inspector window). Default text background color is 0. That is "dot off-state" in display.

ValueText background color index.


public bool Bold

Set or get text to be bold. Default is false (not bold).

ValueTrue if text is bold, false otherwise.


public int CharSpacing

Set or get character spacing. Default is 1.

ValueCharacter spacing in dots.


public bool FixedWidth

Set or get text to be fixed width. Default is true (using fixed width).

ValueTrue if text is fixed width, false otherwise.


public Fonts Font

Set or get font used for this text. If font is not set, Controller default is used.

ValueWanted font, one of the values from enum Fonts.


public int LineSpacing

Set or get line spacing. Default is 1.

ValueLine spacing in dots.


public TextAlignments TextAlignment

Set or get text alignment. This have effect only if there is multiple lines of text. By default text alignment follows content horizontal position. For example, if content horizontal position is right, also multiple lines of text is aligned to right. In most cases this is what is wanted and there is no need to set TextAlignment.

ValueWanted text alignment, one of the values from enum TextAlignments.


public int TextColor

Set or get text color. This is index of color, and colors themselves are defined in DotMatrix Display (typically in Unity inspector window). Default text color is 1. That is default "dot on-state" in display. In case of two-color display that is also only dot on-state.

To get inverse text, simply set TextColor to 0 and BackColor to 1.

ValueText color index.