import{_ as s,o as e,c as a,Q as t}from"./chunks/framework.4313453f.js";const x=JSON.parse('{"title":"Textfield","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"references/textfield.md","filePath":"references/textfield.md","lastUpdated":null}'),n={name:"references/textfield.md"},l=t(`

Textfield ​

Textfields are objects that allow users to write text in multiple lines, similar to the default edit script.

Properties ​

PropertyTypeDescription
linestableA collection of strings, where each string represents a separate line in the Textfield.
lineIndexnumberThe current line number where the cursor is positioned.
scrollIndexXnumberThe horizontal scroll position, determining which part of the text is visible when the text width exceeds the Textfield width.
scrollIndexYnumberThe vertical scroll position, deciding which part of the text is visible when the number of lines exceeds the Textfield's height.
cursorIndexnumberThe current position of the cursor within the line determined by lineIndex.

Example ​

Here’s a simple example showcasing how to instantiate a Textfield object within the Basalt framework:

lua
local main = basalt.createFrame()
local aTextfield = main:addTextfield()

-- User writes text into the Textfield
-- ...

-- Retrieve the text from the Textfield
local allText = table.concat(aTextfield.lines, "\\n")
basalt.debug(allText)
local main = basalt.createFrame()
local aTextfield = main:addTextfield()

-- User writes text into the Textfield
-- ...

-- Retrieve the text from the Textfield
local allText = table.concat(aTextfield.lines, "\\n")
basalt.debug(allText)
`,7),o=[l];function p(r,c,i,d,h,y){return e(),a("div",null,o)}const f=s(n,[["render",p]]);export{x as __pageData,f as default};