Multi Theft Auto: Wiki - User contributions [en]

DxDrawRectangle

2016-10-29T15:53:49Z

Gravestone: Typo

__NOTOC__
{{Client function}}
This function draws a 2D rectangle across the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawRectangle ( float startX, float startY, float width, float height [, int color = white, bool postGUI = false, bool subPixelPositioning = false ] )
</syntaxhighlight>

===Required Arguments===
* '''startX:''' An float representing the '''absolute''' origin X position of the rectangle, represented by pixels on the screen.
* '''startY:''' An float representing the '''absolute''' origin Y position of the rectangle, represented by pixels on the screen.
* '''width:''' An float representing the width of the rectangle, drawn in a ''right'' direction from the origin.
* '''height:''' An float representing the height of the rectangle, drawn in a ''downwards'' direction from the origin.

===Optional Arguments===
*'''color:''' the hex color of the rectangle, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI.
{{New feature/item|9.06931|1.4.0|6931|
*'''subPixelPositioning:''' A bool representing whether the rectangle can be positioned sub-pixel-ly.
}}

===Returns===
Returns true if the operation was successful, false otherwise.

==Example==
<section name="Client" class="client" show="true">
Example of MOTD (message of the day), made using DxDrawText, -Line and -Rectangle.
<syntaxhighlight lang="lua">
local x,y = guiGetScreenSize() -- Get players resolution.
local playerName = getPlayerName ( localPlayer ) -- Get players name.
local MOTDText = "Welcome to our server, this is a test MOTD script for MTA's Wiki." -- Example of MOTD message.

function drawStuff()
dxDrawRectangle ( x/3.8, y/3.8, x/2.02, y/2, tocolor ( 0, 0, 0, 150 ) ) -- Create our black transparent MOTD background Rectangle.
dxDrawText ( "Welcome " .. playerName, x/3.5, y/3.6, x, y, tocolor ( 255, 255, 255, 255 ), 1, "bankgothic" ) -- Create Welcome title.
dxDrawText ( "Welcome " .. playerName, x/3.48, y/3.58, x, y, tocolor ( 0, 0, 0, 255 ), 1, "bankgothic" ) -- Create Welcome title shadow.
dxDrawLine ( x/3.6, y/3.3, x/1.35, y/3.3, tocolor ( 255, 255, 255, 255 ), 2 ) -- Create underline for title.
dxDrawLine ( x/3.59, y/3.275, x/1.348, y/3.275, tocolor ( 0, 0, 0, 255 ), 2 ) -- Create underline shadow.
dxDrawText ( MOTDText, x/3.6, y/3, x, y, tocolor ( 255, 255, 255, 255 ), 1, "clear" ) -- Create MOTD text.
end

addEventHandler("onClientRender", root, drawStuff) -- Keep everything visible with onClientRender.
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.4.0-9.06931|Added subPixelPositioning argument}}

==See Also==
{{Drawing_functions}}

OnPlayerChangeNick

2016-10-22T11:44:38Z

Gravestone: /* Example */

{{Server event}}
__NOTOC__
This event is triggered when a player changes his nickname.

==Parameters==
<syntaxhighlight lang="lua">
string oldNick, string newNick, bool changedByUser
</syntaxhighlight>
*'''oldNick:''' the nickname the player had before.
*'''newNick:''' the new nickname of the player.
{{New items|3.0160|1.5.3|
*'''changedByUser:''' whether the name was changed using [[setPlayerName]] or by the user
|9765}}

==Source==
The source of this event is the player that changed his nick

==Cancel effect==
Cancelling this event depends on how it is called, if it is called by the scripting event then it is NOT cancelable. If it is called from the /nick command it IS cancelable. If this event is cancelled and can be cancelled then the name will not change.

