GuiGridListGetItemText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
This function gets the text from a given grid list item row+column
This function retrieves the text from a specific grid list item.


==Syntax==  
==Syntax==  
Line 8: Line 8:


===Required Arguments===  
===Required Arguments===  
*'''theElement:''' the gridlist you want to get item text of
*'''theElement:''' the gridlist containing the item you're interested in
*'''rowIndex:''' row id
*'''rowIndex:''' row id of the item
*'''columnIndex:''' column id
*'''columnIndex:''' column id of the item


===Returns===
===Returns===
Returns ''string'' - the text in the item if the arguments are right, ''false'' if not.
Returns the text of the item if the arguments are right, ''false'' otherwise.


==Example==  
==Example==  
This example creates a player list on resource start, clicking on it will output the selected player name to chatbox
This example creates a player list on resource start, clicking on it will output the selected player name to the chatbox.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local playerList
function createPlayerList ()
function createPlayerList ()
         --Create the grid list element
         -- Create the grid list
         playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
         playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
         --Create a players column in the list
         -- Create a players column in the list
         local column = guiGridListAddColumn( playerList, "Player", 0.85 )
         local column = guiGridListAddColumn( playerList, "Player", 0.85 )
         if ( column ) then --If the column has been created, fill it with players
         if ( column ) then         -- If the column has been created, fill it with players
                 for id, player in ipairs(getElementsByType("player")) do
                 for id, playeritem in ipairs(getElementsByType("player")) do
                         local row = guiGridListAddRow ( playerList )
                         local row = guiGridListAddRow ( playerList )
                         guiGridListSetItemText ( playerList, row, column, getPlayerName ( player ), false, false )
                         guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
                 end
                 end
                 addEventHandler ( "onClientClick", getRootElement(), click )
                 addEventHandler ( "onClientClick", playerList, click )
         end
         end
end
end
addEventHandler ( "onClientResourceStart", getRootElement(), createPlayerList )
addEventHandler ( "onClientResourceStart", getRootElement(), createPlayerList )
function click ( button, state, sx, sy, x, y, z, element, gui )
 
         -- if state is down ( not to trigger the function twice on click up/down), clicked gui and the element is our player list
function click ( button, state, sx, sy, x, y, z, elem, gui )
         -- if state is down ( not to trigger the function twice on mouse button up/down), clicked gui and the element is our player list
         if ( ( state == "down" ) and ( gui == true ) and ( source == playerList ) ) then
         if ( ( state == "down" ) and ( gui == true ) and ( source == playerList ) ) then
                 -- we get the player name from the selected row, first column  
                 -- get the player name from the selected row, first column  
                 local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList ), 1 )
                 local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList ), 1 )
                 outputChatBox ( playerName ) --output it to chat box
                 outputChatBox ( playerName )     -- output it to chat box
         end
         end
end
end

Revision as of 16:14, 18 August 2007

This function retrieves the text from a specific grid list item.

Syntax

string guiGridListGetItemText ( element theElement, int rowIndex, int columnIndex )

Required Arguments

  • theElement: the gridlist containing the item you're interested in
  • rowIndex: row id of the item
  • columnIndex: column id of the item

Returns

Returns the text of the item if the arguments are right, false otherwise.

Example

This example creates a player list on resource start, clicking on it will output the selected player name to the chatbox.

local playerList
function createPlayerList ()
        -- Create the grid list
        playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
        -- Create a players column in the list
        local column = guiGridListAddColumn( playerList, "Player", 0.85 )
        if ( column ) then         -- If the column has been created, fill it with players
                for id, playeritem in ipairs(getElementsByType("player")) do
                        local row = guiGridListAddRow ( playerList )
                        guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
                end
                addEventHandler ( "onClientClick", playerList, click )
        end
end
addEventHandler ( "onClientResourceStart", getRootElement(), createPlayerList )

function click ( button, state, sx, sy, x, y, z, elem, gui )
        -- if state is down ( not to trigger the function twice on mouse button up/down), clicked gui and the element is our player list
        if ( ( state == "down" ) and ( gui == true ) and ( source == playerList ) ) then
                -- get the player name from the selected row, first column 
                local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList ), 1 )
                outputChatBox ( playerName )     -- output it to chat box
        end
end

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows