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

guiGridListIsSortingEnabled

Client-side
Server-side
Shared

Manual Review Required

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

This function checks whether the gridlist sorting is enabled or disabled.

OOP Syntax Help! I don't understand this!

  • Method: guigridlist:isSortingEnabled(...)
  • Variable: .sortingEnabled

Syntax

bool guiGridListIsSortingEnabled ( element guiGridlist )
Required Arguments
  • guiGridlist: The GUI gridlist you wish to check if sorting is enabled or not.

Returns

  • bool: value

Returns true if sorting is enabled, false otherwise.

Code Examples

shared

Example 1:This example creates a gridlist with all server players and adds a command that enables and disables the gridlist sorting.

addEventHandler( "onClientResourceStart", resourceRoot,
  function()
    --Create the grid list element
    newGridlist = guiCreateGridList ( 0.50, 0.50, 0.20, 0.30, true )
    --Create a new grid list
    column = guiGridListAddColumn( newGridlist, "Players", 0.85 )
    showCursor( true )


    if ( column ) then --If the column has been created, fill it with players
      for id, player in ipairs(getElementsByType("player")) do
        local row = guiGridListAddRow ( newGridlist )
        guiGridListSetItemText ( newGridlist, row, column, getPlayerName ( player ), false, false )
      end
    end
  end
)


function toggleGridlistSortingState()


  local newStatus = not guiGridListIsSortingEnabled( newGridlist )


  outputChatBox( "The gridlist sorting is now ".. (newStatus and "Enabled" or "Disabled"), 230,230,230 )
  guiGridListSetSortingEnabled( newGridlist, newStatus ) -- Toggles the sorting for the gridlist
end
addCommandHandler( "togglesorting", toggleGridlistSortingState )

See Also

GUI Functions
GUI Elements
Reference