Multi Theft Auto: Wiki - User contributions [en]

ShowChat

2014-08-25T20:18:48Z

Et-win: /* Example */ Added an example for MTA 1.4 and up, since 'isChatVisible' is now a function in MTA itself.

__NOTOC__
{{Server client function}}
This function is used to show or hide the player's chat.

==Syntax==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool showChat ( bool show )
</syntaxhighlight>

===Required Arguments===
*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.

===Returns===
Returns ''true'' if the player's chat was shown or hidden successfully, ''false'' otherwise.
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool showChat ( player thePlayer, bool show )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The [[player]] whose chat is to be hidden or shown.
*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.

===Returns===
Returns ''true'' if the player's chat was shown or hidden successfully, ''false'' otherwise.
</section>

==Example==
<section name="Client" class="client" show="true">
This example toggle's the player's chat when they press the "'''i'''" key.
<syntaxhighlight lang="lua">
--This example below is for all versions until 1.4:
local isChatVisible = true --Let's assume the chat is visible as soon as the resource starts.

function chat(key, keyState)
if isChatVisible then --Check or the chat is visible.
showChat(false) --If it is, hide it.
isChatVisible = false
else
showChat(true) --If it is not, show it.
isChatVisible = true
end
end

bindKey("i", "down", chat) --Make a bind key to start the function as soon as a player presses the key 'i'

--This example below is for version 1.4 and up:
function chat(key, keyState)
if isChatVisible() then --Check or the chat is visible.
showChat(false) --If it is, hide it.
else
showChat(true) --If it is not, show it.
end
end

bindKey("i", "down", chat) --Make a bind key to start the function as soon as a player presses the key 'i'
</syntaxhighlight>
</section>

==See Also==
{{Server functions}}

BindKey

2014-08-11T14:25:30Z

Et-win: Added 'Returns'

