m |
|||
| Line 217: | Line 217: | ||
{{ScriptFunction|string|Text|{get;set;}|The string value this Text displays.|5= | {{ScriptFunction|string|Text|{get;set;}|The string value this Text displays.|5= | ||
| − | <pre> Space.Host.ExecutingObject.UIText.Text = "Hello World!" </pre> | + | <pre> Space.Host.ExecutingObject.UIText.Text = "Hello World!" </pre>|6=<pre> |
| + | --the below script will make a UIText element with this script | ||
| + | --constantly update itself to show the local time | ||
| + | --(Example: UI Text element that shows local clock) | ||
| + | --[This object needs to be a UI Text object. In Unity, Heirarchy -> Create -> UI -> Text] | ||
| + | --<Note: UI Text element could also be in world space if it's canvas is a world space canvas> | ||
| + | |||
| + | thisGameObject = Space.Host.ExecutingObject | ||
| + | |||
| + | OnUpdate = function() | ||
| + | thisGameObject.UIText.Text = Space.LocalTime | ||
| + | end | ||
| + | |||
| + | thisGameObject.SubscribeToEvents() | ||
| + | thisGameObject.OnUpdate(OnUpdate)</pre> | ||
}} | }} | ||
{{Scripting Navbox}} | {{Scripting Navbox}} | ||
The SUIText class provides tools to work with the SUIText component, which is a component responsible for displaying text
Use the range of glyph geometry to perform horizontal alignment.
thisObject = Space.Host.ExecutingObject --get a reference to our object thisObjectText = thisObject.UIText --get a reference to the SUIText component in our object Space.Log(thisObjectText.AlignByGeometry) --This will return "true" or "false" to your debugger console --telling you if the Align By Geometry feature is on or not (false by default) thisObjectText.AlignByGeometry = true --This enables the Align By Geometry feature thisObjectText.AlignByGeometry = false --This disables the Align By Geometry feature
Base color of the Graphic.
--This script dynamically changes the text's color of a GameObject with UIText component.
--For example in a text sign over your shop that you want to make more visually stand out
--or perhaps text decoration during a celebration or a text element in your User Interface or HUD.
thisObject = Space.Host.ExecutingObject
--get a reference to our object
thisObjectText = thisObject.UIText
--get a reference to the SUIText component in our object
colors = {Color.Red, Color.Black, Color.White, Color.Blue, Color.Green, Color.Yellow}
--here we are holding 6 predefined colors in a Lua Table which we will go through
function ColorChanger()
while true do
--infinite loop
for i=1,#colors do
--For Loop to cycle through all the table items
thisObjectText.color = colors[i]
--this will set the color based on which item in the table we are now at
coroutine.yield(0.1)
--this will pause for a tenth of a second before we change to the next color
end
end
end
Space.Host.StartCoroutine(ColorChanger)
--this coroutine will now call our ColorChanger() function which is infinitely changing our text colors between a select range.
Whether the UIText component is Enabled or not will decide if it is visually updating or not.
thisObject = Space.Host.ExecutingObject --get a reference to our object thisObjectText = thisObject.UIText --get a reference to the UIText component in our object Space.Log(thisObjectText.Enabled) --This will return "true" or "false" to your debugger console thisObjectText.Enabled = false --This is how we disable the UIText component thisObjectText.Enabled = true --This is how we enable the UIText component
The extra relative height this UIText should be allocated if there is additional available space. (Used by the Layout system.)
thisObject = Space.Host.ExecutingObject --get a reference to our object thisObjectText = thisObject.UIText --get a reference to the UIText component in our object Space.Log(thisObjectText.FlexibleHeight) --Prints the FlexibleHeight value of this UIText component to the console
The extra relative width this UIText should be allocated if there is additional available space. (Used by the Layout system)
thisObject = Space.Host.ExecutingObject --get a reference to our object thisObjectText = thisObject.UIText --get a reference to the UIText component in our object Space.Log(thisObjectText.FlexibleWidth) --Prints the FlexibleWidth value of this UIText component to the console
The size that the Font should render at.
thisObject = Space.Host.ExecutingObject --get a reference to our object thisObjectText = thisObject.UIText --get a reference to the UIText component in our object Space.Log(thisObjectText.FontSize) --Prints the Font Size value of this UIText component to the console thisObjectText.FontSize = 54 --Sets the Font Size of this UIText component to 54
The layout priority of this UIText component.(Used by the Layout system.)
thisObject = Space.Host.ExecutingObject --get a reference to our object thisObjectText = thisObject.UIText --get a reference to the UIText component in our object Space.Log(thisObjectText.LayoutPriority) --Prints the LayoutPriority value of this UIText component to the console
How much space will be in-between lines of text. This is a multiplier. The line spacing value set will be multiplied by the font's internal line spacing. A value of 1 will produce normal line spacing.
thisObject = Space.Host.ExecutingObject --get a reference to our object thisObjectText = thisObject.UIText --get a reference to the UIText component in our object Space.Log(thisObjectText.LineSpacing) --Prints the LineSpacing value of this UIText component to the console thisObjectText.LineSpacing = 2 --This sets the LineSpacing value of this UIText component to 2.
The minimum height this UIText may be allocated.(Used by the Layout system).
thisObject = Space.Host.ExecutingObject --get a reference to our object thisObjectText = thisObject.UIText --get a reference to the UIText component in our object Space.Log(thisObjectText.MinHeight) --Prints the MinHeight value of this UIText component to the console
The minimum width this UIText may be allocated. (Used by the Layout system).
thisObject = Space.Host.ExecutingObject --get a reference to our object thisObjectText = thisObject.UIText --get a reference to the UIText component in our object Space.Log(thisObjectText.MinWidth) --Prints the MinWidth value of this UIText component to the console
Provides information about how fonts are scale to the screen.
For dynamic fonts, the value is equivalent to the scale factor of the canvas. For non-dynamic fonts, the value is calculated from the requested text size and the size from the font.
thisObject = Space.Host.ExecutingObject --get a reference to our object thisObjectText = thisObject.UIText --get a reference to the UIText component in our object Space.Log(thisObjectText.PixelsPerUnit) --Prints the PixelsPerUnit value of this UIText component to the console
The preferred height this UIText should be allocated if there is sufficient space. (Used by the Layout system)
thisObject = Space.Host.ExecutingObject --get a reference to our object thisObjectText = thisObject.UIText --get a reference to the UIText component in our object Space.Log(thisObjectText.PreferredHeight) --Prints the PreferredHeight value of this UIText component to the console
The preferred width this UIText should be allocated if there is sufficient space. (Used by the Layout system)
thisObject = Space.Host.ExecutingObject thisObjectText = thisObject.UIText Space.Log(thisObjectText.PreferredWidth)
Should the text be allowed to auto resized.
Space.Host.ExecutingObject.UIText.ResizeTextForBestFit = false
The maximum size the text is allowed to be. 1 is infinitely large.
Space.Host.ExecutingObject.UIText.ResizeTextMaxSize = 150
The minimum size the text is allowed to be.
Space.Host.ExecutingObject.UIText.ResizeTextMinSize = 20
Whether this Text will support rich text.
Space.Host.ExecutingObject.UIText.SupportRichText = true
The string value this Text displays.
Space.Host.ExecutingObject.UIText.Text = "Hello World!"
--the below script will make a UIText element with this script --constantly update itself to show the local time --(Example: UI Text element that shows local clock) --[This object needs to be a UI Text object. In Unity, Heirarchy -> Create -> UI -> Text] --<Note: UI Text element could also be in world space if it's canvas is a world space canvas> thisGameObject = Space.Host.ExecutingObject OnUpdate = function() thisGameObject.UIText.Text = Space.LocalTime end thisGameObject.SubscribeToEvents() thisGameObject.OnUpdate(OnUpdate)
| ||||||||||||||