an edit box element. More...

Inheritance diagram for CreateEditBox:

Public Member Functions
	CreateEditBox (int x=0, int y=0, int w=80, int h=37, string text="")
	create an edit box. More...

element	setText (string text)
	sets the editbox text. More...

string	getText ()
	gets the editbox text. More...

int	getTextWidth ()
	get the width of the text. More...

int	getTextHeight ()
	get the height of the text. More...

int	getCursorPos ()
	gets the index of the text that the cursor is currently on. More...

int	getLineFromPos (int pos)
	gets the line number of the text from an index position. More...

element	setMultiLine (bool multiLine=true)
	sets whether new lines can be used. More...

element	setWordWrap (bool wordWrap=true)
	sets whether words should leave the element width, or create a new line. More...

element	setAutoScroll (bool autoScroll=true)
	sets whether or not the editbox scrolls on its own when typing. More...

element	setDrawBackground (bool drawBackground=true)
	sets whether the background should be visible or not. More...

element	setDrawBorder (bool setDrawBorder=true)
	sets whether the border should be visible or not. More...

element	setPasswordBox (bool passwordBox=true)
	sets whether the edit box is a password box. More...

Public Member Functions inherited from element
conditional< string, bool >	runScript ()
	run the element's script once. More...

element	setRunScript (bool runScript=true)
	runs the script each frame. More...

element	setScript (string code)
	set the element's script. More...

string	getScript ()
	get the current code of the element. More...

conditional< string, bool >	doScriptString (string code)
	does a script string. More...

element	blockFunction (string functionName, bool block=true)
	blocks a function from being used outside of the current script. More...

string	getID ()
	get the ID of the element. More...

bool	setID (string ID)
	set the ID of the element. More...

float	getX ()
	get the X axis of the element. More...

float	getY ()
	get the Y axis of the element. More...

float	getWidth ()
	get the width of the element. More...

float	getHeight ()
	get the height of the element. More...

element	bringToFront ()
	brings the element to the top-most layer. More...

element	bringToBack ()
	brings the element to the bottom-most layer. More...

element	setX (float X)
	sets the X axis of the element More...

element	setY (float Y)
	sets the Y axis of the element. More...

element	setWidth (float width)
	sets the width of the element. More...

element	setWidth (float height)
	sets the height of the element. More...

element	setScale (float scale)
	sets the scale of the element. More...

element	setScale (float widthScale, float heightScale)
	sets the width and height scale of the element. More...

element	setMaintainAspectRatio (bool maintainAspectRatio=true)
	sets whether or not changing the width/height maintains aspect ratio scaling. More...

element	center ()
	centers the element. More...

element	setScalePosition ()
	sets that setScale() should also scale the element's position. More...

element	setScalePosition (bool scalePosition)
	sets whether or not setScale() should also scale the element's position. More...

element	setScalePosition (bool scaleX, bool scaleY)
	sets whether or not setScale() should also scale the element's X and Y position. More...

element	setCollisionWith (element elem)
	add collision with another element. More...

element	removeCollisionWith (element elem)
	removes the collision with another element. More...

element	setMinWidth (float minWidth)
	sets the minimum resize width. More...

element	setMinHeight (float minHeight)
	sets the minimum resize height. More...

element	setMaxWidth (float maxWidth)
	sets the maximum resize width. More...

element	setMaxHeight (float maxHeight)
	sets the maximum resize height. More...

string	getType ()
	get the type of this element. More...

element	setPosition (float X, float Y)
	set the position of the element. More...

multiReturn< float, float >	getPosition ()
	gets the position of the element. More...

element	setTabEnabled (bool enabled=true)
	sets whether or not you can tab to get to this element. More...

element	setTabOrder (int orderNo)
	sets the order in which this element can be tabbed to. More...

element	setClipped (bool clipped)
	sets whether the element should be cut off by it's rectangle. More...

element	setDPIAware (bool dpiAware=true)

element	setDefaultControls (bool defaultControls, float speed)
	sets whether the element can be moves with keys. More...

element	setFocused (bool focused=true)
	set the focus of the element. More...

bool	isFocused ()
	get whether or not the element is in focus. More...

element	setMovable (bool movable=true, int movableHeight=-1)
	sets the movability of the element. More...

element	setMovableBoundaries (int x, int y, int endX, int endY)
	sets the movable boundaries. More...

multiReturn< int, int, int, int >	getMovableBoundaries ()
	gets the movable boundaries. More...

bool	hitsBoundary (string direction)
	checks if the element has collided with a boundary. More...

element	setResizable (bool resizable=true)
	sets whether the element is resizable. More...

element	setResizableDepth (int resizableDepth)
	sets the depth of the pixels the user must click to resize an element. More...

element	setRect (int x, int y, int width, int height)
	sets the rectangle of the element. More...

element	hide ()
	sets the element to be invisible. More...

element	show ()
	sets the element to be visible. More...

element	setVisible (bool visible=true)
	sets the visibility of the element. More...

bool	isVisible ()
	get the visibility of the element. More...

element	addElement (element elem)
	adds a child element. More...

element	setParent (element elem)
	adds this element as a child of the given element. More...

element	removeElement (element elem)
	removes a child element. More...

element[]	getElements ()
	gets all child elements. More...

element	getParent ()
	get the parent element. More...

element	resetLayers ()
	resets the order of the layers. More...

void	remove ()
	removes the element. More...

string	getObject (bool includeChildren=true)
	get the element as a total object. More...

element	doCommands (string cmd)
	creates the element from an object like a server command. More...

element	removeFromClients ()
	removes the element from all online clients. More...

element	sendToClients (bool removeOthers=false, string key="", string keyAns="")
	sends the element to all connected clients who meet the criteria. More...

element	setProperty (string property, string value)
	sets a property of the element to be sent next. More...

string	getProperty (string property)
	gets the value of a set property. More...

string[]	getProperties ()
	gets all properties from the object. More...

element	removeProperty (string property)
	removes a property from the object. More...

element	clearProperties ()
	removes all properties from the object. See removeProperty() More...

bool	setParentScript (string scriptPath)
	sets the parent script. More...

Public Member Functions inherited from event
void	setEventListener (ElementEvent event, function func,...)
	sets a function to run on the given event. Removes all other event listeners of the same event type. More...

void	addEventListener (ElementEvent event, function func,...)
	adds a function to run on the given event. More...

Additional Inherited Members
Static Public Member Functions inherited from element
static void	drawRectangle (int x, int y, int width=100, int height=50, bool border=false, int r=0, int g=0, int b=0, int a=255, clipX=0, clipY=0, clipWidth=game:getWindowWidth(), clipHeight=game:getWindowHeight())
	draws a 2D rectangle on top of the element. More...

Detailed Description

an edit box element.

Constructor & Destructor Documentation

◆ CreateEditBox()

CreateEditBox::CreateEditBox	(	int	x = `0`,
		int	y = `0`,
		int	w = `80`,
		int	h = `37`,
		string	text = `""`
	)

create an edit box.

   Creates a text box with either the environment's font or the default font that be can be typed into.\n
   Derives all element functions.

Parameters

(optional)	The X axis the editbox should be placed on the screen.
(optional)	The Y axis the editbox should be placed on the screen.
(optional)	The width of the editbox.
(optional)	The height of the editbox.
(optional)	The text of the editbox.

Member Function Documentation

◆ getCursorPos()

int CreateEditBox::getCursorPos ( )

gets the index of the text that the cursor is currently on.

Returns: The position of the cursor.

◆ getLineFromPos()

int CreateEditBox::getLineFromPos ( int pos )

gets the line number of the text from an index position.

Parameters

The	position to get the line from.

Returns: The line of the text.

◆ getText()

string CreateEditBox::getText ( )

gets the editbox text.

Returns: The text of the editbox.

◆ getTextHeight()

int CreateEditBox::getTextHeight ( )

get the height of the text.

   Get the absolute height of the text. Not to be confused with element:getWidth(), this instead
   gets the height of exactly how many pixels long of text is being used.

Returns: The height of the text.

◆ getTextWidth()

int CreateEditBox::getTextWidth ( )

get the width of the text.

   Get the absolute width of the text. Not to be confused with element:getWidth(), this instead
   gets the width of exactly how many pixels wide of text is being used.

Returns: The width of the text.

◆ setAutoScroll()

element CreateEditBox::setAutoScroll ( bool autoScroll = true )

sets whether or not the editbox scrolls on its own when typing.

Parameters

Whether or not the editbox scrolls automatically.

Returns: Returns itself.

◆ setDrawBackground()

element CreateEditBox::setDrawBackground ( bool drawBackground = true )

sets whether the background should be visible or not.

Parameters

(optional) Whether the background should be drawn or not.

Returns: Returns itself.

◆ setDrawBorder()

element CreateEditBox::setDrawBorder ( bool setDrawBorder = true )

sets whether the border should be visible or not.

Parameters

(optional) Whether the border should be drawn or not.

Returns: Returns itself.

◆ setMultiLine()

element CreateEditBox::setMultiLine ( bool multiLine = true )

sets whether new lines can be used.

   False by default, sets whether or not new lines (using the "enter" key or copy-pasted) are accepted.

Parameters

(optional) Whether or not new lines can be used.

Returns: Returns itself.

◆ setPasswordBox()

element CreateEditBox::setPasswordBox ( bool passwordBox = true )

sets whether the edit box is a password box.

   Sets whether or not the edit box should display text as asterisks (*) instead of text.
   CreateEditBox:getText() still returns the normal text as a password box.

Parameters

Whether the edit box is a password box or not.

Returns: Returns itself.

◆ setText()

element CreateEditBox::setText ( string text )

sets the editbox text.

Parameters

The	new text of the editbox.

Returns: Returns itself.

◆ setWordWrap()

element CreateEditBox::setWordWrap ( bool wordWrap = true )

sets whether words should leave the element width, or create a new line.

   False by default, sets whether or not text that goes out of the width of the element should move to the next line instead.

Parameters

(optional) Whether words should leave the element, or go to a new line.

Returns: Returns itself.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateEditBox()

Member Function Documentation

◆ getCursorPos()

◆ getLineFromPos()

◆ getText()

◆ getTextHeight()

◆ getTextWidth()

◆ setAutoScroll()

◆ setDrawBackground()

◆ setDrawBorder()

◆ setMultiLine()

◆ setPasswordBox()

◆ setText()

◆ setWordWrap()