{{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.
===Optional Arguments===
*'''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.

===Returns===
Returns ''true'' if the key was bound, ''false'' otherwise.

===Issues===
{{Issues|
{{Issue|7948|bindKey using a command and control name doesn't work}}
}}

==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> <s>Ransom</s> <s>Aintaro</s> ADCX is if players wants to move.
<syntaxhighlight lang="lua">
function fanFunction()
bindKey (source,"forwards","down",
function(player,key,state)
outputChatBox (getPlayerName (player) .. "#FFFF00 thinks ADCX is cool.",getRootElement(),255,255,0,true)
end
)
end
addEventHandler ("onPlayerLogin",getRootElement(),fanFunction)
</syntaxhighlight>
</section>

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

XmlNodeGetChildren

2014-08-11T10:57:42Z

Et-win: /* Returns */ Added "If no nodes are found, it returns an empty table." @ Returns

__NOTOC__
{{Server client function}}

This function returns all children of a particular XML node, or a particular child node.

==Syntax==
<syntaxhighlight lang="lua">table/xmlnode xmlNodeGetChildren ( xmlnode parent, [ int index ] )</syntaxhighlight>

===Required Arguments===
* '''parent:''' This is the [[xmlnode]] you want to retrieve one or all child nodes of.

===Optional Arguments===
* '''index:''' If you only want to retrieve one particular child node, specify its (0-based) index here. For example if you only want the first node, specify 0; the fifth node has index 4, etc.

===Returns===
If '''index''' isn't specified, returns a table containing all child nodes. If '''index''' is specified, returns the corresponding child node if it exists. If no nodes are found, it returns an empty table. Returns ''false'' in case of failure.

==Example==
<section name="Server" class="server" show="true">
Suppose you have an .xml file with random welcome messages:
<syntaxhighlight lang="lua" lang="xml">
<messages>
<message>Welcome to the deathmatch server, enjoy your stay.</message>
<message>Welcome. Be sure to get your free pizza at Matt's!</message>
<message>Party going on at the LS beach, be there</message>
</messages>
</syntaxhighlight>

To show a random message from this list to joining players, you could use the following code:
<syntaxhighlight lang="lua" lang="lua">
addEventHandler("onResourceStart", getResourceRootElement(getThisResource()),
function()
local xml = xmlLoadFile("welcome.xml") -- open the XML file
local messageNodes = xmlNodeGetChildren(xml) -- get all child nodes of the root node (<messages>)
g_WelcomeMessages = {} -- create a new global variable to store the welcome messages
for i,node in ipairs(messageNodes) do -- loop over all the message nodes
g_WelcomeMessages[i] = xmlNodeGetValue(node) -- retrieve the text in each node
end
xmlUnloadFile(xml) -- close the XML file
end
)

addEventHandler("onPlayerJoin", getRootElement(),
function()
local numMessages = #g_WelcomeMessages -- get the number of messages
local message = g_WelcomeMessages[math.random(numMessages)] -- pick a random message
outputChatBox(message, source, 0, 255, 0) -- display it to the joining player
end
)
</syntaxhighlight>
</section>

==See Also==
{{XML functions}}

OnPlayerUnmute

2014-08-09T13:32:19Z

Et-win: Changed sentence @ 'Source'

__NOTOC__
{{Server event}}
This event is triggered when a player has been unmuted by [[setPlayerMuted]].

==Parameters==
''none''

==Source==
The source of this event is the player who got unmuted.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the player will not be unmuted.

==Example==
This example outputs to chatbox the player name who's unmuted.
<syntaxhighlight lang="lua">
function unmuted()
outputChatBox(getPlayerName(source) .. " has been unmuted", root, 255, 0, 0)
end
addEventHandler("onPlayerUnmute", root, unmuted)
</syntaxhighlight>
{{See also/Server event|Player events}}

OnPlayerMute

2014-08-09T13:30:57Z

Et-win: Changed 'unmuted' to 'muted' @ 'Source'

__NOTOC__
{{Server event}}
This event is triggered when a player has been muted by [[setPlayerMuted]].

==Parameters==
''none''

==Source==
The source of this event is the player who got muted.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the player will not be muted.

==Example==
<syntaxhighlight lang="lua">
function muted()
outputChatBox(getPlayerName(source) .. " has been muted.", root, 255, 0, 0)
end
addEventHandler("onPlayerMute", root, muted)
</syntaxhighlight>
{{See also/Server event|Player events}}

OnPlayerMute

2014-08-09T13:29:40Z

Et-win: Added 'Source'

__NOTOC__
{{Server event}}
This event is triggered when a player has been muted by [[setPlayerMuted]].

==Parameters==
''none''

==Source==
The source of this event is the player that unmuted.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the player will not be muted.

==Example==
<syntaxhighlight lang="lua">
function muted()
outputChatBox(getPlayerName(source) .. " has been muted.", root, 255, 0, 0)
end
addEventHandler("onPlayerMute", root, muted)
</syntaxhighlight>
{{See also/Server event|Player events}}

DxSetBlendMode

2014-07-16T15:31:58Z

Et-win: Typos @ blendMode @ blend ("The is the" to "This is the")

{{Client function}}
__NOTOC__
This function sets the current blend mode for the dxDraw functions. Changing the blend mode can increase the quality when drawing text or certain other images to a render target. As a general guide use '''modulate_add''' when drawing text to a render target, and '''add''' when drawing the render target to the screen. Don't forget to restore the default '''blend''' at the end - See the example below.

==Syntax==
<syntaxhighlight lang="lua">
bool dxSetBlendMode ( string blendMode )
</syntaxhighlight>

===Required Arguments===
*'''blendMode :''' The blend mode to use which can be one of:
**'''blend:''' The source textures are alpha blended to the screen/render target. This is the default mode for drawing and gives the results we all know and love.
**'''add:''' The source textures are added to the screen/render target.
**'''modulate_add:''' The source textures are multiplied by the alpha and then added to the screen/render target.
**'''overwrite :''' The source textures are overwritten. This can be useful for clearing render targets.

==Returns==
Returns true if successful, or ''false'' if invalid arguments were passed to the function.

==Example==
This example shows how to use '''modulate_add''' and '''add''' to avoid quality problems when using a render target:
<syntaxhighlight lang="lua">
local myRenderTarget = dxCreateRenderTarget(500, 500, true)

--
-- Function to draw text to our render target texture when the 'r' key is pressed
--
function updateRenderTarget()
dxSetRenderTarget(myRenderTarget, true)
dxSetBlendMode("modulate_add") -- Set 'modulate_add' when drawing stuff on the render target

dxDrawText("Testing "..getTickCount(), 0, 0, 0, 0, tocolor(255, 255, 255, 255), 2, "clear")

dxSetBlendMode("blend") -- Restore default blending
dxSetRenderTarget() -- Restore default render target
end
bindKey("r", "down", updateRenderTarget )

--
-- Display render target contents
--
addEventHandler("onClientRender", root,
function()
dxSetBlendMode("add") -- Set 'add' when drawing the render target on the screen
dxDrawImage(100, 200, 500, 500, myRenderTarget, -10)
dxSetBlendMode("blend") -- Restore default blending
end
)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3.0-9.03782|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04425|Added overwrite }}

==See Also==
{{Drawing_functions}}

Key names

2014-02-23T16:17:25Z

Et-win: Undo revision 38941 by Et-win (talk)

This page lists all the key names. These can be used by the console commands ''bind'' and ''unbind'' as well as the script functions [[bindKey]] and [[unbindKey]].

Lua table of all the valid key names listed on this page:
<syntaxhighlight lang="lua">keyTable = { "mouse1", "mouse2", "mouse3", "mouse4", "mouse5", "mouse_wheel_up", "mouse_wheel_down", "arrow_l", "arrow_u",
"arrow_r", "arrow_d", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k",
"l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z", "num_0", "num_1", "num_2", "num_3", "num_4", "num_5",
"num_6", "num_7", "num_8", "num_9", "num_mul", "num_add", "num_sep", "num_sub", "num_div", "num_dec", "F1", "F2", "F3", "F4", "F5",
"F6", "F7", "F8", "F9", "F10", "F11", "F12", "backspace", "tab", "lalt", "ralt", "enter", "space", "pgup", "pgdn", "end", "home",
"insert", "delete", "lshift", "rshift", "lctrl", "rctrl", "[", "]", "pause", "capslock", "scroll", ";", ",", "-", ".", "/", "#", "\\", "=" }</syntaxhighlight><br\>

<div style="border:3px solid green;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">MOUSE</div>
* '''mouse1''' ''(This is left click)''
* '''mouse2''' ''(This is right click)''
* '''mouse3''' ''(This is the middle mouse button)''
* '''mouse4'''
* '''mouse5'''
* '''mouse_wheel_up'''
* '''mouse_wheel_down'''
</div>
<div style="border:3px solid red;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">ARROW KEYS</div>
* '''arrow_l'''
* '''arrow_u'''
* '''arrow_r'''
* '''arrow_d'''
</div>
<div style="border:3px solid blue;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">NUMBERS</div>
* '''0'''
* '''1'''
* '''2'''
* '''3'''
* '''4'''
* '''5'''
* '''6'''
* '''7'''
* '''8'''
* '''9'''
</div>
<div style="border:3px solid orange;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">LETTERS</div>
* '''a'''
* '''b'''
* '''c'''
* '''d'''
* '''e'''
* '''f'''
* '''g'''
* '''h'''
* '''i'''
* '''j'''
* '''k'''
* '''l'''
* '''m'''
* '''n'''
* '''o'''
* '''p'''
* '''q'''
* '''r'''
* '''s'''
* '''t'''
* '''u'''
* '''v'''
* '''w'''
* '''x'''
* '''y'''
* '''z'''
</div>
<div style="border:3px solid yellow;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">NUMERIC KEYPAD</div>
* '''num_0'''
* '''num_1'''
* '''num_2'''
* '''num_3'''
* '''num_4'''
* '''num_5'''
* '''num_6'''
* '''num_7'''
* '''num_8'''
* '''num_9'''
* '''num_mul'''
* '''num_add'''
* '''num_sep'''
* '''num_sub'''
* '''num_div'''
* '''num_dec'''
</div>
<div style="border:3px solid pink;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">FUNCTION KEYS</div>
* '''F1'''
* '''F2'''
* '''F3'''
* '''F4'''
* '''F5'''
* '''F6'''
* '''F7'''
* '''F8'''
* '''F9'''
* '''F10'''
* '''F11'''
* '''F12'''
</div>
<div style="border:3px solid purple;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">OTHER</div>
* '''backspace'''
* '''tab'''
* '''lalt'''
* '''ralt'''
* '''enter'''
* '''space'''
* '''pgup'''
* '''pgdn'''
* '''end'''
* '''home'''
* '''insert'''
* '''delete'''
* '''lshift'''
* '''rshift'''
* '''lctrl'''
* '''rctrl'''
* '''['''
* ''']'''
* '''pause'''
* '''capslock'''
* '''scroll'''
* ''';'''
* ''','''
* '''-'''
* '''.'''
* '''/'''
* '''#'''
* '''\'''
* '''='''

</div>
[[Category:Scripting Concepts]]

Key names

2014-02-23T16:16:43Z

Et-win: Changed keyTable's variable "\\" to "\"

This page lists all the key names. These can be used by the console commands ''bind'' and ''unbind'' as well as the script functions [[bindKey]] and [[unbindKey]].

Lua table of all the valid key names listed on this page:
<syntaxhighlight lang="lua">keyTable = { "mouse1", "mouse2", "mouse3", "mouse4", "mouse5", "mouse_wheel_up", "mouse_wheel_down", "arrow_l", "arrow_u",
"arrow_r", "arrow_d", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k",
"l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z", "num_0", "num_1", "num_2", "num_3", "num_4", "num_5",
"num_6", "num_7", "num_8", "num_9", "num_mul", "num_add", "num_sep", "num_sub", "num_div", "num_dec", "F1", "F2", "F3", "F4", "F5",
"F6", "F7", "F8", "F9", "F10", "F11", "F12", "backspace", "tab", "lalt", "ralt", "enter", "space", "pgup", "pgdn", "end", "home",
"insert", "delete", "lshift", "rshift", "lctrl", "rctrl", "[", "]", "pause", "capslock", "scroll", ";", ",", "-", ".", "/", "#", "\", "=" }</syntaxhighlight><br\>

<div style="border:3px solid green;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">MOUSE</div>
* '''mouse1''' ''(This is left click)''
* '''mouse2''' ''(This is right click)''
* '''mouse3''' ''(This is the middle mouse button)''
* '''mouse4'''
* '''mouse5'''
* '''mouse_wheel_up'''
* '''mouse_wheel_down'''
</div>
<div style="border:3px solid red;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">ARROW KEYS</div>
* '''arrow_l'''
* '''arrow_u'''
* '''arrow_r'''
* '''arrow_d'''
</div>
<div style="border:3px solid blue;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">NUMBERS</div>
* '''0'''
* '''1'''
* '''2'''
* '''3'''
* '''4'''
* '''5'''
* '''6'''
* '''7'''
* '''8'''
* '''9'''
</div>
<div style="border:3px solid orange;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">LETTERS</div>
* '''a'''
* '''b'''
* '''c'''
* '''d'''
* '''e'''
* '''f'''
* '''g'''
* '''h'''
* '''i'''
* '''j'''
* '''k'''
* '''l'''
* '''m'''
* '''n'''
* '''o'''
* '''p'''
* '''q'''
* '''r'''
* '''s'''
* '''t'''
* '''u'''
* '''v'''
* '''w'''
* '''x'''
* '''y'''
* '''z'''
</div>
<div style="border:3px solid yellow;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">NUMERIC KEYPAD</div>
* '''num_0'''
* '''num_1'''
* '''num_2'''
* '''num_3'''
* '''num_4'''
* '''num_5'''
* '''num_6'''
* '''num_7'''
* '''num_8'''
* '''num_9'''
* '''num_mul'''
* '''num_add'''
* '''num_sep'''
* '''num_sub'''
* '''num_div'''
* '''num_dec'''
</div>
<div style="border:3px solid pink;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">FUNCTION KEYS</div>
* '''F1'''
* '''F2'''
* '''F3'''
* '''F4'''
* '''F5'''
* '''F6'''
* '''F7'''
* '''F8'''
* '''F9'''
* '''F10'''
* '''F11'''
* '''F12'''
</div>
<div style="border:3px solid purple;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">OTHER</div>
* '''backspace'''
* '''tab'''
* '''lalt'''
* '''ralt'''
* '''enter'''
* '''space'''
* '''pgup'''
* '''pgdn'''
* '''end'''
* '''home'''
* '''insert'''
* '''delete'''
* '''lshift'''
* '''rshift'''
* '''lctrl'''
* '''rctrl'''
* '''['''
* ''']'''
* '''pause'''
* '''capslock'''
* '''scroll'''
* ''';'''
* ''','''
* '''-'''
* '''.'''
* '''/'''
* '''#'''
* '''\'''
* '''='''

</div>
[[Category:Scripting Concepts]]

GuiGridListSetColumnWidth

2013-12-31T14:45:13Z

Et-win: Changed boolean from 'guiGridListSetColumnWidth' to 'true' (Last change from me was wrong)

{{Client function}}
__NOTOC__
This allows you to set the width of an existing column in a gridlist.

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetColumnWidth ( element gridList, int columnIndex, number width, bool relative )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The grid list you want to add a column to
*'''columnIndex:''' Column ID of the size you want to change
*'''width:''' A float or integer of the width of the column depending on the '''relative''' argument.
*'''relative:''' A boolean defining whether '''width''' measurements will be relative to the Gridlist size, or absolute pixels.

===Returns===
Returns ''true'' if the gridlist column width was successfully set, ''false'' if bad arguments were given.

==Example==
This example creates a gridlist with one column that is too small to display. After the column has been successfully created, we give it a new width so you can see column.

<syntaxhighlight lang="lua">local gridlist = guiCreateGridList ( 332, 195, 286, 249, false )
local column = guiGridListAddColumn ( gridlist, "My column", 0 )

if column then
guiGridListSetColumnWidth ( gridlist, column, 0.5, true)
end
</syntaxhighlight>

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

GuiGridListSetColumnWidth

2013-12-31T14:24:56Z

Et-win: Added boolean 'false' to 'guiGridListSetColumnWidth'

{{Client function}}
__NOTOC__
This allows you to set the width of an existing column in a gridlist.

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetColumnWidth ( element gridList, int columnIndex, number width, bool relative )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The grid list you want to add a column to
*'''columnIndex:''' Column ID of the size you want to change
*'''width:''' A float or integer of the width of the column depending on the '''relative''' argument.
*'''relative:''' A boolean defining whether '''width''' measurements will be relative to the Gridlist size, or absolute pixels.

===Returns===
Returns ''true'' if the gridlist column width was successfully set, ''false'' if bad arguments were given.

==Example==
This example creates a gridlist with one column that is too small to display. After the column has been successfully created, we give it a new width so you can see column.

<syntaxhighlight lang="lua">local gridlist = guiCreateGridList ( 332, 195, 286, 249, false )
local column = guiGridListAddColumn ( gridlist, "My column", 0 )

if column then
guiGridListSetColumnWidth ( gridlist, column, 0.5, false)
end
</syntaxhighlight>

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

GuiGridListSetHorizontalScrollPosition

2013-12-07T01:37:19Z

Et-win:

{{client function}}
This function is used to set the horizontal scroll position from a grid list

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetHorizontalScrollPosition( element guiGridlist, float fPosition )
</syntaxhighlight>

===Required Arguments===
*'''guiGridlist''': The grid list you want to set the horizontal scroll position from
*'''fPosition''': A float representing the horizontal scroll position (0 - 100)

===Returns===
Returns ''true'' if the horizontal scroll position was set, or ''false'' otherwise.

==Requirements==
{{Requirements|n/a|1.3.2}}

==Example==
<syntaxhighlight lang="lua">
-- Todo
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiGridListSetHorizontalScrollPosition

2013-12-07T01:36:20Z

Et-win: Undo revision 37765 by Et-win (talk)

{{client function}}
This function is used to set the horizontal scroll position from a grid list

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetHorizontalScrollPosition( element guiGridlist, float fPosition )
</syntaxhighlight>

===Required Arguments===
*'''guiGridlist''': The grid list you want to set the horizontal scroll position from
*'''fPosition''': A float representing the horizontal scroll position

===Returns===
Returns ''true'' if the horizontal scroll position was set, or ''false'' otherwise.

==Requirements==
{{Requirements|n/a|1.3.2}}

==Example==
<syntaxhighlight lang="lua">
-- Todo
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiGridListSetHorizontalScrollPosition

2013-12-07T01:35:29Z

Et-win: /* Required Arguments */

GuiGridListAddRow

2013-06-09T14:09:42Z

Et-win: Undo revision 36379 by Et-win (talk)

{{Client function}}
__NOTOC__
Adds a row to a grid list.

ATTENTION: Without [[guiGridListSetItemText]] there is no row added to the grid.
Look at the example, first you give the row a name with '''[[row =]]''' guiGridListAddRow ( playerList ), and then you use [[guiGridListSetItemText]].

==Syntax==
<syntaxhighlight lang="lua">
int guiGridListAddRow ( element gridList )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The grid list you want to add a row to

===Returns===
Returns the row id if it has been created, ''false'' otherwise.

==Example==
This example creates a player list on the right side of the screen and fills it with the names of the connected players.
<syntaxhighlight lang="lua">
function clientsideResourceStart ()
local playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true ) -- Create the grid list
local column = guiGridListAddColumn( playerList, "Player", 0.85 ) -- Create a 'players' column in the list
if ( column ) then -- If the column was successfully created
for id, playeritem in ipairs(getElementsByType("player")) do
--Loop through all the players, adding them to the table
local row = guiGridListAddRow ( playerList )
guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
end
end
end
addEventHandler ( "onClientResourceStart", getRootElement(), clientsideResourceStart )
</syntaxhighlight>

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

GuiGridListAddRow

2013-06-09T14:02:36Z

Et-win:

{{Client function}}
__NOTOC__
Adds a row to a grid list.

==Syntax==
<syntaxhighlight lang="lua">
int guiGridListAddRow ( element gridList )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The grid list you want to add a row to

===Returns===
Returns the row id if it has been created, ''false'' otherwise.

==Example==
This example creates a player list on the right side of the screen and fills it with the names of the connected players.
<syntaxhighlight lang="lua">
function clientsideResourceStart ()
local playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true ) -- Create the grid list
local column = guiGridListAddColumn( playerList, "Player", 0.85 ) -- Create a 'players' column in the list
if ( column ) then -- If the column was successfully created
for id, playeritem in ipairs(getElementsByType("player")) do
--Loop through all the players, adding them to the table
local row = guiGridListAddRow ( playerList )
guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
end
end
end
addEventHandler ( "onClientResourceStart", getRootElement(), clientsideResourceStart )
</syntaxhighlight>

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