==Example==
<section name="Server Example 1" class="server" show="true">
<syntaxhighlight lang="lua">
function nickChangeHandler(oldNick, newNick)
-- check if there's account with newNick as username
if getAccount(newNick) then
outputChatBox("Sorry, there already exists an account with your new nickname as username.", source, 0, 255, 0)
outputChatBox("Please choose another one.", source, 0, 255, 0)
-- cancel the event to prevent the nick from being changed
cancelEvent()
end
end
-- add an event handler
addEventHandler("onPlayerChangeNick", getRootElement(), nickChangeHandler)
</syntaxhighlight></section>

{{New items|3.0160|1.5.3|
<section name="Server Example 2" class="server" show="true">
This function checks if the nickname of a player was changed by a script, if so, a message is shown in the server logs.
<syntaxhighlight lang="lua">
function wasNickChangedByUser(oldNick, newNick, changedByUser)
if (changedByUser == false) then -- check if the nickname was not changed by the user
outputServerLog("Player "..oldNick.."'s name was changed to "..newNick.." by a script") -- output to the server's logs
end
end
addEventHandler("onPlayerChangeNick", getRootElement(), wasNickChangedByUser) -- add an event handler
</syntaxhighlight></section>|9765}}

==Issues==
{{Issues|
{{Issue|7362|onPlayerChangeNick triggered when nick doesn't changed}}
{{GH_Issue|52|Add 'manuallyChanged' parameter to onPlayerChangeNick}}
}}

{{See also/Server event|Player events}}

OnPlayerChangeNick

2016-10-22T11:44:05Z

Gravestone: /* Example */

{{Server event}}
__NOTOC__
This event is triggered when a player changes his nickname.

==Parameters==
<syntaxhighlight lang="lua">
string oldNick, string newNick, bool changedByUser
</syntaxhighlight>
*'''oldNick:''' the nickname the player had before.
*'''newNick:''' the new nickname of the player.
{{New items|3.0160|1.5.3|
*'''changedByUser:''' whether the name was changed using [[setPlayerName]] or by the user
|9765}}

==Source==
The source of this event is the player that changed his nick

==Cancel effect==
Cancelling this event depends on how it is called, if it is called by the scripting event then it is NOT cancelable. If it is called from the /nick command it IS cancelable. If this event is cancelled and can be cancelled then the name will not change.

==Example==
<section name="Server Example 1" class="server" show="true">
<syntaxhighlight lang="lua">
function nickChangeHandler(oldNick, newNick)
-- check if there's account with newNick as username
if getAccount(newNick) then
outputChatBox("Sorry, there already exists an account with your new nickname as username.", source, 0, 255, 0)
outputChatBox("Please choose another one.", source, 0, 255, 0)
-- cancel the event to prevent the nick from being changed
cancelEvent()
end
end
-- add an event handler
addEventHandler("onPlayerChangeNick", getRootElement(), nickChangeHandler)
</syntaxhighlight></section>
{{New items|3.0160|1.5.3|
<section name="Server Example 2" class="server" show="true">
This function checks if the nickname of a player was changed by a script, if so, a message is shown in the server logs.
<syntaxhighlight lang="lua">
function wasNickChangedByUser(oldNick, newNick, changedByUser)
if (changedByUser == false) then -- check if the nickname was not changed by the user
outputServerLog("Player "..oldNick.."'s name was changed to "..newNick.." by a script") -- output to the server's logs
end
end
addEventHandler("onPlayerChangeNick", getRootElement(), wasNickChangedByUser) -- add an event handler
</syntaxhighlight></section>|9765}}

==Issues==
{{Issues|
{{Issue|7362|onPlayerChangeNick triggered when nick doesn't changed}}
{{GH_Issue|52|Add 'manuallyChanged' parameter to onPlayerChangeNick}}
}}

{{See also/Server event|Player events}}

OnPlayerChangeNick

2016-10-22T11:43:11Z

Gravestone: /* Example */

{{Server event}}
__NOTOC__
This event is triggered when a player changes his nickname.

==Parameters==
<syntaxhighlight lang="lua">
string oldNick, string newNick, bool changedByUser
</syntaxhighlight>
*'''oldNick:''' the nickname the player had before.
*'''newNick:''' the new nickname of the player.
{{New items|3.0160|1.5.3|
*'''changedByUser:''' whether the name was changed using [[setPlayerName]] or by the user
|9765}}

==Source==
The source of this event is the player that changed his nick

==Cancel effect==
Cancelling this event depends on how it is called, if it is called by the scripting event then it is NOT cancelable. If it is called from the /nick command it IS cancelable. If this event is cancelled and can be cancelled then the name will not change.

==Example==
<section name="Server Example 1" class="server" show="true">
<syntaxhighlight lang="lua">
function nickChangeHandler(oldNick, newNick)
-- check if there's account with newNick as username
if getAccount(newNick) then
outputChatBox("Sorry, there already exists an account with your new nickname as username.", source, 0, 255, 0)
outputChatBox("Please choose another one.", source, 0, 255, 0)
-- cancel the event to prevent the nick from being changed
cancelEvent()
end
end
-- add an event handler
addEventHandler("onPlayerChangeNick", getRootElement(), nickChangeHandler)
</syntaxhighlight>{{New items|3.0160|1.5.3|9765}}</section>
This function checks if the nickname of a player was changed by a script, if so, a message is shown in the server logs.
<section name="Server Example 2" class="server" show="true">
<syntaxhighlight lang="lua">
function wasNickChangedByUser(oldNick, newNick, changedByUser)
if (changedByUser == false) then -- check if the nickname was not changed by the user
outputServerLog("Player "..oldNick.."'s name was changed to "..newNick.." by a script") -- output to the server's logs
end
end
addEventHandler("onPlayerChangeNick", getRootElement(), wasNickChangedByUser) -- add an event handler
</syntaxhighlight></section>

==Issues==
{{Issues|
{{Issue|7362|onPlayerChangeNick triggered when nick doesn't changed}}
{{GH_Issue|52|Add 'manuallyChanged' parameter to onPlayerChangeNick}}
}}

{{See also/Server event|Player events}}

OnPlayerChangeNick

2016-10-22T11:42:38Z

Gravestone: /* Example */

{{Server event}}
__NOTOC__
This event is triggered when a player changes his nickname.

==Parameters==
<syntaxhighlight lang="lua">
string oldNick, string newNick, bool changedByUser
</syntaxhighlight>
*'''oldNick:''' the nickname the player had before.
*'''newNick:''' the new nickname of the player.
{{New items|3.0160|1.5.3|
*'''changedByUser:''' whether the name was changed using [[setPlayerName]] or by the user
|9765}}

==Source==
The source of this event is the player that changed his nick

==Cancel effect==
Cancelling this event depends on how it is called, if it is called by the scripting event then it is NOT cancelable. If it is called from the /nick command it IS cancelable. If this event is cancelled and can be cancelled then the name will not change.

==Example==
<section name="Server Example 1" class="server" show="true">
<syntaxhighlight lang="lua">
function nickChangeHandler(oldNick, newNick)
-- check if there's account with newNick as username
if getAccount(newNick) then
outputChatBox("Sorry, there already exists an account with your new nickname as username.", source, 0, 255, 0)
outputChatBox("Please choose another one.", source, 0, 255, 0)
-- cancel the event to prevent the nick from being changed
cancelEvent()
end
end
-- add an event handler
addEventHandler("onPlayerChangeNick", getRootElement(), nickChangeHandler)
{{New items|3.0160|1.5.3|9765}}</syntaxhighlight></section>
This function checks if the nickname of a player was changed by a script, if so, a message is shown in the server logs.
<section name="Server Example 2" class="server" show="true">
<syntaxhighlight lang="lua">
function wasNickChangedByUser(oldNick, newNick, changedByUser)
if (changedByUser == false) then -- check if the nickname was not changed by the user
outputServerLog("Player "..oldNick.."'s name was changed to "..newNick.." by a script") -- output to the server's logs
end
end
addEventHandler("onPlayerChangeNick", getRootElement(), wasNickChangedByUser) -- add an event handler
</syntaxhighlight></section>

==Issues==
{{Issues|
{{Issue|7362|onPlayerChangeNick triggered when nick doesn't changed}}
{{GH_Issue|52|Add 'manuallyChanged' parameter to onPlayerChangeNick}}
}}

{{See also/Server event|Player events}}

OnPlayerChangeNick

2016-10-22T11:41:46Z

Gravestone: /* Example */

{{Server event}}
__NOTOC__
This event is triggered when a player changes his nickname.

==Parameters==
<syntaxhighlight lang="lua">
string oldNick, string newNick, bool changedByUser
</syntaxhighlight>
*'''oldNick:''' the nickname the player had before.
*'''newNick:''' the new nickname of the player.
{{New items|3.0160|1.5.3|
*'''changedByUser:''' whether the name was changed using [[setPlayerName]] or by the user
|9765}}

==Source==
The source of this event is the player that changed his nick

==Cancel effect==
Cancelling this event depends on how it is called, if it is called by the scripting event then it is NOT cancelable. If it is called from the /nick command it IS cancelable. If this event is cancelled and can be cancelled then the name will not change.

==Example==
<section name="Server Example 1" class="server" show="true">
<syntaxhighlight lang="lua">
function nickChangeHandler(oldNick, newNick)
-- check if there's account with newNick as username
if getAccount(newNick) then
outputChatBox("Sorry, there already exists an account with your new nickname as username.", source, 0, 255, 0)
outputChatBox("Please choose another one.", source, 0, 255, 0)
-- cancel the event to prevent the nick from being changed
cancelEvent()
end
end
-- add an event handler
addEventHandler("onPlayerChangeNick", getRootElement(), nickChangeHandler)
{{New items|3.0160|1.5.3|</syntaxhighlight></section>
This function checks if the nickname of a player was changed by a script, if so, a message is shown in the server logs.
<section name="Server Example 2" class="server" show="true">
<syntaxhighlight lang="lua">
function wasNickChangedByUser(oldNick, newNick, changedByUser)
if (changedByUser == false) then -- check if the nickname was not changed by the user
outputServerLog("Player "..oldNick.."'s name was changed to "..newNick.." by a script") -- output to the server's logs
end
end
addEventHandler("onPlayerChangeNick", getRootElement(), wasNickChangedByUser) -- add an event handler
</syntaxhighlight></section>|9765}}

==Issues==
{{Issues|
{{Issue|7362|onPlayerChangeNick triggered when nick doesn't changed}}
{{GH_Issue|52|Add 'manuallyChanged' parameter to onPlayerChangeNick}}
}}

{{See also/Server event|Player events}}

FileGetPath

2016-10-22T10:25:43Z

Gravestone: /* Example */

__NOTOC__
{{Server client function}}
{{New feature/item|3.0160|1.6|7446|
This function retrieves the path of the given file.
}}

==Syntax==
<syntaxhighlight lang="lua">
string fileGetPath ( file theFile )
</syntaxhighlight>

===Required Arguments===
*'''theFile:''' The file you want to get the path.

===Returns===
Returns a ''string'' representing the file path, ''false'' if invalid file was provided.

==Example==
<section name="Server Example 1" class="server" show="true">
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
local path = fileGetPath(newFile)
outputChatBox("New file created at: "..path, root, 0, 255, 0)
fileClose(newFile) -- close the file once you're done with it
end
</syntaxhighlight></section>

==See Also==
{{File functions}}

FileGetPath

2016-10-22T10:25:24Z

Gravestone: /* Example */

__NOTOC__
{{Server client function}}
{{New feature/item|3.0160|1.6|7446|
This function retrieves the path of the given file.
}}

==Syntax==
<syntaxhighlight lang="lua">
string fileGetPath ( file theFile )
</syntaxhighlight>

===Required Arguments===
*'''theFile:''' The file you want to get the path.

===Returns===
Returns a ''string'' representing the file path, ''false'' if invalid file was provided.

==Example==
<section name="Server Example 1" class="server" show="true">
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
local path = fileGetPath(newFile)
outputChatBox("New file created at: "..path,root,0,255,0)
fileClose(newFile) -- close the file once you're done with it
end
</syntaxhighlight></section>

==See Also==
{{File functions}}

FileGetPath

2016-10-22T10:24:39Z

Gravestone: /* Example */

__NOTOC__
{{Server client function}}
{{New feature/item|3.0160|1.6|7446|
This function retrieves the path of the given file.
}}

==Syntax==
<syntaxhighlight lang="lua">
string fileGetPath ( file theFile )
</syntaxhighlight>

===Required Arguments===
*'''theFile:''' The file you want to get the path.

===Returns===
Returns a ''string'' representing the file path, ''false'' if invalid file was provided.

==Example==
<section name="Shared example 1" class="server" show="true">
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
local path = fileGetPath(newFile)
outputChatBox("New file created at: "..path,root,0,255,0)
fileClose(newFile) -- close the file once you're done with it
end
</syntaxhighlight></section>

==See Also==
{{File functions}}

FileGetPath

2016-10-22T10:24:01Z

Gravestone:

__NOTOC__
{{Server client function}}
{{New feature/item|3.0160|1.6|7446|
This function retrieves the path of the given file.
}}

==Syntax==
<syntaxhighlight lang="lua">
string fileGetPath ( file theFile )
</syntaxhighlight>

===Required Arguments===
*'''theFile:''' The file you want to get the path.

===Returns===
Returns a ''string'' representing the file path, ''false'' if invalid file was provided.

==Example==
<section name="Shared example 1" class="shared" show="true">
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
local path = fileGetPath(newFile)
outputChatBox("New file created at: "..path,root,0,255,0)
fileClose(newFile) -- close the file once you're done with it
end
</syntaxhighlight></section>

==See Also==
{{File functions}}

GetAccount

2016-10-22T10:01:51Z

Gravestone: /* Example */

__NOTOC__
{{Server function}}
This function returns an [[account]] for a specific user.
==Syntax==
<syntaxhighlight lang="lua">
account getAccount ( string username, [ string password ] )
</syntaxhighlight>
{{OOP||[[Account]]||}}
===Required Arguments===
*'''username:''' The username of the account you want to retrieve

===Optional Arguments===
{{OptionalArg}}
*'''password:''' The password for the account. If this argument is not specified, you can get the account whatever password it is, otherwise the password must match the account's.

===Returns===
Returns an [[account]] or ''false'' if an account matching the username specified (and password, if specified) could not be found.

==Example==
<section name="Server example 1" class="server" show="true">
This function checks if the account mentioned exists in the internal.db database file.
<syntaxhighlight lang="lua">
addCommandHandler("checkaccount",
function(player, cmd, account)
if hasObjectPermissionTo(player, "function.banPlayer" ) then -- if the player typing /checkaccount command has permission to banPlayer
if account and account ~= "" then -- if the account name was mentioned
if getAccount(account) then -- if the account exists
outputChatBox("Account "..account.." exists in the database!", player, 0, 255, 0)
else -- if the account doesn't exist
outputChatBox("Account "..account.." does not exist in database", player, 0, 255, 0)
end
else
outputChatBox("Syntax is /checkaccount [account name]", player, 255, 0, 0)
end
end
end
)
</syntaxhighlight></section>

==See Also==
{{Account functions}}

[[ar:getAccount]]
[[es:getAccount]]
[[pl:GetAccount]]
[[ru:getAccount]]

GetAccount

2016-10-22T09:28:51Z

Gravestone: /* Returns */

GetAccount

2016-10-22T09:28:22Z

Gravestone: /* Example */

OnPlayerChangeNick

2016-10-22T09:26:56Z

Gravestone: /* Parameters */

{{Server event}}
__NOTOC__
This event is triggered when a player changes his nickname.

==Parameters==
<syntaxhighlight lang="lua">
string oldNick, string newNick, bool changedByUser
</syntaxhighlight>
*'''oldNick:''' the nickname the player had before.
*'''newNick:''' the new nickname of the player.
{{New items|3.0160|1.5.3|
*'''changedByUser:''' whether the name was changed using [[setPlayerName]] or by the user
|9765}}

==Source==
The source of this event is the player that changed his nick

==Cancel effect==
Cancelling this event depends on how it is called, if it is called by the scripting event then it is NOT cancelable. If it is called from the /nick command it IS cancelable. If this event is cancelled and can be cancelled then the name will not change.

==Example==
<syntaxhighlight lang="lua">
function nickChangeHandler(oldNick, newNick)
-- check if there's account with newNick as username
if getAccount(newNick) then
outputChatBox("Sorry, there already exists an account with your new nickname as username.", source, 0, 255, 0)
outputChatBox("Please choose another one.", source, 0, 255, 0)
-- cancel the event to prevent the nick from being changed
cancelEvent()
end
end
-- add an event handler
addEventHandler("onPlayerChangeNick", getRootElement(), nickChangeHandler)
</syntaxhighlight>

This example displays a message to everyone every time player changed his nick
<syntaxhighlight lang="lua">
function nickChangeHandler(oldNick, newNick)
outputChatBox(oldNick.." is now known as "..newNick, getRootElement(), 255, 100, 100) -- display the message
end
addEventHandler("onPlayerChangeNick", getRootElement(), nickChangeHandler) -- add an event handler
</syntaxhighlight>

==Issues==
{{Issues|
{{Issue|7362|onPlayerChangeNick triggered when nick doesn't changed}}
{{GH_Issue|52|Add 'manuallyChanged' parameter to onPlayerChangeNick}}
}}

{{See also/Server event|Player events}}

OnClientGUIClick

2016-10-22T08:39:23Z

Gravestone: /* Source */

{{Client event}}
__NOTOC__
This event happens when any gui-element clicked
{{Note|The '''player''' who clicked the gui-element is always the [[localPlayer]].}}

==Parameters==
<syntaxhighlight lang="lua">
string button, string state, int absoluteX, int absoluteY
</syntaxhighlight>
*'''button:''' the name of the button which will be clicked , it can be ''left'', ''right'', ''middle''
*'''state:''' the state of the mouse button, will be ''down'' if the mouse button was pushed, or ''up'' if it was released. '''Please note currently only the ''up'' state is supported.'''
*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.
*'''absoluteY:''' the Y position of the mouse cursor, in pixels, measured from the top of the screen.

==Source==
The [[event system#Event source|source]] of this event is the GUI element that was clicked.

'''Note:''' If the GUI Element attached to this event has a parent element, this event will be triggered once the parent element of the attached element is clicked too.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked with the left mouse button, it will output the message in the edit box into the chat box.
<syntaxhighlight lang="lua">
-- When client's resource starts, create the GUI
function initGUI( )
-- Create our button
btnOutput = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )

-- And attach our button to the outputEditBox function
addEventHandler ( "onClientGUIClick", btnOutput, outputEditBox, false )

-- Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
guiEditSetMaxLength ( editBox, 128 ) -- The max chatbox text length is 128, so force this
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource( ) ), initGUI )

-- Setup our function to output the message to the chatbox
function outputEditBox ( button )
if button == "left" then
local text = guiGetText ( editBox )-- Get the text from the edit box
outputChatBox ( text ) -- Output that text
end
end
</syntaxhighlight>

[[pl:onClientGUIClick]]

==See Also==
===GUI events===
{{GUI_events}}
===Client event functions===
{{Client_event_functions}}

IsElementWithinAColShape

2016-10-10T02:47:09Z

Gravestone: /* Example */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function checks if the [[element]] is in a [[colshape]].

==Syntax==
<section name="Server" class="server" show="true"><syntaxhighlight lang="lua"> colshape / bool isElementWithinAColShape ( element theElement ) </syntaxhighlight></section>
<section name="Client" class="client" show="true"><syntaxhighlight lang="lua"> colshape / bool isElementWithinAColShape ( [ element theElement ] ) </syntaxhighlight></section>

===Required/Optional Arguments===
* '''theElement''': The element you want to check. (If not entered in client-side function, local player will be checked instead.)

===Returns===
Returns a [[colshape]] the [[element]] is in else false if the element isn't in one or no arguments were passed.

===Code===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">function isElementWithinAColShape(element)
if element or isElement(element)then
for _,colshape in ipairs(getElementsByType("colshape"))do
if isElementWithinColShape(element,colshape) then
return colshape
end
end
end
outputDebugString("isElementWithinAColShape - Invalid arguments or element does not exist",1)
return false
end</syntaxhighlight></section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">function isElementWithinAColShape(element)
element = element or localPlayer or getLocalPlayer()
if element or isElement(element)then
for _,colshape in ipairs(getElementsByType("colshape"))do
if isElementWithinColShape(element,colshape) then
return colshape
end
end
end
outputDebugString("isElementWithinAColShape - Element does not exist",1)
return false
end</syntaxhighlight></section>

===Example===
<section name="Example 1" class="server" show="true">
This code will destroy the colshape the player is currently in when he types the command '/deletecol'.
<syntaxhighlight lang="lua">
function deleteColShape(thePlayer, command)
local colshape = isElementWithinAColShape(thePlayer)
if colshape then -- if the player who entered the command is in a colshape
outputChatBox("The colshape you are in has been successfully deleted!", thePlayer, 0, 255, 0)
destroyElement(colshape) -- destroy the col shape he is in
else
outputChatBox("You are currently not in a colshape", thePlayer, 255, 0, 0) -- if he is not in the colshape
end
end
addCommandHandler("deletecol", deleteColShape)
</syntaxhighlight></section>

==See Also==
{{Useful_Functions}}

IsElementWithinAColShape

2016-10-10T02:46:31Z

Gravestone: /* Example */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function checks if the [[element]] is in a [[colshape]].

==Syntax==
<section name="Server" class="server" show="true"><syntaxhighlight lang="lua"> colshape / bool isElementWithinAColShape ( element theElement ) </syntaxhighlight></section>
<section name="Client" class="client" show="true"><syntaxhighlight lang="lua"> colshape / bool isElementWithinAColShape ( [ element theElement ] ) </syntaxhighlight></section>

===Required/Optional Arguments===
* '''theElement''': The element you want to check. (If not entered in client-side function, local player will be checked instead.)

===Returns===
Returns a [[colshape]] the [[element]] is in else false if the element isn't in one or no arguments were passed.

===Code===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">function isElementWithinAColShape(element)
if element or isElement(element)then
for _,colshape in ipairs(getElementsByType("colshape"))do
if isElementWithinColShape(element,colshape) then
return colshape
end
end
end
outputDebugString("isElementWithinAColShape - Invalid arguments or element does not exist",1)
return false
end</syntaxhighlight></section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">function isElementWithinAColShape(element)
element = element or localPlayer or getLocalPlayer()
if element or isElement(element)then
for _,colshape in ipairs(getElementsByType("colshape"))do
if isElementWithinColShape(element,colshape) then
return colshape
end
end
end
outputDebugString("isElementWithinAColShape - Element does not exist",1)
return false
end</syntaxhighlight></section>

===Example===
<section name="Example 1" class="server" show="true"
This code will destroy the colshape the player is currently in when he types the command '/deletecol'.
<syntaxhighlight lang="lua">
function deleteColShape(thePlayer, command)
local colshape = isElementWithinAColShape(thePlayer)
if colshape then -- if the player who entered the command is in a colshape
outputChatBox("The colshape you are in has been successfully deleted!", thePlayer, 0, 255, 0)
destroyElement(colshape) -- destroy the col shape he is in
else
outputChatBox("You are currently not in a colshape", thePlayer, 255, 0, 0) -- if he is not in the colshape
end
end
addCommandHandler("deletecol", deleteColShape)
</syntaxhighlight></section>

==See Also==
{{Useful_Functions}}

IsPlayerMapVisible

2016-10-09T14:36:00Z

Gravestone: /* Example */

__NOTOC__
{{Client function}}
{{Needs_Example}}
This function checks if the local player has their map showing

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerMapVisible ()</syntaxhighlight>

===Returns===
Returns ''true'' if the player has the map visible, ''false'' otherwise.

==Example==
<section name="Example 1" class="client" show="true"><syntaxhighlight lang="lua">
function checkMap()
if isPlayerMapVisible() then -- check if the player has his map visible
outputChatBox("You are currently viewing your map!", 255, 255, 0) -- output text if it's visible
else
outputChatBox("Your map is not visible!", 255, 255, 0) -- output text if it's not visible
end
end
addCommandHandler("map", checkMap) -- add '/map' command to the check
</syntaxhighlight></section>

<section name="Example 2" class="client" show="true"><syntaxhighlight lang="lua">
function showMap()
if isPlayerMapVisible() then
outputChatBox("Radar closed", 0, 255, 0)
forcePlayerMap(false)
else
outputChatBox("Viewing radar", 0, 255, 0)
forcePlayerMap(true)
end
end
addCommandHandler("showmap", showMap)
</syntaxhighlight></section>

==See Also==
{{Client player functions}}

IsPlayerMapVisible

2016-10-09T14:34:56Z

Gravestone: /* Example */

__NOTOC__
{{Client function}}
{{Needs_Example}}
This function checks if the local player has their map showing

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerMapVisible ()</syntaxhighlight>

===Returns===
Returns ''true'' if the player has the map visible, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function checkMap()
if isPlayerMapVisible() then -- check if the player has his map visible
outputChatBox("You are currently viewing your map!", 255, 255, 0) -- output text if it's visible
else
outputChatBox("Your map is not visible!", 255, 255, 0) -- output text if it's not visible
end
end
addCommandHandler("map", checkMap) -- add '/map' command to the check
</syntaxhighlight>
<syntaxhighlight lang="lua">
function showMap()
if isPlayerMapVisible() then
outputChatBox("Radar closed", 0, 255, 0)
forcePlayerMap(false)
else
outputChatBox("Viewing radar", 0, 255, 0)
forcePlayerMap(true)
end
end
addCommandHandler("showmap", showMap)
</syntaxhighlight>

==See Also==
{{Client player functions}}

IsPlayerMapVisible

2016-10-09T14:33:47Z

Gravestone: /* Example */

IsTextInGridList

2016-10-09T13:11:38Z

Gravestone: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
As the tile says, this function checks if some text exist or not in the GridList.
==Syntax==
<syntaxhighlight lang="lua">bool isTextInGridList (element gridList,string text)</syntaxhighlight>

===Required arguments===
* '''gridList''': The grid list element.
* '''text''': The text that you are looking for.

===Return===
Returns true if the text exist in the GridList, false if otherwise.

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function isTextInGridList(gridlist, text)
for i=0, guiGridListGetRowCount(gridlist)-1 do
local t = guiGridListGetItemText(gridlist, i, 1)
if (t) then
if (t == text) then
return true
end
end
end
return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function ()
playerList = guiCreateGridList(0.80, 0.10, 0.15, 0.60, true)
local column = guiGridListAddColumn(playerList, "Player", 0.85)
if (column) then
for id, players in ipairs(getElementsByType("player")) do
local row = guiGridListAddRow(playerList)
guiGridListSetItemText(playerList, row, column, getPlayerName(players), false, false)
end
end
end)

function findText(cmd,text)
if not tostring(text) then return end
if isTextInGridList(playerList, tostring(text)) then
outputChatBox("Text exist!",0,255,0)
end
end
addCommandHandler("check",findText)
</syntaxhighlight>
</section>

Author: Walid

==See Also==
{{Useful_Functions}}