Multi Theft Auto: Wiki - User contributions [en]

AddCommandHandler

2010-08-07T14:46:00Z

Cecer1:

__NOTOC__
{{Server client function}}
{{Note_box|It is strongly advised that you do not use the same name for your handler function as the command name, as this can lead to confusion if multiple handler functions are used. Use a name that describes your handler's purpose more specifically.}}
This function will attach a scripting function (handler) to a console command, so that whenever a player or administrator uses the command the function is called.

Multiple command handlers can be attached to a single command, and they will be called in the order that the handlers were attached. Equally, multiple commands can be handled by a single function, and the ''commandName'' parameter used to decide the course of action.

For users, a command is in the format:

''commandName'' ''argument1'' ''argument2''

This can be triggered from the player's console or directly from the chat box by prefixing the message with a forward slash (''/''). For server side handlers, the server admin is also able to trigger these directly from the server's console in the same way as they are triggered from a player's console.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool addCommandHandler ( string commandName, function handlerFunction, [bool restricted = false, bool caseSensitive = true] )
</syntaxhighlight>

===Required Arguments===
*'''commandName:''' This is the name of the command you wish to attach a handler to. This is what must be typed into the console to trigger the function.
*'''handlerFunction:''' This is the function that you want the command to trigger, which has to be defined before you add the handler. This function can take two parameters, playerSource and commandName, followed by as many parameters you expect after your command (see below). These are all optional.
===Optional Arguments===
{{OptionalArg}}
*'''restricted:''' Specify whether or not this command should be restricted by default. Use this on commands that should be inaccessible to everyone as default except special users specified in the ACL (Access Control List). This is to make sure admin commands such as ie. 'punish' won't be available to everyone if a server administrator forgets masking it in ACL. This argument defaults to false if nothing is specified.
{{New feature|3|1.0|
*'''caseSensitive:''' Specifies if the command handler will ignore the case for this command name.
}}

</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool addCommandHandler ( string commandName, function handlerFunction, [bool caseSensitive = true] )
</syntaxhighlight>

===Required Arguments===
*'''commandName:''' This is the name of the command you wish to attach a handler to. This is what must be typed into the console to trigger the function.
*'''handlerFunction:''' This is the function that you want the command to trigger, which has to be defined before you add the handler. This function can take two parameters, playerSource and commandName, followed by as many parameters you expect after your command (see below). These are all optional.
===Optional Arguments===
{{OptionalArg}}
{{New feature|3|1.0|
*'''caseSensitive:''' Specifies if the command handler will ignore the case for this command name.
}}
</section>

====Handler function parameters====
These are the parameters for the handler function that is called when the command is used.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">player playerSource, string commandName, [string arg1, string arg2, ...] </syntaxhighlight>

* '''playerSource:''' The player who triggered the command. If not triggered by a player (e.g. by admin), this will be ''false''.
* '''commandName:''' The name of the command triggered. This is useful if multiple commands go through one function.
* '''arg1, arg2, ...:''' Each word after command name in the original command is passed here in a seperate variable. If there is no value for an argument, its variable will contain [[nil]]. You can deal with a variable number of arguments using the vararg expression, as shown in '''Example 4''' below.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua"> string commandName, [string arg1, string arg2, ...] </syntaxhighlight>
* '''commandName:''' The name of the command triggered. This is useful if multiple commands go through one function.
* '''arg1, arg2, ...:''' Each word after command name in the original command is passed here in a seperate variable. If there is no value for an argument, its variable will contain [[nil]]. You can deal with a variable number of arguments using the vararg expression, as shown in '''Example 4''' below.
</section>

===Returns===
Returns ''true'' if the command handler was added successfully, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This example defines a command handler for the command ''createmarker''. This will create a red marker at the position of the player player who uses it.
<syntaxhighlight lang="lua">
-- Define our function that will handle this command
function consoleCreateMarker ( playerSource )
-- If a player triggered it (rather than the admin) then
if ( playerSource ) then
-- Get that player's position
local x, y, z = getElementPosition ( playerSource )
-- Create a size 2, red checkpoint marker at their position
createMarker ( x, y, z, "checkpoint", 2, 255, 0, 0, 255 )
-- Output it in his chat box
outputChatBox ( "You got a red marker", playerSource )
end
end
-- Attach the 'consoleCreateMarker' function to the "createmarker" command
addCommandHandler ( "createmarker", consoleCreateMarker )
</syntaxhighlight>

'''Example 2:''' A simple health setting command. If a player types ''/sethealth X'' in the chatbox his health will be set to X. Note that the function [[setElementHealth]] is used rather than something like "setPlayerHealth". This function is more generic and can also be used to set the health of vehicles.
<syntaxhighlight lang="lua">
function consoleSetHealth(playerSource, commandName, health)
setElementHealth(playerSource, tonumber(health))
end
addCommandHandler("sethealth", consoleSetHealth)
</syntaxhighlight>

'''Example 3:''' This example implements a ''set_vehicle_color'' command.
<syntaxhighlight lang="lua">
-- Define our function that will handle this command
function consoleSetVehicleColor ( playerSource, commandName, col1, col2, col3, col4 )
-- If a player triggered this in-game
if ( playerSource ) then
-- Get the player's vehicle
local playerVehicle = getPedOccupiedVehicle ( playerSource )
-- If the player is in a vehicle and we've got at least 1 parameter
if ( playerVehicle and col1 ) then
-- Get the vehicle's existing color and use it if fewer than 4 arguments were passed
local exCol1, exCol2, exCol3, exCol4 = getVehicleColor ( playerVehicle )

if not col2 then col2 = exCol2 end
if not col3 then col3 = exCol3 end
if not col4 then col4 = exCol4 end

-- Set the vehicle's color
setVehicleColor ( playerVehicle, col1, col2, col3, col4 )
else
-- If we didn't get at least 1 parameter or the player doesn't have a vehicle, display some help text
outputConsole ( "This function will set your current vehicle's colors. A vehicle can have up to 4 colors.", playerSource )
outputConsole ( "Syntax: set_vehicle_color color1 [ color2 color3 color4 ]", playerSource )
outputConsole ( "You must be in a vehicle to use this function.", playerSource )
end
end
end
-- Attach the 'consoleSetVehicleColor' function to the "set_vehicle_color" command
addCommandHandler ( "set_vehicle_color", consoleSetVehicleColor )
</syntaxhighlight>

'''Example 4:''' This example makes use of Lua's vararg expression to implement a ''check_parameters'' command to count the number of parameters passed, merge them all into a single string and output it. This is also shows you how you can use table.concat to merge all the passed arguments. This is particularly useful when you want to read in a sentence of text passed from the user.
<syntaxhighlight lang="lua">
-- Define our function that will handle this command (which can accept a variable number of arguments after commandName)
function consoleCheckParameters ( playerSource, commandName, ... )
-- If a player, not an admin, triggered it,
if playerSource then
-- Pack all extra arguments passed in a table
local parametersTable = {...}
-- Get the number of arguments in that table
local parameterCount = #parametersTable
-- Output it to the player's chatbox
outputChatBox ( "Number of parameters: " .. parameterCount, playerSource )
-- Join them together in a single comma-separated string
local stringWithAllParameters = table.concat( parametersTable, ", " )
-- Output this parameter list to the player's chatbox
outputChatBox ( "Parameters passed: " .. stringWithAllParameters, playerSource )
end
end
-- Attach the 'consoleCheckParameters' function to the "check_parameters" command
addCommandHandler ( "check_parameters", consoleCheckParameters )
</syntaxhighlight>

'''Example 5:''' This example shows using a single function to handle multiple command handlers. This isn't advised for general usage, as it makes code harder to understand, but where multiple command handlers share some logic, it can be a useful way of reducing duplicated code. Generally, it would be preferable to put this shared logic in a separate function instead, as this gives you more control over the flow.

<syntaxhighlight lang="lua">
-- make the function
function moneyCmd(player, cmd, amount)
if getElementData(player, "canUseMoneyFunctions") then -- the shared logic
if cmd == "givemoney" then
amount = tonumber(amount)
if amount then
givePlayerMoney(player, amount)
else
outputChatBox("[usage] /givemoney [amount]", player)
end
else if cmd == "takemoney" then
amount = tonumber(amount)
if amount then
takePlayerMoney(player, amount)
else
outputChatBox("[usage] /takemoney [amount]", player)
end
end
else
outputChatBox("You aren't able to use this command", player)
end
end

addCommandHandler("givemoney", moneyCmd);
addCommandHandler("takemoney", moneyCmd);
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
'''Example 1:''' This creates a GUI window and allows a player to change its alpha (transparency) value with a command. Note that, in a clientside script, the player using the command is not passed as a parameter to the handler function, since it is always the local player.

<syntaxhighlight lang="lua">--Create a window
myWindow = guiCreateWindow ( 0.30, 0.10, 0.5, 0.60, "GUI window title", true )

--Add a command handler to change the alpha of the GUI window. Usage example: 'alpha 0.15'
function changeAlpha ( commandName, alphaAmount )
-- All command parameters are strings, so we'll convert the value to a number first
alphaAmount = tonumber(alphaAmount)
guiSetAlpha ( myWindow, alphaAmount )
end
addCommandHandler ( "alpha", changeAlpha )
</syntaxhighlight>
</section>

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

SetCameraTarget

2010-04-03T05:07:42Z

Cecer1: Misleading information regarding peds. Added vehicles to the list for completeness.

__NOTOC__
{{Server client function}}
This function allows you to set a player's camera to follow other elements instead. Currently supported element types are:
*[[Player]]s
*<s>[[Ped]]s</s> - '''Currently planned for V1.2 Doesn't work yet'''
*<s>[[Vehicle]]s</s> - '''Currently planned for V1.2 Doesn't work yet'''
==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool setCameraTarget ( player thePlayer, [ element target ] )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player whose camera you wish to modify.

===Optional Arguments===
*'''target:''' The element that you want the camera to follow. If none is specified, the camera will target the player.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool setCameraTarget ( element target )
</syntaxhighlight>

===Required Arguments===
*'''target:''' The element that you want the local camera to follow.
</section>

===Returns===
Returns ''true'' if the function was successful, ''false'' otherwise.

==Example==
This is an example of how one could implement a spectator function. Using the left and right arrow keys you can view other players. Note that this code isn't complete as it doesn't take into account joining or quitting players.
<section class="client" name="Client script" show="true">
<syntaxhighlight lang="lua">
g_Players = getElementsByType("player") -- get a list of all players in the server
for i,aPlayer in ipairs(g_Players) do -- find out what index the local player has in the list
if aPlayer == getLocalPlayer() then
g_CurrentSpectated = i
break
end
end

function spectatePrevious() -- decrement the spectate index and spectate the corresponding player
if g_CurrentSpectated == 1 then
g_CurrentSpectated = #g_Players
else
g_CurrentSpectated = g_CurrentSpectated - 1
end
setCameraTarget(g_Players[g_CurrentSpectated])
end

function spectateNext() -- increment the spectate index and spectate the corresponding player
if g_CurrentSpectated == #g_Players then
g_CurrentSpectated = 1
else
g_CurrentSpectated = g_CurrentSpectated + 1
end
setCameraTarget(g_Players[g_CurrentSpectated])
end

-- Bind above functions to arrow keys
bindKey("arrow_l", "down", spectatePrevious)
bindKey("arrow_r", "down", spectateNext)
</syntaxhighlight>
</section>

==See Also==
{{Camera functions}}

Modules/MTA-MySQL/mysql field length

2009-11-24T19:11:07Z

Cecer1: Fixed the link to mysql_num_fields()

__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Returns the length of a given field in the last retreived row. The offset of the field must be an integer between '''1''' and '''[[Modules/MTA-MySQL/mysql_num_fields|mysql_num_fields()]]'''

==Syntax==
<syntaxhighlight lang="lua">
int mysql_field_length ( MySQLResult result, int offset )
</syntaxhighlight>
===Required arguments===
* '''result:''' A valid MySQL result
* '''offset:''' A valid offset

===Returns===
The given field data length.

===Example===
'''Example 1:'''
<syntaxhighlight lang="lua">
local result = mysql_query(handler, "SELECT name FROM account WHERE id='1' LIMIT 1") -- Execute the query
if (result) then
local row = mysql_fetch_row(result)
local length = mysql_field_length(result, 1)
outputDebugString("The length of " .. row[1] .. " is " .. length)
mysql_free_result(result) -- Free the result
end
</syntaxhighlight>

==See also==
{{Modules/MTA-MySQL/Result_functions}}

Talk:SetVehicleGravityPoint

2009-11-14T14:01:24Z

Cecer1:

Wouldn't setVehicleCenterOfGravity be a better name? Center-of-gravity (or center-of-mass) is the standard name for this position. [[User:EAi|eAi]] 00:25, 14 November 2009 (UTC)

I am fine either way.
The function still does the same after all.

SetVehicleGravityPoint

2009-11-13T19:25:57Z

Cecer1:

{{Useful Function}}
__NOTOC__
This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.

==Syntax==
<syntaxhighlight lang="lua">bool setVehicleGravityPoint( vehicle targetVehicle, float pointX, float pointY, float pointZ, float strength )</syntaxhighlight>

===Required Arguments===
* '''targetVehicle''': The vehicle you want to set the gravity of.
* '''pointX''': The X position of the gravity point.
* '''pointY''': The Y position of the gravity point.
* '''pointZ''': The Z position of the gravity point.
* '''strength''': The strength of the gravity as a multiple of the global gravity.

===Returns===
Returns ''true'' if the function was successful, ''false'' otherwise.

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function setVehicleGravityPoint( targetVehicle, pointX, pointY, pointZ, strength )
if isElement( targetVehicle ) and getElementType( targetVehicle ) == "vehicle" then
local vehicleX,vehicleY,vehicleZ = getElementPosition( targetVehicle )
local vectorX = vehicleX-pointX
local vectorY = vehicleY-pointY
local vectorZ = vehicleZ-pointZ
local length = ( vectorX^2 + vectorY^2 + vectorZ^2 )^0.5

local propX = vectorX^2 / length^2
local propY = vectorY^2 / length^2
local propZ = vectorZ^2 / length^2

local finalX = ( strength^2 * propX )^0.5
local finalY = ( strength^2 * propY )^0.5
local finalZ = ( strength^2 * propZ )^0.5

if vectorX > 0 then finalX = finalX * -1 end
if vectorY > 0 then finalY = finalY * -1 end
if vectorZ > 0 then finalZ = finalZ * -1 end

return setVehicleGravity( targetVehicle, finalX, finalY, finalZ )
end
return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Client" class="client" show="true">
This example makes a command that will make the player's current vehicle "fall" towards 0,0,50 with 5 times the global gravity.
<syntaxhighlight lang="lua">
function toFarm()
setVehicleGravityPoint(getPedOccupiedVehicle(getLocalPlayer()), 0, 0, 50, 5) -- Make the vehicle "fall"
end
addCommandHandler("tofarm", toFarm, false) -- Create the tofarm command
</syntaxhighlight>
</section>

Author: Cecer1

==See Also==
{{Useful_Functions}}

Template:Useful Functions

2009-11-13T19:25:25Z

Cecer1:

*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any clientside function from the server's side.</span>

*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span>

*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if it's arguments are of the right types and calls the error-function if one isn't.</span>

*[[doForAllElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function can be used to execute a specified function for all elements of a specified type.</span>

*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Takes two points and returns the direction from point A to point B.</span>

*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Formats a date on the basis of a format string and returns it.</span>

*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds a point based on a starting point, direction and distance.</span>

*[[GetTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» With this function you can get the [http://en.wikipedia.org/wiki/Unix_time UNIX timestamp].</span>

*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns one of two values based on a boolean expression.</span>

*[[IsYearALeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Checks if the given year is a leap year.</span>

*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span>

*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Protects a table and makes it read-only.</span>

*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span>

*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span>

*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span>

*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.</span>

*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds the absolute size of a table.</span>

*[[var_dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">»This function outputs information about one or more variables using outputConsole(). </span>

[[Category:Useful Functions]]

SetVehicleGravityPoint

2009-11-13T19:11:40Z

Cecer1:

{{Useful Function}}
__NOTOC__
This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.

==Syntax==
<syntaxhighlight lang="lua">bool setVehicleGravityPoint( vehicle targetVehicle, float pointX, float pointY, float pointZ, float strength )</syntaxhighlight>

===Required Arguments===
* '''targetVehicle''': The vehicle you want to set the gravity of.
* '''pointX''': The X position of the gravity point.
* '''pointY''': The Y position of the gravity point.
* '''pointZ''': The Z position of the gravity point.
* '''strength''': The strength of the gravity as a multiple of the global gravity.

===Returns===
Returns ''true'' if the function was successful, ''false'' otherwise.

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function setVehicleGravityPoint( targetVehicle, pointX, pointY, pointZ, strength )
if isElement( targetVehicle ) and getElementType( targetVehicle ) == "vehicle" then
local vehicleX,vehicleY,vehicleZ = getElementPosition( targetVehicle )
local vectorX = vehicleX-pointX
local vectorY = vehicleY-pointY
local vectorZ = vehicleZ-pointZ
local length = ( vectorX^2 + vectorY^2 + vectorZ^2 )^0.5

local propX = vectorX^2 / length^2
local propY = vectorY^2 / length^2
local propZ = vectorZ^2 / length^2

local finalX = ( strength^2 * propX )^0.5
local finalY = ( strength^2 * propY )^0.5
local finalZ = ( strength^2 * propZ )^0.5

if vectorX > 0 then finalX = finalX * -1 end
if vectorY > 0 then finalY = finalY * -1 end
if vectorZ > 0 then finalZ = finalZ * -1 end

return setVehicleGravity( targetVehicle, finalX, finalY, finalZ )
end
return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example makes a command that will make the player's current vehicle "fall" towards 0,0,50 with 5 times the global gravity.
<syntaxhighlight lang="lua">
function toFarm()
setVehicleGravityPoint(getPedOccupiedVehicle(getLocalPlayer()), 0, 0, 50, 5) -- Make the vehicle "fall"
end
addCommandHandler("tofarm", toFarm, false) -- Create the tofarm command
</syntaxhighlight>
</section>

Author: Cecer1

==See Also==
{{Useful_Functions}}

SetVehicleGravityPoint

2009-11-13T19:07:37Z

Cecer1: Created page with '{{Useful Function}} __NOTOC__ This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.. ==Syntax== <syntaxhighlight lang="lua">[lu…'

{{Useful Function}}
__NOTOC__
This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified..

==Syntax==
<syntaxhighlight lang="lua">bool setVehicleGravityPoint( vehicle targetVehicle, float pointX, float pointY, float pointZ, float strength )</syntaxhighlight>

===Required Arguments===
* '''targetVehicle''': The vehicle you want to set the gravity of.
* '''pointX''': The X position of the gravity point.
* '''pointY''': The Y position of the gravity point.
* '''pointZ''': The Z position of the gravity point.
* '''strength''': The strength of the gravity as a multiple of the global gravity.

===Returns===
Returns ''true'' if the function was successful, ''false'' otherwise.

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function setVehicleGravityPoint( targetVehicle, pointX, pointY, pointZ, strength )
if isElement( targetVehicle ) and getElementType( targetVehicle ) == "vehicle" then
local vehicleX,vehicleY,vehicleZ = getElementPosition( targetVehicle )
local vectorX = vehicleX-pointX
local vectorY = vehicleY-pointY
local vectorZ = vehicleZ-pointZ
local length = ( vectorX^2 + vectorY^2 + vectorZ^2 )^0.5

local propX = vectorX^2 / length^2
local propY = vectorY^2 / length^2
local propZ = vectorZ^2 / length^2

local finalX = ( strength^2 * propX )^0.5
local finalY = ( strength^2 * propY )^0.5
local finalZ = ( strength^2 * propZ )^0.5

if vectorX > 0 then finalX = finalX * -1 end
if vectorY > 0 then finalY = finalY * -1 end
if vectorZ > 0 then finalZ = finalZ * -1 end

return setVehicleGravity( targetVehicle, finalX, finalY, finalZ )
end
return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example makes a command that will make the player's current vehicle "fall" towards 0,0,50 with 5 times the global gravity.
<syntaxhighlight lang="lua">
function toFarm()
setVehicleGravityPoint(getPedOccupiedVehicle(getLocalPlayer()), 0, 0, 50, 5) -- Make the vehicle "fall"
end
addCommandHandler("tofarm", toFarm, false) -- Create the tofarm command
</syntaxhighlight>
</section>

Author: Cecer1

==See Also==
{{Useful_Functions}}

Call

2009-03-03T19:58:25Z

Cecer1: /* Example */

__NOTOC__
{{Server client function}}
This function is used to call a function from another resource (which must be running).

The function which you wish to call '''must''' first be exported within the resource's meta. For example:
<syntaxhighlight lang="xml"><meta>
<info author="jbeta" type="script" description="Scoreboard resource" />
<script src="scoreboard_client.lua" type="client"/>
<script src="scoreboard_exports.lua" type="server"/>

<script src="scoreboard_http.lua" type="server"/>

<export function="getScoreboardColumns" http="true" />
<export function="getScoreboardRows" http="true" />

<export function="addScoreboardColumn" type="server"/>
<export function="removeScoreboardColumn" type="server"/>

<export function="setPlayerScoreboardForced" type="server"/>
<export function="setScoreboardForced" type="client"/>
</meta></syntaxhighlight>
This enables other resources to call a function from this resource.

You cannot call a server function from the client or vice versa. See [[triggerServerEvent]] and [[triggerClientEvent]] for possibilities to do that.

{{New feature|3|1.0|
There is an easier syntax replacing this function. For example, you can instead of:<br>
call ( getResourceFromName ( "resource" ), "exportedFunction", 1, "2", "three" )
do much like a normal call:<br>
exports.resource:exportedFunction ( 1, "2", "three" )
}}

==Syntax==
<syntaxhighlight lang="lua">
var... call ( resource theResource, string theFunction, [ arguments... ] )
</syntaxhighlight>

===Required Arguments===
*'''theResource:''' This is a resource pointer which refers to the resource you are calling a function from.
*'''theFunction:''' This is a string with the name of the function which you want to call.

===Optional Arguments===
{{OptionalArg}}
*'''arguments:''' Any arguments you may want to pass to the function when it is called. Any number of arguments of can be specified, each being passed to the designated function.

===Returns===
Returns anything that the designated function has returned appropriately. If the function does not exist, is not exported, or the call was not successful it will return ''nil''.

==Example==
<section name="Server" class="server" show="true">
This extract shows adding of a "kills" column to the scoreboard resource. This then sets the ''gameShowKills'' variable to true, telling the rest of the script to start outputting kills.

<syntaxhighlight lang="lua">
function showKills ( option )
if option == false then
-- Remove the "kills" column
gameShowKills = false
call(getResourceFromName("scoreboard"), "removeScoreboardColumn", "kills")
else
-- Add the "kills" column
gameShowKills = true
call(getResourceFromName("scoreboard"), "addScoreboardColumn", "kills")
outputDebugString ( "Showing kills now..." )
end
end
</syntaxhighlight>
</section>

==See Also==
{{Resource_functions}}