C# Class Epigene.UI.UIText

Inheritance: UnityEngine.MonoBehaviour, UIObject
Mostrar archivo Open project: fi-content2-games-platform/FIcontent.Gaming.Enabler.phenomobilecharactermanager Class Usage Examples

Public Properties

Property Type Description
format string
isLocalized bool
isNumeric bool
maxLength int
sortingOrder int
text string
textId string
wrapSize int

Public Methods

Method Description
Awake ( ) : void

Set up the UIText with using Text

GetType ( ) : UIType

Get the type of the this item.

OnEnable ( ) : void

Start will update the localization if required.

Parse ( object>.Dictionary dict ) : void

Parse the content of the dictionary and create a new gameobject with this parameters

Update ( ) : void

This will update the text based on formatting and localization settings. The localization will be updated only in Editor Mode to avoid unnecessary performance overhead.

WordWrap ( string text, int width ) : string

Word wraps the given text to fit within the specified width.

Private Methods

Method Description
BreakLine ( string text, int pos, int max ) : int

Locates position to break the given line so as to avoid breaking words.

Method Details

Awake() public method

Set up the UIText with using Text
public Awake ( ) : void
return void

GetType() public method

Get the type of the this item.
public GetType ( ) : UIType
return UIType

OnEnable() public method

Start will update the localization if required.
public OnEnable ( ) : void
return void

Parse() public method

Parse the content of the dictionary and create a new gameobject with this parameters
public Parse ( object>.Dictionary dict ) : void
dict object>.Dictionary
return void

Update() public method

This will update the text based on formatting and localization settings. The localization will be updated only in Editor Mode to avoid unnecessary performance overhead.
public Update ( ) : void
return void

WordWrap() public static method

Word wraps the given text to fit within the specified width.
public static WordWrap ( string text, int width ) : string
text string Text to be word wrapped
width int Width, in characters, to which the text /// should be word wrapped
return string

Property Details

format public_oe property

format of the text, use it with isNumaric
public string format
return string

isLocalized public_oe property

Set to true if need localization localization will override the mesh text in every loop
public bool isLocalized
return bool

isNumeric public_oe property

set to true if you want to format the value as numeric
public bool isNumeric
return bool

maxLength public_oe property

maximum length to print out
public int maxLength
return int

sortingOrder public_oe property

public int sortingOrder
return int

text public_oe property

local text of the ui without any formatting and localization
public string text
return string

textId public_oe property

localized text id
public string textId
return string

wrapSize public_oe property

Word wrap size. Word wrap is used if this value is greater then 0
public int wrapSize
return int