SineSpace.Scripting.Components.SUIText Class Reference

Inheritance diagram for SineSpace.Scripting.Components.SUIText:

Properties
bool	SupportRichText [get, set]
	Whether this Text will support rich text.
bool	ResizeTextForBestFit [get, set]
	Should the text be allowed to auto resized.
int	ResizeTextMinSize [get, set]
	The minimum size the text is allowed to be.
int	ResizeTextMaxSize [get, set]
	The maximum size the text is allowed to be. 1 = infinitely large.
bool	AlignByGeometry [get, set]
	Use the extents of glyph geometry to perform horizontal alignment rather than glyph metrics.
int	FontSize [get, set]
	The size that the Font should render at.
float	LineSpacing [get, set]
	normal line spacing.
float	PixelsPerUnit [get]
	(Read Only) Provides information about how fonts are scale to the screen.
float	MinWidth [get]
	The minimum width this layout element may be allocated.
float	PreferredWidth [get]
	The preferred width this layout element should be allocated if there is sufficient space.
float	FlexibleWidth [get]
	The extra relative width this layout element should be allocated if there is additional available space.
float	MinHeight [get]
	The minimum height this layout element may be allocated.
float	PreferredHeight [get]
	The preferred height this layout element should be allocated if there is sufficient space.
float	FlexibleHeight [get]
	The extra relative height this layout element should be allocated if there is additional available space.
int	LayoutPriority [get]
	The layout priority of this component.
bool	Enabled [get, set]
	Enabled Behaviors are Updated; disabled Behaviors are not.
string	Text [get, set]
	The string value this Text displays.
SColor	Color [get, set]
	Base color of the Graphic.
Properties inherited from ScriptClassComponent< T >
SGameObject	GameObject [get]
	Return the GameObject which component added.
Properties inherited from ScriptClass< T >
override bool	Alive [get]
	Return if the component is alive.
Properties inherited from ScriptClassWrapper< T >
T	_wrap [get]
Properties inherited from ScriptClass
virtual bool	Alive [get]
DynValue	CachedData [get, set]

Additional Inherited Members
Public Member Functions inherited from ScriptClassWrapper< T >
override void	Initialise (SScript runtime, object wrapper)
Public Member Functions inherited from ScriptClass
void	ReportError (string error, bool fatal, UnityEngine.Object target=null)
void	Initialise (SScript runtime, object wrapper)
Protected Member Functions inherited from ScriptClass
void	Initialise (SScript runtime)

Property Documentation

AlignByGeometry

bool SineSpace.Scripting.Components.SUIText.AlignByGeometry

getset

Use the extents of glyph geometry to perform horizontal alignment rather than glyph metrics.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.AlignByGeometry)

Color

SColor SineSpace.Scripting.Components.SUIText.Color

getset

Base color of the Graphic.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.Color.ToString())

Enabled

bool SineSpace.Scripting.Components.SUIText.Enabled

getset

Enabled Behaviors are Updated; disabled Behaviors are not.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.Enabled)

FlexibleHeight

float SineSpace.Scripting.Components.SUIText.FlexibleHeight

get

The extra relative height this layout element should be allocated if there is additional available space.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.FlexibleHeight)

FlexibleWidth

float SineSpace.Scripting.Components.SUIText.FlexibleWidth

get

The extra relative width this layout element should be allocated if there is additional available space.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.FlexibleWidth)

FontSize

int SineSpace.Scripting.Components.SUIText.FontSize

getset

The size that the Font should render at.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.FontSize)

LayoutPriority

int SineSpace.Scripting.Components.SUIText.LayoutPriority

get

The layout priority of this component.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.LayoutPriority)

LineSpacing

float SineSpace.Scripting.Components.SUIText.LineSpacing

getset

normal line spacing.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.LineSpacing)

MinHeight

float SineSpace.Scripting.Components.SUIText.MinHeight

get

The minimum height this layout element may be allocated.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.MinHeight)

MinWidth

float SineSpace.Scripting.Components.SUIText.MinWidth

get

The minimum width this layout element may be allocated.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.MinWidth)

PixelsPerUnit

float SineSpace.Scripting.Components.SUIText.PixelsPerUnit

get

(Read Only) Provides information about how fonts are scale to the screen.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.PixelsPerUnit)

PreferredHeight

float SineSpace.Scripting.Components.SUIText.PreferredHeight

get

The preferred height this layout element should be allocated if there is sufficient space.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.PreferredHeight)

PreferredWidth

float SineSpace.Scripting.Components.SUIText.PreferredWidth

get

The preferred width this layout element should be allocated if there is sufficient space.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.PreferredWidth)

ResizeTextForBestFit

bool SineSpace.Scripting.Components.SUIText.ResizeTextForBestFit

getset

Should the text be allowed to auto resized.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.ResizeTextForBestFit)

ResizeTextMaxSize

int SineSpace.Scripting.Components.SUIText.ResizeTextMaxSize

getset

The maximum size the text is allowed to be. 1 = infinitely large.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.ResizeTextMaxSize)

ResizeTextMinSize

int SineSpace.Scripting.Components.SUIText.ResizeTextMinSize

getset

The minimum size the text is allowed to be.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.ResizeTextMinSize)

SupportRichText

bool SineSpace.Scripting.Components.SUIText.SupportRichText

getset

Whether this Text will support rich text.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.SupportRichText)

Text

string SineSpace.Scripting.Components.SUIText.Text

getset

The string value this Text displays.

local text=Space.Host.GetReference("Text").UIText
Space.Log(text.Text)