Sybellex: Created page with "= DxEdit:new / Astrath:createEditBox = {{Client function}} {{FuncDef|element DxEdit:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, string font, float fontsize, string placeholder )}} '''Description:''' Creates a new DX-based edit box element. Edit boxes allow text input with options for read-only mode, numeric-only input, hover effects, and color customization. Each edit box instance is automatically registered i..."

2025-10-22T19:48:22Z

Created page with "= DxEdit:new / Astrath:createEditBox = {{Client function}} {{FuncDef|element DxEdit:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, string font, float fontsize, string placeholder )}} '''Description:''' Creates a new DX-based edit box element. Edit boxes allow text input with options for read-only mode, numeric-only input, hover effects, and color customization. Each edit box instance is automatically registered i..."

New page

= DxEdit:new / Astrath:createEditBox =

{{Client function}}
{{FuncDef|element DxEdit:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, string font, float fontsize, string placeholder )}}

'''Description:'''
Creates a new DX-based edit box element. Edit boxes allow text input with options for read-only mode, numeric-only input, hover effects, and color customization. Each edit box instance is automatically registered in the DX library.

'''Parameters:'''
* text (string) – Initial text for the edit box (optional).
* posX, posY (float) – Position on screen.
* width, height (float) – Size of the edit box.
* parent (element) – Parent DX element to attach this edit box to (optional).
* relative (boolean) – Position relative to parent (optional).
* font (string) – Font used for the text (optional, default: "default-bold").
* fontsize (float) – Font size multiplier (optional, default: 1).
* placeholder (string) – Placeholder text when the edit box is empty (optional).

'''Returns:'''
: Returns the newly created DxEdit element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the edit box and all its child elements.
|-
| Ath:clear() || Clears all text and resets the cursor.
|-
| Ath:setVisible(boolean) || Shows or hides the edit box.
|-
| Ath:setEnabled(boolean) || Enables or disables the edit box for interaction.
|-
| Ath:setReadOnly(boolean) || Enables or disables read-only mode.
|-
| Ath:setNumericOnly(boolean) || Enables numeric-only input.
|-
| Ath:getReadOnly() || Returns whether the edit box is in read-only mode.
|-
| Ath:setText(string) || Sets the text of the edit box.
|-
| Ath:getText() || Returns the current text of the edit box.
|-
| Ath:setHoverable(boolean) || Enables or disables hover effect.
|-
| Ath:setColor(r, g, b, a, type) || Sets the main background or hover color of the edit box.
|}

'''Example:'''
<syntaxhighlight lang="lua">
-- Create an edit box at position 400x200 with size 200x25
local myEdit = DxEdit:new("", 400, 200, 200, 25)

-- Set placeholder text
myEdit.placeholder = "Enter your name..."

-- Enable numeric only
myEdit:setNumericOnly(true)

-- Show edit box and enable hover
myEdit:setVisible(true)
myEdit:setHoverable(true)

-- Set background color to light grey
myEdit:setColor(200, 200, 200, 255, "mainColor")
</syntaxhighlight>

'''See also:'''
* [[Astrath]] – Main library page
* [[DxButton:new]] – Page for button element reference
* [[DxCheckbox:new]] – Page for checkbox element reference
* [[DxCombobox:new]] – Page for combobox element reference
* [[onClientRender]] – Event used to render DX elements

Astrath:createEditBox - Revision history