Multi Theft Auto: Wiki - User contributions [en]

RestartResource

2019-07-23T08:18:26Z

MaStFa: /* Syntax */

{{Server function}}
{{note| Don't forget to give admin rights to the resource, in which you are using restartResource function or it won't work.}}
__NOTOC__
This function restarts a running resource. Restarting will destroy all the elements that the resource has created (as stopping the resource does).

'''Note:''' This function does not restart the resource immediately. Restarts are queued up until the end of the server's frame to ensure that they occur in the correct order (and that dependent resources can start and stop correctly). The resource being restarted will have an [[onResourceStop]] event triggered and the restarted instance will receive an [[onResourceStart]] event. Remember that the element and resource variables will be invalidated during the restart, though of course, the resource's name will not.

==Syntax==
<syntaxhighlight lang="lua">
bool restartResource ( resource theResource [, bool persistent = false, bool configs = true, bool maps = true, bool scripts = true, bool html = true, bool clientConfigs = true, bool clientScripts = true, bool clientFiles = true ] )
</syntaxhighlight>
'''-- المقصد اعادات تشغيل المودات من خلال سكربت او اضافت وقت لعدات التشيغيل المودات ويمكن ترسيت بعض الملفات
'''
{{OOP||[[resource]]:restart}}
===Required Arguments===
*'''theResource:''' the [[resource]] you want to restart.

===Optional Arguments===
*'''persistent:''' Unused
*'''configs:''' Reload configs?
*'''maps:''' Reload maps?
*'''scripts:''' Reload (server) scripts?
*'''html:''' Reload html files (for resource web access)?
*'''clientConfigs:''' Reload client configs?
*'''clientScripts:''' Reload client scripts?
*'''clientFiles:''' Reload files?

===Returns===
Returns ''true'' if the resource was restarted, ''false'' if the resource wasn't running, or an invalid resource was passed.

==Example==
Example 1: This function restarts all running resources.
<syntaxhighlight lang="lua">
function restartAllResources()
-- we store a table of resources
local allResources = getResources()
-- for each one of them,
for index, res in ipairs(allResources) do
-- if it's running,
if getResourceState(res) == "running" then
-- then restart it
restartResource(res)
end
end
end
</syntaxhighlight>

Example 2: This example will restart the specify resource every 3600000 milliseconds (hour).
<syntaxhighlight lang="lua">
setTimer(
function()
--restarting this resource every hour
restartResource(getThisResource())
end,
3600000, 0)
</syntaxhighlight>

==See Also==
{{Resource_functions}}

RestartResource

2019-07-23T08:17:48Z

MaStFa: /* Syntax */

{{Server function}}
{{note| Don't forget to give admin rights to the resource, in which you are using restartResource function or it won't work.}}
__NOTOC__
This function restarts a running resource. Restarting will destroy all the elements that the resource has created (as stopping the resource does).

'''Note:''' This function does not restart the resource immediately. Restarts are queued up until the end of the server's frame to ensure that they occur in the correct order (and that dependent resources can start and stop correctly). The resource being restarted will have an [[onResourceStop]] event triggered and the restarted instance will receive an [[onResourceStart]] event. Remember that the element and resource variables will be invalidated during the restart, though of course, the resource's name will not.

==Syntax==
<syntaxhighlight lang="lua">
bool restartResource ( resource theResource [, bool persistent = false, bool configs = true, bool maps = true, bool scripts = true, bool html = true, bool clientConfigs = true, bool clientScripts = true, bool clientFiles = true ] )
'''-- المقصد اعادات تشغيل المودات من خلال سكربت او اضافت وقت لعدات التشيغيل المودات ويمكن ترسيت بعض الملفات
'''</syntaxhighlight>
{{OOP||[[resource]]:restart}}
===Required Arguments===
*'''theResource:''' the [[resource]] you want to restart.

===Optional Arguments===
*'''persistent:''' Unused
*'''configs:''' Reload configs?
*'''maps:''' Reload maps?
*'''scripts:''' Reload (server) scripts?
*'''html:''' Reload html files (for resource web access)?
*'''clientConfigs:''' Reload client configs?
*'''clientScripts:''' Reload client scripts?
*'''clientFiles:''' Reload files?

===Returns===
Returns ''true'' if the resource was restarted, ''false'' if the resource wasn't running, or an invalid resource was passed.

