Multi Theft Auto: Wiki - User contributions [en]

GetServerName

2007-08-04T07:00:43Z

Sintax:

__NOTOC__
This function returns a string containing the server's name.

==Syntax==

<syntaxhighlight lang="lua">
string getServerName ( )
</syntaxhighlight>

===Required Arguments===
*'''None'''

===Returns===
A string containing the server's name.

==Example==
This example creates a console command that outputs the server's name the the chatbox.
<syntaxhighlight lang="lua">
function outputServerName ( )
outputChatBox ( getServerName( ) )
end

-- Add console command 'getServerName'
addCommandHandler ( "getServerName", outputServerName )
</syntaxhighlight>

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

GetServerName

2007-08-04T06:59:44Z

Sintax:

__NOTOC__
This function returns a string containing the server's name.

==Syntax==

<syntaxhighlight lang="lua">
returnType getServerName ( )
</syntaxhighlight>

===Required Arguments===
*'''None'''

===Returns===
A string containing the server's name.

==Example==
This example creates a console command that outputs the server's name the the chatbox.
<syntaxhighlight lang="lua">
function outputServerName ( )
outputChatBox ( getServerName() )
end

-- Add console command 'getServerName'
addCommandHandler ( "getServerName", outputServerName )
</syntaxhighlight>

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

GetSlotFromWeapon

2007-08-04T06:41:05Z

Sintax:

__NOTOC__
This allows you to identify the weapon slot that a weapon belongs to.

==Syntax==
<syntaxhighlight lang="lua">
int getSlotFromWeapon ( int weaponid )
</syntaxhighlight>

===Required Arguments===
*'''weaponid:''' The weapon ID to find the weapon slot of.

===Returns===
*Returns an integer representing the given weapon ID's associated weapon slot, false if invalid.

==Example==
This will output to the chatbox what weapon slot a given weapon number belongs to when entered into the console (ie. 'getWeaponSlot 10').
<syntaxhighlight lang="lua">
function outputWeaponSlot ( source, commandName, weaponID )
local weaponSlot = getSlotFromWeapon ( weaponID )

if (weaponSlot) then
outputChatBox ( "Weapon ID " .. weaponID .. " is in weapon slot " .. weaponSlot)
else
outputChatBox ( "Invalid weapon ID" )
end
end
addCommandHandler ( "getWeaponSlot", outputWeaponSlot )</syntaxhighlight>

==See Also==

[[Weapons|Weapon IDs]]
{{Weapon_functions}}

GetTeamFriendlyFire

2007-08-04T06:39:33Z

Sintax:

__NOTOC__
This function returns the friendly fire value for the specified team.

==Syntax==
<syntaxhighlight lang="lua">
bool getTeamFriendlyFire ( team theTeam )
</syntaxhighlight>

===Required Arguments===
*'''theTeam:''' The team object that will be checked

===Returns===
Returns ''true'' if friendly fire is on for the specified team, ''false'' if friendly fire is turned off for the specified team or if invalid arguments are specified.

==Example==
This example makes a command that checks if friendly fire is on for each team, and toggles it on if it isn't.
<syntaxhighlight lang="lua">
function setFriendlyFireOn ( )
-- For each team,
for index, theTeam in ipairs(getElementsByType ( "team" )) do
-- if friendly fire is off,
if ( getTeamFriendlyFire ( theTeam ) == false ) then
-- switch it on.
setTeamFriendlyFire ( theTeam, true )
end
end
end
-- Add console command 'setFF'
addCommandHandler ( "setFF", setFriendlyFireOn )
</syntaxhighlight>

==See Also==
{{Team functions}}

GetSlotFromWeapon

2007-08-04T06:31:49Z

Sintax:

GetSlotFromWeapon

2007-08-04T06:29:42Z

Sintax:

__NOTOC__
This allows you to identify the weapon slot that a weapon belongs to.

==Syntax==
<syntaxhighlight lang="lua">
int getSlotFromWeapon ( int weaponid )
</syntaxhighlight>

===Required Arguments===
*'''weaponid:''' Specify the weapon of which weapon slot you want to know.

===Returns===
*Returns an integer representing the given weapon ID's associated weapon slot, false if invalid.

==Example==
This will output to the chatbox what weapon slot a given weapon number belongs to when entered into the console (ie. 'getWeaponSlot 10').
<syntaxhighlight lang="lua">
function outputWeaponSlot ( source, commandName, weaponID )
local weaponSlot = getSlotFromWeapon ( weaponID )

if (weaponSlot) then
outputChatBox ( "Weapon ID " .. weaponID .. " is in weapon slot " .. weaponSlot)
else
outputChatBox ( "Invalid weapon ID" )
end
end
addCommandHandler ( "getWeaponSlot", outputWeaponSlot )</syntaxhighlight>

==See Also==

[[Weapons|Weapon IDs]]
{{Weapon_functions}}

GetSlotFromWeapon

2007-08-04T06:28:02Z

