wiki.sine.space | sinespace

Difference between revisions of "Scripting/SUIInputField"

From wiki.sine.space
Jump to: navigation, search
(Added simple examples to all members (21) in SUIInputField)
(Replaced content with "This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/suiinputfield")
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Members=
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/suiinputfield
 
+
{{ScriptFunction|void|OnEndEdit|(closure callback)|Given function will be called when editing has ended|5=<pre>oee = function()
+
  Space.Log("edit ended")
+
end
+
Space.Host.ExecutingObject.UIInputField.OnEndEdit(oee)</pre>}}
+
 
+
{{ScriptFunction|void|OnValueChanged|(closure callback)|Given function will be called when text in Input Field has changed|5=<pre>ovc = function()
+
  Space.Log("value changed")
+
  end
+
Space.Host.ExecutingObject.UIInputField.OnValueChanged(ovc)</pre>}}
+
 
+
 
+
=Properties=
+
 
+
{{ScriptFunction|char|AsteriskChar|{ get; set; }|The character used for password fields.|5= <pre>Space.Host.ExecutingObject.UIInputField.AsteriskChar= "%"</pre>}}
+
 
+
{{ScriptFunction|float|CaretBlinkRate|{ get; set; }|The blinking rate of the input caret, defined as the number of times the blink cycle occurs per second.|5= <pre>Space.Host.ExecutingObject.UIInputField.CaretBlinkRate= 3</pre>}}
+
 
+
{{ScriptFunction|int|CaretPosition|{ get; set; }|Current InputField caret position (also selection tail).|5= <pre>Space.Host.ExecutingObject.UIInputField.CaretPosition= 3</pre>}}
+
 
+
{{ScriptFunction|int|CaretWidth|{ get; set; }|The width of the caret in pixels.|5= <pre>Space.Host.ExecutingObject.UIInputField.CaretWidth= 4</pre>}}
+
 
+
{{ScriptFunction|int|CharacterLimit|{ get; set; }|How many characters the input field is limited to. 0 = infinite.|5= <pre>Space.Host.ExecutingObject.UIInputField.CharacterLimit= 8</pre>}}
+
 
+
{{ScriptFunction|bool|Enabled|{ get; set; }|Whether this Input Field component is Enabled or not|5= <pre>Space.Host.ExecutingObject.UIInputField.Enabled= true</pre>}}
+
 
+
{{ScriptFunction|bool|Interactable|{ get; set; }|Is the Input Field interactable?|5= <pre>Space.Host.ExecutingObject.UIInputField.Interactable= true</pre>}}
+
 
+
{{ScriptFunction|bool|IsFocused|{ get;}|Does the InputField currently have focus and is able to process events.|5= <pre>hasFocus = Space.Host.ExecutingObject.UIInputField.IsFocused </pre>}}
+
 
+
{{ScriptFunction|bool|ReadOnly|{ get;set; }|Set the InputField to be read only.|5= <pre>Space.Host.ExecutingObject.UIInputField.ReadOnly= true</pre>}}
+
 
+
{{ScriptFunction|int|SelectionAnchorPosition|{ get;set;}|The beginning point of the selection.|5= <pre>Space.Host.ExecutingObject.UIInputField.SelectionAnchorPosition= 1</pre>}}
+
 
+
{{ScriptFunction|int|SelectionFocusPosition|{ get;set; }|The end point of the selection.|5= <pre>Space.Host.ExecutingObject.UIInputField.SelectionFocusPosition= 4</pre>}}
+
 
+
{{ScriptFunction|string|Text|{ get;set; }|The current value of the input field.|5= <pre>Space.Host.ExecutingObject.UIInputField.Text= "Hello"</pre>}}
+
 
+
{{ScriptFunction|float|FlexibleHeight|{ get;}|The extra relative height this UIText should be allocated if there is additional available space. (Used by the Layout system) |5= <pre>flexHeight = Space.Host.ExecutingObject.UIInputField.FlexibleHeight</pre>}}
+
 
+
{{ScriptFunction|float|FlexibleWidth|{ get;}|The extra relative width this UIText should be allocated if there is additional available space. (Used by the Layout system)|5= <pre>flexWidth = Space.Host.ExecutingObject.UIInputField.FlexibleWidth</pre>}}
+
 
+
{{ScriptFunction|float|MinHeight|{ get;}|The minimum height this UIText may be allocated.(Used by the Layout system).|5= <pre>minHeight = Space.Host.ExecutingObject.UIInputField.MinHeight</pre>}}
+
 
+
{{ScriptFunction|float|MinWidth|{ get;}|The minimum width this UIText may be allocated. (Used by the Layout system).|5= <pre>minWidth = Space.Host.ExecutingObject.UIInputField.MinWidth</pre>}}
+
 
+
{{ScriptFunction|bool|MultiLine|{ get;}|If the input field supports multiple lines.|5= <pre>Space.Host.ExecutingObject.UIInputField.MultiLine = true</pre>}}
+
 
+
{{ScriptFunction|float|PreferredHeight|{ get;}|The preferred height this UIText should be allocated if there is sufficient space. (Used by the Layout system)|5= <pre>prefHeight = Space.Host.ExecutingObject.UIInputField.PreferredHeight</pre>}}
+
 
+
{{ScriptFunction|bool|PreferredWidth|{ get; }|The preferred width this UIText should be allocated if there is sufficient space. (Used by the Layout system)|5= <pre>prefWidth = Space.Host.ExecutingObject.UIInputField.PreferredWidth</pre>}}
+
 
+
 
+
 
+
{{Scripting Navbox}}
+

Latest revision as of 06:35, 19 September 2022

This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/suiinputfield