Multi Theft Auto: Wiki - User contributions [en]

BindKey

2013-02-15T16:01:14Z

Karthik184:

{{Server client function}}
__NOTOC__
Binds a player's key to a handler function or command, which will be called when the key is pressed.

==Syntax==
<section name="Server - Syntax 1" class="server" show="true">
<syntaxhighlight lang="lua">bindKey ( player thePlayer, string key, string keyState, function handlerFunction, [ var arguments, ... ] )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to bind the key of.
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys and [[control names]] for a list of possible controls.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''handlerFunction:''' The function that will be triggered when the player's key is pressed. This function should have the form:
:<syntaxhighlight lang="lua">function functionName ( player keyPresser, string key, string keyState, [ var arguments, ... ] )</syntaxhighlight>
:The values passed to this function are:
:*'''keyPresser:''' The player who pressed the key
:*'''key:''' The key that was pressed
:*'''keyState:''' The state of the key that was pressed, ''down'' if it was pressed, ''up'' if it was released.
:*'''arguments''' The optional arguments you specified when calling [[bindKey]] (see below).
</section>

{{New feature|3|1.0|
<section name="Server - Syntax 2" class="server" show="true">
This alternative syntax allows you to bind a key with a command. This will also allow users to customize the control in their Settings menu. Use in conjunction with [[addCommandHandler]] to add handler functions to the keybind.

<syntaxhighlight lang="lua">bindKey ( player thePlayer, string key, string keyState, string commandName, [ string arguments ] )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to bind the key of.
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''commandName:''' The name of the command that the key should be binded to.
*'''arguments''' Space delimited arguments that are entered as if one was typing the command.
</section>
}}

<section name="Client - Syntax 1" class="client" show="true">
<syntaxhighlight lang="lua">bindKey ( string key, string keyState, function handlerFunction, [ var arguments, ... ] ) </syntaxhighlight>

===Required Arguments===
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys and [[control names]] for a list of possible controls.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released

*'''handlerFunction:''' The function that will be triggered when the player's key is pressed. This function should have the form:
:<syntaxhighlight lang="lua">function functionName ( string key, string keyState, [ var arguments, ... ] )</syntaxhighlight>
:The values passed to this function are:
:*'''key:''' The key that was pressed
:*'''keyState:''' The state of the key that was pressed, ''down'' if it was pressed, ''up'' if it was released.
:*'''arguments''' The optional arguments you specified when calling [[bindKey]] (see below).
</section>