Sintax:

__NOTOC__
This allows you to identify the weapon slot that a weapon belongs to.

==Syntax==
<syntaxhighlight lang="lua">
int getSlotFromWeapon ( int weaponid )
</syntaxhighlight>

===Required Arguments===
*'''weaponid:''' Specify the weapon of which weapon slot you want to know.

===Returns===
*Returns the player's current weapon slot ID.
*Returns false if it fails to retrieve current weapon slot or if the weaponid is invalid.

==Example==
This will output to the chatbox what weapon slot a given weapon number belongs to when entered into the console (ie. 'getWeaponSlot 10').
<syntaxhighlight lang="lua">
function outputWeaponSlot ( source, commandName, weaponID )
local weaponSlot = getSlotFromWeapon ( weaponID )

if (weaponSlot) then
outputChatBox ( "Weapon ID " .. weaponID .. " is in weapon slot " .. weaponSlot)
else
outputChatBox ( "Invalid weapon ID" )
end
end
addCommandHandler ( "getWeaponSlot", outputWeaponSlot )</syntaxhighlight>

==See Also==

[[Weapons|Weapon IDs]]
{{Weapon_functions}}

GetTeamFromName

2007-08-02T03:45:33Z

Sintax: /* Example */

__NOTOC__
This function is for finding a team object from its name.

==Syntax==
<syntaxhighlight lang="lua">
team getTeamFromName ( string teamName )
</syntaxhighlight>

===Required Arguments===
*'''teamName:''' A string determining the name of the team you wish to find.

===Returns===
Returns the team object if it was found, 'false' otherwise.

==Example==
This example joins a team named "Red", if it is found.
<syntaxhighlight lang="lua">
function joinRedTeam ( source )
-- Try to find the team named 'Red'
team = getTeamFromName ( "Red" )

if ( team ) then -- If it was found (not false)
addPlayerToTeam ( source, team )
end
end

--Add console command to join the team when 'joinTeam' is typed.
addCommandHandler ( "joinTeam", joinRedTeam )
</syntaxhighlight>

==See Also==
{{Team_functions}}

GetTeamColor

2007-08-02T03:40:52Z

Sintax: /* Example */

__NOTOC__
This function is for retrieving the color of a team.

==Syntax==
<syntaxhighlight lang="lua">
int, int, int getTeamColor ( team theTeam )
</syntaxhighlight>

===Required Arguments===
*'''theTeam:''' The team you want to get the color of.

===Returns===
Returns 3 integers representing the red, green, and blue color values of the team if valid, otherwise 'false'.

==Example==
This example outputs the player's team name and colors if he is on a team.
<syntaxhighlight lang="lua">
function teamInfo ( source )
local r, g, b = 255, 255, 255
local team = getPlayerTeam( source )

-- Make a string to print out the player's team information
local string = getClientName ( source ) .. " spawned"

if ( team ) then -- If the player is on a team (team is not false)
-- Add the team name to the string
string = string.." as ".. getTeamName ( team )

-- Get the red, green, and blue values of the team's color
r, g, b = getTeamColor ( team )

-- Convert the colors to strings and add them to the string
string = string .. " with team colors: " .. tostring(r) .. ", " .. tostring(g) .. ", " .. tostring(b)
end

-- Print the string with the player's team information
outputChatBox ( string )
end

-- Add console command to print out your team information
addCommandHandler ( "teamInfo", teamInfo )
</syntaxhighlight>

==See Also==
{{Team_functions}}

GetTeamColor

2007-08-02T03:37:09Z

Sintax: /* Returns */

GetTeamColor

2007-08-02T03:36:39Z

Sintax: /* Returns */

GetTeamFromName

2007-08-01T22:01:34Z

Sintax: /* Example */

__NOTOC__
This function is for finding a team object from its name.

==Syntax==
<syntaxhighlight lang="lua">
team getTeamFromName ( string teamName )
</syntaxhighlight>

===Required Arguments===
*'''teamName:''' A string determining the name of the team you wish to find.

===Returns===
Returns the team object if it was found, 'false' otherwise.

==Example==
This example destroys a team named "Red", if it is found.
<syntaxhighlight lang="lua">
function joinRedTeam ( source )
-- Try to find the team named 'Red'
team = getTeamFromName ( "Red" )

if ( team ) then -- If it was found (not false)
addPlayerToTeam ( source, team )
end
end

--Add console command to join the team when 'joinTeam' is typed.
addCommandHandler ( "joinTeam", joinRedTeam )
</syntaxhighlight>

==See Also==
{{Team_functions}}

GetTeamName

2007-08-01T21:48:03Z

Sintax: /* Example */

__NOTOC__
This function is used to get a team's name.

==Syntax==
<syntaxhighlight lang="lua">
string getTeamName ( team theTeam )
</syntaxhighlight>

===Required Arguments===
*'''theTeam:''' The team you want to retrieve the name of.

===Returns===
Returns a string representing the teams name if the team was valid, 'false' otherwise.