==Example==
Example 1: This function restarts all running resources.
<syntaxhighlight lang="lua">
function restartAllResources()
-- we store a table of resources
local allResources = getResources()
-- for each one of them,
for index, res in ipairs(allResources) do
-- if it's running,
if getResourceState(res) == "running" then
-- then restart it
restartResource(res)
end
end
end
</syntaxhighlight>

Example 2: This example will restart the specify resource every 3600000 milliseconds (hour).
<syntaxhighlight lang="lua">
setTimer(
function()
--restarting this resource every hour
restartResource(getThisResource())
end,
3600000, 0)
</syntaxhighlight>

==See Also==
{{Resource_functions}}

SetPlayerName

2019-07-23T08:12:34Z

MaStFa: /* Syntax */

{{Server function}}
__NOTOC__
This function changes the specified [[player]]'s name. Note that any change made to a players name with this function is not saved in their settings so the name change only lasts till they disconnect.

==Syntax==
<syntaxhighlight lang="lua">
bool setPlayerName ( player thePlayer, string newName ) -- تعديل اسم الاعب
</syntaxhighlight>

{{OOP||[[player]]:setName|name|getPlayerName}}

===Required Arguments===
*'''thePlayer:''' the [[player]] that will have its name set.
*'''newName:''' the new name to set for the player.

===Returns===
Returns ''true'' if the player name was changed succesfully, ''false'' if invalid arguments are specified.

===Limits===
* Only ASCII characters between 33 and 126 are allowed (basic latin, no spaces):
<nowiki>!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~</nowiki>
* Minimal player name length is 1 character.
* Maximum player name length is 22 characters.
* Player names are case-insensitive. It is not possible to have two clients with same name but different character case.

==Example==
<section name="Server" class="server" show="true">
This example adds a tag before a player's nickname via a /changetag command
<syntaxhighlight lang="lua">

-- Define the function for this command (/changetag, as defined below)
-- source = the player that triggered this command
-- command = the command passed into the function (changetag)
-- thePlayer = the player that you wish to add a tag to
-- tag = the tag to add to the players nickname
function tagPlayer ( source, command, thePlayer, tag )
-- Attempt to grab the element id for the player from the parsed name.
local sPlayerElement = getPlayerFromName ( thePlayer )
-- Check to see if the player were changing the tag for exists.
if ( sPlayerElement ) then
-- make sure that the element type of thePlayer is acctually pointing to a player element
if getElementType ( sPlayerElement ) == "player" then
-- we store the player's current name,
local oldName = getPlayerName ( sPlayerElement )
-- append the tag passed to this function before it
local taggedName = tag .. oldName
-- then set it as his new name
setPlayerName ( sPlayerElement, taggedName )
-- Tell the player who triggerd the command that the tag has been applied
outputChatBox ( "Player " .. thePlayer .. "'s tag changed to " .. taggedName, source )
end
else
-- Tell the player who triggerd the command that the player could not be found
outputChatBox ( "Unable to change player tag: Player " .. thePlayer .. " not found", source )
end
end
-- Add a command handler for either the console or / chat commands
-- Example: /changetag <playername> <tag>
addCommandHandler ( "changetag", tagPlayer )
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}
[[ru:setPlayerName]]

GetDistanceBetweenPoints3D

2019-07-21T20:32:49Z

MaStFa: /* Syntax */

