PixelCrushers.DialogueSystem.Emphasis Struct Reference

Specifies special text formatting for a substring. More...

Public Member Functions
	Emphasis (int startIndex, int length, Color color, bool bold, bool italic, bool underline)
	Initializes a new Emphasis struct. More...

Properties
int	startIndex [get, set]
	Gets or sets the first character where the formatting begins. More...
int	length [get, set]
	Gets or sets the length of the substring that should be formatted. More...
Color	color [get, set]
	Gets or sets the color to use for this substring. More...
bool	bold [get, set]
	Gets or sets a value indicating whether to display the substring in bold. More...
bool	italic [get, set]
	Gets or sets a value indicating whether to display the substring in italics. More...
bool	underline [get, set]
	Gets or sets a value indicating whether to display the substring underlined. More...

Detailed Description

Specifies special text formatting for a substring.

Emphases are used by FormattedText.

Constructor & Destructor Documentation

Emphasis()

PixelCrushers.DialogueSystem.Emphasis.Emphasis	(	int	startIndex,
		int	length,
		Color	color,
		bool	bold,
		bool	italic,
		bool	underline
	)

Initializes a new Emphasis struct.

Parameters

startIndex	Start index of the substring.
length	Length of the substring.
color	Color of the substring.
bold	If true, display in bold.
italic	If true, display in italics.
underline	If true, display underlined.

Property Documentation

bold

bool PixelCrushers.DialogueSystem.Emphasis.bold

getset

Gets or sets a value indicating whether to display the substring in bold.

true if bold; otherwise, false.

color

Color PixelCrushers.DialogueSystem.Emphasis.color

getset

Gets or sets the color to use for this substring.

The color.

italic

bool PixelCrushers.DialogueSystem.Emphasis.italic

getset

Gets or sets a value indicating whether to display the substring in italics.

true if italic; otherwise, false.

length

int PixelCrushers.DialogueSystem.Emphasis.length

getset

Gets or sets the length of the substring that should be formatted.

The length.

startIndex

int PixelCrushers.DialogueSystem.Emphasis.startIndex

getset

Gets or sets the first character where the formatting begins.

The start index.

underline

bool PixelCrushers.DialogueSystem.Emphasis.underline

getset

Gets or sets a value indicating whether to display the substring underlined.

true if underlined; otherwise, false.

---

The documentation for this struct was generated from the following file:

• D:/Documents/Unity Projects/Dialogue System/Dev/Source/Assets/Dialogue System/Scripts/Core/Model-View-Controller/Model/Logic/Formatted Text/Emphasis.cs