{{New feature|3|1.0|
<section name="Client - Syntax 2" class="client" show="true">
This alternative syntax allows you to bind a key with a command. This will also allow users to customize the control in their Settings menu. Use in conjunction with [[addCommandHandler]] to add handler functions to the keybind.

<syntaxhighlight lang="lua">bindKey ( string key, string keyState, string commandName, [ string arguments ] )</syntaxhighlight>

===Required Arguments===
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''commandName:''' The name of the command that the key should be binded to.
*'''arguments''' Space delimited arguments that are entered as if one was typing the command.
</section>
}}

===Optional Arguments===
{{OptionalArg}}
*'''arguments:''' Any arguments you may want to pass to the function when the key is pressed by the user. Any number of arguments of can be specified, each being passed to the designated function. You may not pass functions.

==Example==
Example 1
<section name="Server" class="server" show="true">
This example will bind a player's 'F1' key and 'fire' control to 1 input function.
<syntaxhighlight lang="lua">
function funcInput ( player, key, keyState )
local state = "let go of"
if ( keyState == "down" ) then
state = "pressed"
end
outputChatBox ( getPlayerName ( player) .. " " .. state .. " the " .. key .. " key!" )
end

function bindTheKeys ( player, commandName )
bindKey ( player, "F1", "down", funcInput ) -- bind the player's F1 down key
bindKey ( player, "F1", "up", funcInput ) -- bind the player's F1 up key
bindKey ( player, "fire", "both", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )
</syntaxhighlight>
</section>

Example 2
<section name="Client" class="client" show="true">
This example will bind a player's 'F1' key and 'fire' control to 1 input function, clientside.
<syntaxhighlight lang="lua">
function funcInput ( key, keyState )
local state = "let go of"
if ( keyState == "down" ) then
state = "pressed"
end
outputChatBox ( "You " .. state .. " the " .. key .. " key!" )
end

function bindTheKeys ()
bindKey ( "F1", "down", funcInput ) -- bind the player's F1 down key
bindKey ( "F1", "up", funcInput ) -- bind the player's F1 up key
bindKey ( "fire", "both", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example says how cool <s>Robpol86</s> Ransom is if players wants to move.
<syntaxhighlight lang="lua">
function fanFunction()
bindKey (source,"forwards","down",
function(player,key,state)
outputChatBox (getPlayerName (player) .. "#FFFF00 thinks Ransom is cool.",getRootElement(),255,255,0,true)
end
)
end
addEventHandler ("onPlayerLogin",getRootElement(),fanFunction)
</syntaxhighlight>
</section>

==See Also==
{{Input functions}}

SetPlayerVoiceBroadcastTo

2012-09-09T06:32:52Z

Karthik184: /* Example */

{{Server function}}
__NOTOC__
<div style="border: 1px dotted blue; background: #00CC66;padding:4px;margin-bottom:2px;">'''Note''': This function should only be used as a low-level function for advanced users. For typical Voice scripting, please see the [[Resource:Voice|Voice Resource]]</div>
This function allows you to change who can hear the voice of a player.

==Syntax==

<syntaxhighlight lang="lua">
bool setPlayerVoiceBroadcastTo ( element thePlayer, mixed broadcastTo )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The [[player]] you wish to change
*'''broadcastTo :''' Element or table of elements who should hear the voice from this player

===Returns===
Returns ''true'' if the value was set successfully, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function getPlayerFromName(...)
if( ... ) then
local foundList = {}
for i,v in ipairs( ... ) do
for i,p in ipairs( getElementsByType 'player' ) do
if( string.find( getPlayerName(p):lower(), tostring(v):lower(), 1, true ) then
table.insert( foundList, p )
end
end
end
return unpack( foundList )
end
return false
end

function setBroadcastTo( p, cmd, p1, p2 )
if( p1 and p2 ) then
p1, p2 = getPlayerFromName( p1, p2 )
if( p1 and p2 ) then
setPlayerVoiceBroadcastTo( p1, p2 )
else
outputChatBox( p1 == false and 'Player to change broadcast could not be found!' or p2 == false and 'Players to hear player 1 could not be found!', p, 255, 0, 0, false )
end
end
end
addCommandHandler( 'bt', setBroadcastTo )
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}

GuiGridListSetScrollBars

2012-06-24T06:32:30Z

Karthik184: /* Example */

{{Client function}}
__NOTOC__
This function allows a gridlist's scrollbar to be forced '''on''', or returned to default.

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetScrollBars ( element guiGridlist, bool horizontalBar, bool verticalBar )
</syntaxhighlight>

===Required Arguments===
*'''guiGridlist:''' The GUI gridlist you wish to change the state of scrollbars
*'''horizontalBar:''' A bool where ''true'' forces the horizontal scrollbar on, and ''false'' returns them to default.
*'''verticalBar:''' A bool where ''true'' forces the verical scrollbar on, and ''false'' returns them to default.

===Returns===
Returns ''true'' if the scrollbars were successfully set, ''false'' otherwise.

==Example==
This example creates a gridlist and checks if it's created then sets the scroll bars. (TESTED!)
<syntaxhighlight lang="lua">gridlist = guiCreateGridList(332,195,286,249,false)

if(gridlist)then
guiGridListSetScrollBars(gridlist,true,true)
end
</syntaxhighlight>

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

User:Karthik184

2012-06-23T09:32:05Z

Karthik184: Created page with "Hi"

GuiGridListSetItemData

2012-04-07T06:41:07Z

Karthik184: /* Example */

{{Client function}}
__NOTOC__
This function sets a Item Data associated to a grid list item.<br/>
'''Note:''' This function will only work '''after''' you set the item's text using [[guiGridListSetItemText]]!

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetItemData ( element gridList, int rowIndex, int columnIndex, string data )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' A gridlist element of the data you wish to set to
*'''rowIndex:''' The row of the item you wish to set to
*'''columnIndex:''' The column of the item you wish to set to
*'''data:''' The data you wish to set to the item.

===Returns===
Returns ''true'' if the data was set successfully, false otherwise

==Example==
In this example, the gridlist shows the list of players without their color codes and outputs their names with color-codes at the chatbox when player is selected.
<syntaxhighlight lang="lua">
function showPlayers()
local window = guiCreateWindow(0,0,500,400,"Window example - Title",false) -- Create the window
grid = guiCreateGridList(0,0,100,300,false,window) -- Create the gridlist
local column = guiGridListAddColumn(grid, "Players online", 0.9) -- Create a column
showCursor(true)--show cursor
for index,player in ipairs(getElementsByType("player")) do -- Loop through all players
local row = guiGridListAddRow(grid) -- Add a row
guiGridListSetItemText ( grid, row, column, (string.gsub ( getPlayerName(player), '#%x%x%x%x%x%x', '' ) or getPlayerName(player)), false, false) -- Set it's text to the player's name excluding colorcodes
guiGridListSetItemData ( grid, row, column, getPlayerName(player)) -- Set it's data to the player's name with colorcodes
end
end

function outputPlayerName()
if source == grid then -- If the player clicked something in the grid
local selectedRow, selectedColumn = guiGridListGetSelectedItem(grid) -- See which player he selected
local playerName = guiGridListGetItemData(grid, selectedRow, selectedColumn) -- Get the selected player's name with color codes local playerNameWithoutColorCodes = guiGridListGetItemText(grid, selectedRow, selectedColumn) -- Get the selected player's name without color codes
local playerNameWithoutColorCodes = guiGridListGetItemText(grid, selectedRow, selectedColumn) -- Get the selected player's name without color codes
if playerName and playerNameWithoutColorCodes then -- If he really selected something
outputChatBox("The selected player's name without color codes : "..playerNameWithoutColorCodes, 255,255,255,false) -- output without color codes
outputChatBox("The selected player's name with color codes : "..playerName, 255,255,255,false) -- output with color codes
outputChatBox("The selected player's name with colors : "..playerName, 255,255,255,true) -- output with colors
end
end
end

addEventHandler("onClientGUIClick", getRootElement(), outputPlayerName)
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), showPlayers)</syntaxhighlight>

==See Also==
{{GUI functions}}
[[Category:Needs Example]]

GuiGridListSetItemData

2012-04-07T06:32:18Z

Karthik184: /* Example */

{{Client function}}
__NOTOC__
This function sets a Item Data associated to a grid list item.<br/>
'''Note:''' This function will only work '''after''' you set the item's text using [[guiGridListSetItemText]]!

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetItemData ( element gridList, int rowIndex, int columnIndex, string data )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' A gridlist element of the data you wish to set to
*'''rowIndex:''' The row of the item you wish to set to
*'''columnIndex:''' The column of the item you wish to set to
*'''data:''' The data you wish to set to the item.

===Returns===
Returns ''true'' if the data was set successfully, false otherwise

==Example==
In this example, the gridlist shows the list of players without their color codes and outputs their names with color-codes at the chatbox when player is selected.
<syntaxhighlight lang="lua">
function showPlayers()
local window = guiCreateWindow(0,0,500,400,"Window example - Title",false) -- Create the window
grid = guiCreateGridList(0,0,100,300,false,window) -- Create the gridlist
local column = guiGridListAddColumn(grid, "Players online", 0.9) -- Create a column
showCursor(true)--show cursor
for index,player in ipairs(getElementsByType("player")) do -- Loop through all players
local row = guiGridListAddRow(grid) -- Add a row
guiGridListSetItemText ( grid, row, column, (string.gsub ( getPlayerName(player), '#%x%x%x%x%x%x', '' ) or getPlayerName(player)), false, false) -- Set it's text to the player's name excluding colorcodes
guiGridListSetItemData ( grid, row, column, getPlayerName(player)) -- Set it's data to the player's name with colorcodes
end
end

function outputPlayerName()
if source == grid then -- If the player clicked something in the grid
local selectedRow, selectedColumn = guiGridListGetSelectedItem(grid) -- See which player he selected
local playerName = guiGridListGetItemData(grid, selectedRow, selectedColumn) -- Get the selected player's name with color codes
local playerNameWithoutColorCodes = guiGridListGetItemText(grid, selectedRow, selectedColumn) -- Get the selected player's name without color codes
outputChatBox("The selected player's name without color codes : "..playerNameWithoutColorCodes, 255,255,255,false) -- output without color codes
outputChatBox("The selected player's name with color codes : "..playerName, 255,255,255,false) -- output with color codes
outputChatBox("The selected player's name with colors : "..playerName, 255,255,255,true) -- output with colors
end
end

addEventHandler("onClientGUIClick", getRootElement(), outputPlayerName)
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), showPlayers)
</syntaxhighlight>

==See Also==
{{GUI functions}}
[[Category:Needs Example]]

GuiGridListSetItemData

2012-04-07T06:25:47Z

Karthik184: /* Example */

{{Client function}}
__NOTOC__
This function sets a Item Data associated to a grid list item.<br/>
'''Note:''' This function will only work '''after''' you set the item's text using [[guiGridListSetItemText]]!

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetItemData ( element gridList, int rowIndex, int columnIndex, string data )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' A gridlist element of the data you wish to set to
*'''rowIndex:''' The row of the item you wish to set to
*'''columnIndex:''' The column of the item you wish to set to
*'''data:''' The data you wish to set to the item.

===Returns===
Returns ''true'' if the data was set successfully, false otherwise

==Example==
In this example, the gridlist shows the list of players without their color codes and outputs their names with color-codes at the chatbox when player is selected.
<syntaxhighlight lang="lua">
function showPlayers()
local window = guiCreateWindow(0,0,500,400,"Window example - Title",false) -- Create the window
local grid = guiCreateGridList(0,0,100,300,false,window) -- Create the gridlist
local column = guiGridListAddColumn(grid, "Players online", 0.9) -- Create a column
for index,player in ipairs(getElementsByType("player")) do -- Loop through all players
local row = guiGridListAddRow(grid) -- Add a row
guiGridListSetItemText ( grid, row, column, (string.gsub ( getPlayerName(player), '#%x%x%x%x%x%x', '' ) or getPlayerName(player)), false, false) -- Set it's text to the player's name excluding colorcodes
guiGridListSetItemData ( grid, row, column, getPlayerName(player)) -- Set it's data to the player's name with colorcodes
end
end

function outputPlayerName()
if source == grid then -- If the player clicked something in the grid
local selectedRow, selectedColumn = guiGridListGetSelectedItem(grid) -- See which player he selected
local playerName = guiGridListGetItemData(grid, selectedRow, selectedColumn) -- Get the selected player's name with color codes
local playerNameWithoutColorCodes = guiGridListGetItemText(grid, selectedRow, selectedColumn) -- Get the selected player's name without color codes
outputChatBox("The selected player's name without color codes : "..playerNameWithoutColorCodes, 255,255,255,false) -- output without color codes
outputChatBox("The selected player's name with color codes : "..playerName, 255,255,255,false) -- output with color codes
outputChatBox("The selected player's name with colors : "..playerName, 255,255,255,true) -- output with colors
end
end

addEventHandler("onClientGUIClick", getRootElement(), outputPlayerName)
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), showPlayers)
</syntaxhighlight>

==See Also==
{{GUI functions}}
[[Category:Needs Example]]