==Example==
This example gets the current team of a player, then prints its name to the chatbox.
<syntaxhighlight lang="lua">
function whatTeamAmIOn ( source )
-- Get the player's team (source is the player who entered the command)
team = getPlayerTeam ( source )

if ( team ) then -- if he was on a team
outputChatBox ( getClientName ( source ).." is on team: "..getTeamName ( team ) )
else
outputChatBox ( getClientName ( source ).." isn't on a team" )
end
end

-- Add console command to find your team when 'whatTeamAmIOn' is typed.
addCommandHandler ( "whatTeamAmIOn", whatTeamAmIOn )
</syntaxhighlight>

==See Also==
{{Team_functions}}

GetTeamName

2007-08-01T21:47:13Z

Sintax: /* Example */

__NOTOC__
This function is used to get a team's name.

==Syntax==
<syntaxhighlight lang="lua">
string getTeamName ( team theTeam )
</syntaxhighlight>

===Required Arguments===
*'''theTeam:''' The team you want to retrieve the name of.

===Returns===
Returns a string representing the teams name if the team was valid, 'false' otherwise.

==Example==
This example gets the current team of a player, then prints its name to the chatbox.
<syntaxhighlight lang="lua">
function whatTeamAmIOn ( source )
-- get the player's team (source is the player who entered the command)
team = getPlayerTeam ( source )

if ( team ) then -- if he was on a team
outputChatBox ( getClientName ( source ).." is on team: "..getTeamName ( team ) )
else
outputChatBox ( getClientName ( source ).." isn't on a team" )
end
end

--Add console command to find your team when 'whatTeamAmIOn' is typed.
addCommandHandler ( "whatTeamAmIOn", whatTeamAmIOn )
</syntaxhighlight>

==See Also==
{{Team_functions}}

GetTeamName

2007-08-01T21:46:47Z

Sintax: /* Example */

__NOTOC__
This function is used to get a team's name.

==Syntax==
<syntaxhighlight lang="lua">
string getTeamName ( team theTeam )
</syntaxhighlight>

===Required Arguments===
*'''theTeam:''' The team you want to retrieve the name of.

===Returns===
Returns a string representing the teams name if the team was valid, 'false' otherwise.

function whatTeamAmIOn ( source )
-- get the player's team (source is the player who entered the command)
team = getPlayerTeam ( source )

if ( team ) then -- if he was on a team
outputChatBox ( getClientName ( source ).." is on team: "..getTeamName ( team ) )
else
outputChatBox ( getClientName ( source ).." isn't on a team" )
end
end

--Add console command to find your team when 'whatTeamAmIOn' is typed.
addCommandHandler ( "whatTeamAmIOn", whatTeamAmIOn )

==See Also==
{{Team_functions}}

GetThisResource

2007-08-01T21:25:26Z

Sintax: /* Example */

__NOTOC__
This function retrieves the resource from which the function call was made.

==Syntax==
<syntaxhighlight lang="lua">
resource getThisResource ( )
</syntaxhighlight>

===Returns===
Returns the resource in which the current script is.

==Example==
This example retrieves the current resource's root element and attaches it to an onResourceStart event handler. This causes the event handler to get called only when the ''current'' resource is started rather than when ''any'' resource is started, thereby reducing unnecessary overhead.
<syntaxhighlight lang="lua">
-- get the root element of this resource (the resource that the script is a part of)
resourceRoot = getResourceRootElement(getThisResource())

-- create a function to handle the onResourceStart event
function onCurrentResourceStart(theResource)
local resourceName = getResourceName(theResource)
outputChatBox("Hello and welcome to " .. resourceName .. "!")
end

-- add the event handler
addEventHandler("onResourceStart", resourceRoot, onCurrentResourceStart)
</syntaxhighlight>

==See Also==
{{Resource_functions}}
[[Category:Needs_Checking]]

GetThisResource

2007-08-01T21:14:27Z

Sintax: /* Example */

__NOTOC__
This function retrieves the resource from which the function call was made.

==Syntax==
<syntaxhighlight lang="lua">
resource getThisResource ( )
</syntaxhighlight>

===Returns===
Returns the resource in which the current script is.

==Example==
<syntaxhighlight lang="lua">
function onStartInScoresResource(resource)
local thisResource = getThisResource() -- get the resource that this script is a part of
if (resource == thisResource) then -- make sure the resource that started is the one this script is a part of
-- Note: without this check, the operations below would execute whenever ANY resource is loaded
-- perform some operations this script will be used for, in this case keeping track of player scores and money:
local players = getElementsByType("player")
for playerKey, playerValue in ipairs(players) do
setPlayerMoney(playerValue, 500)
setElementData(playerValue, "score", 0)
end
end
end
addEventHandler("onResourceStart", getResourceRootElement(getThisResource()), onStartInScoresResource)
</syntaxhighlight>

==See Also==
{{Resource_functions}}
[[Category:Needs_Checking]]