Resource:Custom edit

2021-08-12T11:13:40Z

Whitee: /* Example */

{{Resource page}}
__NOTOC__
This resource allow you to create custom editbox.
Download [https://github.com/sirphantasm/custom_edit GitHub].<br>
Resource developed by: sirphantasm

==Exported functions/events==
<section name="Functions/Events" class="client" show="true">
By this function you can create new editbox with variable.
<syntaxhighlight lang="lua">
bool createCustomEdit(string default-text, float x, float y, float z, bool postgui, string placeholder, bool masked, filepath font, table activecolor, table fontcolor table backgroundcolor, table caretcolor, bool visible, number length, number fontsize)
</syntaxhighlight>
====Required Arguments====
*'''text:''' Default text to draw in the editbox. Recommended "".
*'''x:''' A float of the 2D screen x position.
*'''y:''' A float of the 2D screen y position.
*'''width:''' A float of the 2D screen y position.
*'''heigth:''' A float of the 2D screen y position.

====Optional arguments====
{{OptionalArg}}
*'''postGUI:''' A bool representing whether the text should be drawn on top of or behind any ingame GUI (default false).
*'''placeHolder:''' A string of the placeholder text of editbox (default false).
*'''masked:''' covering up the text being typed for password text fields (default false).
*'''font:''' Name of font from folder "fonts" (default false, arial).
*'''activeColor:''' Color of line on the bottom when edit is active (default red).
*'''fontColor:''' Color of font (default white).
*'''backgroundColor:''' Color of editbox (default black).
*'''caretColor:''' Color of caret in text field (default white).
*'''visible:''' Visibility of editbox (default true).
*'''length:''' Max length for text field (default 40).
*'''font size:''' Available for DXFont (default scaled to edit size).
====Returns====
Returns ID if element was successfully created, false otherwise.

----

This function change visibility of editbox.
<syntaxhighlight lang="lua">
bool editSetVisible(element theElement, bool state)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change.
*'''state:''' true or false.
====Returns====
Returns true if successfully , false otherwise.

----

This function set mask to password fields
<syntaxhighlight lang="lua">
bool editSetMasked(element theElement, bool mask)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to set mask.
*'''state:''' true of false.
====Returns====
Returns true if editbox will be masked, false otherwise.

----

This function gets text from text field.
<syntaxhighlight lang="lua">
bool editGetText(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element from where you want to get text.
====Returns====
Returns string text if successfully , false otherwise.

----

This function changes text into text field.
<syntaxhighlight lang="lua">
bool editSetText(element theElement, string text)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change text.
*'''text:''' New value.
====Returns====
Returns true if text set successfully, false otherwise.

----

This function changes max length od text field
<syntaxhighlight lang="lua">
bool editMaxLength(element theElement, float length)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change length.
*'''length:''' New value.
====Returns====
Returns true if length set successfully, false otherwise.

----

This function change 2D position on the screen.
<syntaxhighlight lang="lua">
bool editChangePos(element theElement, float x, float y)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change position.
*'''x:''' 2D x position.
*'''y:''' 2D y position.
====Returns====
Returns true if succesfully, false otherwise.

----

This function changes all properties of editbox
<syntaxhighlight lang="lua">
bool editSetProperty(element theElement, string properties, string value)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change property.
*'''property:''' id,x,y,w,h,postgui,placeholder,masked,font,size,active,activecolor,bgcolor,caret,visible,cursor,maxLength,click,alpha,readOnly.
====Returns====
Returns true if properties set successfully, false otherwise.

----

This function destroy editbox
<syntaxhighlight lang="lua">
bool destroyCustomEdit(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to destroy.
====Returns====
Returns true if destroy successfully, false otherwise.

----

{{Client event}}
This event trigger when you blur edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who blur edit.

==Example==
This example shows how to use "onCustomEditLeave"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditLeave",root,function(edit)
print("You leave edit "..edit)
end)
</syntaxhighlight>

----

{{Client event}}
This event trigger when you blur edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who focus edit.

==Example==

This example shows how to use "onCustomEditFocus"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditFocus",root,function(edit)
print("You focus edit "..edit)
end)
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="client" show="true">
This example creates editbox with some accessories.
<syntaxhighlight lang="lua">
local ce=exports.custom_edit

local edit=ce:createCustomEdit("",500,500,300,70,false,"Password",false,"font2",{255,0,0,255},{255,255,255,255},{0,0,0,150},{255,255,255,255},true,false,false)
ce:editSetMasked(edit,true)
ce:editSetProperty(edit,"bgcolor",{255,255,255,255})
ce:editChangePos(edit,700,700)
ce:editMaxLength(edit,50)
</syntaxhighlight>
</section>

guwniany kod^

Multi Theft Auto: Wiki - User contributions [en]

Resource:Custom edit