GuiGridListGetRowCount: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(Replace to predefined variables.)
 
(11 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__  
{{Client function}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
__NOTOC__
This fake function is for use with blah & blah and does blahblahblabhalbhl
This function returns the number of rows in a grid list.


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
returnType functionName ( arguments )
int guiGridListGetRowCount ( element gridList )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:getRowCount|rowCount}}


===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''gridList:''' The grid list to get the number of rows from.
*'''argumentName:''' description
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns the number of rows if the function is successful, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example creates a gui grid list, fills it with the names of the connected players and prints the number of rows (players) in the chatbox.
This example does...
<syntaxhighlight lang="lua">function onClientResourceStart ()
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
        -- Create the grid list element
<syntaxhighlight lang="lua">
        local playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
--This line does...
        -- Create a players column in the list
blabhalbalhb --abababa
        local column = guiGridListAddColumn( playerList, "Player", 0.85 )
--This line does this...
        if ( column ) then -- If the column was successfully created
mooo
                --Loop through adding players to the grid list
</syntaxhighlight>
                for id, playeritem in ipairs(getElementsByType("player")) do
                        local row = guiGridListAddRow ( playerList )
                        guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
                end
                outputChatBox ( "Number of player list rows: " .. guiGridListGetRowCount ( playerList ) )
        end
end
addEventHandler ( "onClientResourceStart", resourceRoot, onClientResourceStart )</syntaxhighlight>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{GUI functions}}
{{GUI functions}}
[[Category:Incomplete]]
{{GUI_events}}

Latest revision as of 09:18, 12 July 2023

This function returns the number of rows in a grid list.

Syntax

int guiGridListGetRowCount ( element gridList )

OOP Syntax Help! I don't understand this!

Method: GuiGridList:getRowCount(...)
Variable: .rowCount


Required Arguments

  • gridList: The grid list to get the number of rows from.

Returns

Returns the number of rows if the function is successful, false otherwise.

Example

This example creates a gui grid list, fills it with the names of the connected players and prints the number of rows (players) in the chatbox. 

function onClientResourceStart ()
        -- Create the grid list element
        local 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 was successfully created
                --Loop through adding players to the grid list
                for id, playeritem in ipairs(getElementsByType("player")) do 
                        local row = guiGridListAddRow ( playerList )
                        guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
                end
                outputChatBox ( "Number of player list rows: " .. guiGridListGetRowCount ( playerList ) )
        end
end
addEventHandler ( "onClientResourceStart", resourceRoot, onClientResourceStart )

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

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiGridListGetRowCount?oldid=77165"