GuiGridListGetItemText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 17: Line 17:


==Example==  
==Example==  
This example creates a player list on resource start, clicking on it will output the selected player name to the chatbox.
This example creates a gridlist with entries "Hello" and "World!" and chooses randomly which of these two grid list items it will retrieve.
<section name="Click to Expand" class="client" show="false">
<syntaxhighlight lang="lua">function clientsideResourceStart ()
<syntaxhighlight lang="lua">function clientsideResourceStart ()
     local numberList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true ) --Create a gridlist
     local numberList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true ) --Create a gridlist
Line 35: Line 36:
outputChatBox ( "My gridlist item text: "..randomItemData ) --Output the randomly retrieved item text
outputChatBox ( "My gridlist item text: "..randomItemData ) --Output the randomly retrieved item text
end
end
addEventHandler ( "onClientResourceStart", getRootElement(), clientsideResourceStart )</syntaxhighlight>
addEventHandler ( "onClientResourceStart", getRootElement(), clientsideResourceStart )
</syntaxhighlight>
</section>
 
====Example 2====
 
This example creates a player list on resource start, clicking on it will output the selected player name to the chatbox.
<section name="Click to Expand" class="client" show="false">
<syntaxhighlight lang="lua">
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
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{GUI functions}}
{{GUI functions}}

Revision as of 07:05, 8 October 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 gridlist with entries "Hello" and "World!" and chooses randomly which of these two grid list items it will retrieve.

Click to expand [+]
Click to Expand

Example 2

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

Click to expand [+]
Click to Expand

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