guiEditSetCaretIndex | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

guiEditSetCaretIndex

Client-side
Server-side
Shared

Pair: guiEditGetCaretIndex

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function sets the current position of the caret (the text cursor) within the edit box.

OOP Syntax Help! I don't understand this!

  • Method: guiedit:setCaretIndex(...)
  • Variable: .caretIndex

Syntax

bool guiEditSetCaretIndex ( element theElement, int index )
Required Arguments
  • theElement: The edit box to be changed.
  • index: An integer referring to the desired position within the box.

Returns

  • bool: value

Returns true if the index was successfully set, false otherwise.

Code Examples

shared

This example makes the text cursor jump to the end of an edit box if the user is holding the Left Control button.

function moveToEndOnClick()
  if ( getKeyState ( "lctrl" ) == true ) and ( getElementType(source) == "gui-edit" ) then          -- if the user is holding down left control
    local text = guiGetText ( source )
    local textLength = string.len ( text )
    guiEditSetCaretIndex ( source, textLength )  -- set the caret index. No need to check if the clicked control is actually an edit box as this function won't work on other controls anyway
  end
end
addEventHandler ( "onClientGUIClick", root, moveToEndOnClick )    -- add an event handler for clicks

See Also

GUI Functions
GUI Elements
Reference