__NOTOC__
{{Server client function}}
{{Note box|This function is equivalent to the [[Vector3]] class ''getLength'' method when used with a vector that holds the direction and distance between two points. In other words, it produces exactly the same result as substracting the points' coordinates and getting the length of the result vector.}}

This function returns the distance between two 3 dimensional points using the pythagorean theorem.

==Syntax==
<syntaxhighlight lang="lua">float getDistanceBetweenPoints3D ( float x1, float y1, float z1, float x2, float y2, float z2 )</syntaxhighlight> -- '''المقصود هنى وضع مسافه بين اشياء او قياس مسافه بنضريات'''

===Required Arguments===
* '''x1''': The X position of the first point
* '''y1''': The Y position of the first point
* '''z1''': The Z position of the first point
* '''x2''': The X position of the second point
* '''y2''': The Y position of the second point
* '''z2''': The Z position of the second point

===Returns===
Returns a float containing the distance between the two points as a [[float]]. Returns ''false'' if an argument passed was invalid.

==Example==
This example gets the distance between two vehicles and outputs it to the chat box.
<syntaxhighlight lang="lua">
vehicle1x, vehicle1y, vehicle1z = getElementPosition ( vehicle1 )
vehicle2x, vehicle2y, vehicle2z = getElementPosition ( vehicle2 )
outputChatBox ( "The distance between vehicle1 and vehicle2 is "..tostring(getDistanceBetweenPoints3D ( vehicle1x, vehicle1y, vehicle1z, vehicle2x,
vehicle2y, vehicle2z )) )</syntaxhighlight>

''getDistanceBetweenPoints3D'' can also be used to measure the length of 3 dimensional vectors. This example calculates the speed of a vehicle by measuring the size of the it's velocity vector:
<syntaxhighlight lang="lua">
speed = getDistanceBetweenPoints3D ( 0, 0, 0, getElementVelocity ( vehicle ) )
</syntaxhighlight>
''Lua note: Using multiple return values as arguments for another function can only be done at the end of the argument list.''

==See Also==
{{Utility functions}}

GetDistanceBetweenPoints3D

2019-07-21T20:32:15Z

MaStFa: /* Syntax */

__NOTOC__
{{Server client function}}
{{Note box|This function is equivalent to the [[Vector3]] class ''getLength'' method when used with a vector that holds the direction and distance between two points. In other words, it produces exactly the same result as substracting the points' coordinates and getting the length of the result vector.}}

This function returns the distance between two 3 dimensional points using the pythagorean theorem.

==Syntax==
<syntaxhighlight lang="lua">float getDistanceBetweenPoints3D ( float x1, float y1, float z1, float x2, float y2, float z2 )</syntaxhighlight> -- المقصود هنى وضع مسافه بين اشياء او قياس مسافه بنضريات

===Required Arguments===
* '''x1''': The X position of the first point
* '''y1''': The Y position of the first point
* '''z1''': The Z position of the first point
* '''x2''': The X position of the second point
* '''y2''': The Y position of the second point
* '''z2''': The Z position of the second point

===Returns===
Returns a float containing the distance between the two points as a [[float]]. Returns ''false'' if an argument passed was invalid.

==Example==
This example gets the distance between two vehicles and outputs it to the chat box.
<syntaxhighlight lang="lua">
vehicle1x, vehicle1y, vehicle1z = getElementPosition ( vehicle1 )
vehicle2x, vehicle2y, vehicle2z = getElementPosition ( vehicle2 )
outputChatBox ( "The distance between vehicle1 and vehicle2 is "..tostring(getDistanceBetweenPoints3D ( vehicle1x, vehicle1y, vehicle1z, vehicle2x,
vehicle2y, vehicle2z )) )</syntaxhighlight>

''getDistanceBetweenPoints3D'' can also be used to measure the length of 3 dimensional vectors. This example calculates the speed of a vehicle by measuring the size of the it's velocity vector:
<syntaxhighlight lang="lua">
speed = getDistanceBetweenPoints3D ( 0, 0, 0, getElementVelocity ( vehicle ) )
</syntaxhighlight>
''Lua note: Using multiple return values as arguments for another function can only be done at the end of the argument list.''

==See Also==
{{Utility functions}}

GuiComboBoxGetItemCount

2019-07-21T20:17:52Z

MaStFa: /* Syntax */

{{Client function}}
__NOTOC__
{{New feature/item|3.0157|1.5.6|14489|This function returns the number of items in a combo box.}}

==Syntax==
<syntaxhighlight lang="lua">
int guiComboBoxGetItemCount ( element comboBox ) -- المقصد الحصول على عدد الاشياء الموجوده في الوحه
</syntaxhighlight>

===Required Arguments===
*'''comboBox:''' The combo box to get the number of items from.

===Returns===
Returns the number of items if the function is successful, ''false'' otherwise.

==Example==
This example creates a gui combo box, fills it with the names of the connected players and prints the number of items (players) in the chatbox.
<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart',resourceRoot,function()
local playersList = guiCreateComboBox(0.35,0.40,0.31,0.20,'Players',true) -- create gui combo box

for key,player in ipairs(getElementsByType('player')) do -- get the connected players
guiComboBoxAddItem(playersList, getPlayerName(player)) -- add players name to the combo box
end
local playersCount = guiComboBoxGetItemCount(playersList) -- get the number of items
outputChatBox('Number of connected players: '..playersCount) -- show info on chatbox
end)
</syntaxhighlight>

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

GuiCreateComboBox

2019-07-21T20:17:35Z

MaStFa: /* Syntax */

__NOTOC__
{{Client function}}
This function creates a combobox GUI element, which you can compare to a gridlist with a dropdown feature.
* '''NOTE:''' The height of a combobox must be enough to fit the drop down menu, else the drop down won't appear. See [[guiComboBoxAdjustHeight]] to give your combobox the correct height.

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateComboBox ( float x, float y, float width, float height, string caption, bool relative, [ element parent = nil ] )
</syntaxhighlight>
{{OOP||[[Element/GUI/Combobox|GuiComboBox]]}}

===Required Arguments===
[[Image:Gui-combobox.jpg|frame|Example GUI ComboBox.]]
*'''x:''' A float of the 2D x position of the GUI combobox on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI combobox on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI combobox. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI combobox. This is affected by the ''relative'' argument. Note: height must be enough to fit the drop down menu, else the drop down won't appear.
*'''caption:''' A string for what the title of your combobox will be. This will be shown if no item is selected.
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.

===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the GUI combobox is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

===Returns===
Returns an element of the created combobox if it was successfully created, false otherwise.

==Example==
This example creates a combo box in the center of the screen with all server vehicles on it.
<syntaxhighlight lang="lua">addEventHandler ("onClientResourceStart",resourceRoot,function()
local screenWidth, screenHeight = guiGetScreenSize()
local windowWidth, windowHeight = 200,100
local left = screenWidth/2 - windowWidth/2
local top = screenHeight/2 - windowHeight/2
local vehiclesComboBox = guiCreateComboBox ( left, top, windowWidth,windowHeight, "Vehicle Names", false ) -- We create a combo box.
for index, vehicle in ipairs ( getElementsByType ( "vehicle" ) ) do -- We loop through all vehicles.
guiComboBoxAddItem ( vehiclesComboBox, getVehicleName ( vehicle ) ) -- We add the vehicle name to our combo box.
end
end)
</syntaxhighlight>

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

GuiCreateComboBox

2019-07-21T20:17:03Z

MaStFa: /* Syntax */

__NOTOC__
{{Client function}}
This function creates a combobox GUI element, which you can compare to a gridlist with a dropdown feature.
* '''NOTE:''' The height of a combobox must be enough to fit the drop down menu, else the drop down won't appear. See [[guiComboBoxAdjustHeight]] to give your combobox the correct height.

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateComboBox ( float x, float y, float width, float height, string caption, bool relative, [ element parent = nil ] ) -- المقصد الحصول على عدد الاشياء الموجوده في الوحه
</syntaxhighlight>
{{OOP||[[Element/GUI/Combobox|GuiComboBox]]}}

===Required Arguments===
[[Image:Gui-combobox.jpg|frame|Example GUI ComboBox.]]
*'''x:''' A float of the 2D x position of the GUI combobox on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI combobox on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI combobox. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI combobox. This is affected by the ''relative'' argument. Note: height must be enough to fit the drop down menu, else the drop down won't appear.
*'''caption:''' A string for what the title of your combobox will be. This will be shown if no item is selected.
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.

===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the GUI combobox is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

===Returns===
Returns an element of the created combobox if it was successfully created, false otherwise.

==Example==
This example creates a combo box in the center of the screen with all server vehicles on it.
<syntaxhighlight lang="lua">addEventHandler ("onClientResourceStart",resourceRoot,function()
local screenWidth, screenHeight = guiGetScreenSize()
local windowWidth, windowHeight = 200,100
local left = screenWidth/2 - windowWidth/2
local top = screenHeight/2 - windowHeight/2
local vehiclesComboBox = guiCreateComboBox ( left, top, windowWidth,windowHeight, "Vehicle Names", false ) -- We create a combo box.
for index, vehicle in ipairs ( getElementsByType ( "vehicle" ) ) do -- We loop through all vehicles.
guiComboBoxAddItem ( vehiclesComboBox, getVehicleName ( vehicle ) ) -- We add the vehicle name to our combo box.
end
end)
</syntaxhighlight>

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