Multi Theft Auto: Wiki - User contributions [en]

GetPlayerTeam

2018-07-23T21:10:59Z

Ahmedsayed Hamada: /* Syntax */

{{Server client function}}
__NOTOC__
This function gets the current [[team]] a [[player]] is on.

==Syntax==
<syntaxhighlight lang="lua">
team getPlayerTeam ( player )
</syntaxhighlight>
{{OOP||[[player]]:getTeam|team|setPlayerTeam}}
===Required Arguments===
*'''thePlayer''': The [[player]] whose team you want to find out.

===Returns===
Returns a ''team'' element representing the team the player is on, ''false'' if the player is not part of a team.

==Example==
<section name="Server" class="server" show="true">
This example finds the team a player is on, and then changes its name.
<syntaxhighlight lang="lua">
function teamName ( source, key, newTeamName )
local playerTeam = getPlayerTeam ( source ) -- get the player's team
if ( playerTeam ) then -- if he's on a team
local oldTeamName = getTeamName ( playerTeam ) -- get the team's current name
setTeamName ( playerTeam, newTeamName ) -- change its name
outputChatBox ( "Changed " .. getPlayerName ( source ).."'s team name from " .. oldTeamName .. " to " .. newTeamName )
else
outputChatBox ( getPlayerName ( source ) .. " isn't on a team" )
end
end
addCommandHandler ( "teamname", teamName )
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

CountPlayersInTeam

2018-07-23T21:09:59Z

Ahmedsayed Hamada: /* Syntax */

__NOTOC__
{{Server client function}}
This function is for returning the number of players in the specified team.

==Syntax==
<syntaxhighlight lang="lua">
int countPlayersInTeam ( team [TY] )
</syntaxhighlight>
{{OOP||[[team]]:countPlayers|playerCount|}}
===Optional Arguments===
*'''theTeam:''' The team you wish to retrieve the player count of.

===Returns===
Returns an integer containing the number of players in the team, ''false'' if it could not be retrieved.

==Example==
<section name="Example 1" class="server" show="true">
This example adds a command in the console to find out how many players are on your team.
<syntaxhighlight lang="lua">
function outputTeamSize ( source, ty7i )
-- Get player's team
local theTeam = getPlayerTeam ( source )
-- If the player is in any team
if theTeam then
-- Tell the player how big his team is
outputChatBox ( "Your team has " .. countPlayersInTeam ( theTeam ) .. " players.", source )
else
outputChatBox ( "You're not in a team.", source )
end
end
addCommandHandler ( "teamsize", outputTeamSize )
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="true">
This example adds a command in the console to find out how many players are on your team, clientside
<syntaxhighlight lang="lua">
function outputTeamSize ( commandName )
-- Get player's team
local theTeam = getPlayerTeam ( getLocalPlayer() )
-- If the player is in any team
if team then
-- Tell the player how big his team is
outputChatBox ( "Your team has " .. countPlayersInTeam ( theTeam ) .. " players." )
else
outputChatBox ( "You're not in a team." )
end
end
addCommandHandler ( "teamsize", outputTeamSize )
</syntaxhighlight>
</section>
<section name="Example 3" class="server" show="true">
This example balances a gamemode, to ensure equal number of players between the "grove" and "ballas" teams. This could be triggered when a player joins the server, or for all players currently in the server when the gamemode starts.
<syntaxhighlight lang="lua">
function balanceTeams ( thePlayer )
--get the team pointers from their names
local groveTeam = getTeamFromName ( "grove" )
local ballasTeam = getTeamFromName ( "ballas" )
--count the number of players in each team, and store them
local groveCount = countPlayersInTeam ( groveTeam )
local ballasCount = countPlayersInTeam ( ballasTeam )
if groveCount == ballasCount then --if the teams are equal
setPlayerTeam ( thePlayer , groveTeam ) --place the player in grove
elseif groveCount > ballasCount then --if there are more in grove
setPlayerTeam ( thePlayer , ballasTeam ) --place him in ballas
elseif groveCount < ballasCount then --if there are more in ballas
setPlayerTeam ( thePlayer , groveTeam ) --place him in grove.
end
end</syntaxhighlight>
</section>

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

CountPlayersInTeam

2018-07-23T21:09:32Z

Ahmedsayed Hamada: /* Example */

__NOTOC__
{{Server client function}}
This function is for returning the number of players in the specified team.

==Syntax==
<syntaxhighlight lang="lua">
int countPlayersInTeam ( team theTeam )
</syntaxhighlight>
{{OOP||[[team]]:countPlayers|playerCount|}}
===Optional Arguments===
*'''theTeam:''' The team you wish to retrieve the player count of.

===Returns===
Returns an integer containing the number of players in the team, ''false'' if it could not be retrieved.

==Example==
<section name="Example 1" class="server" show="true">
This example adds a command in the console to find out how many players are on your team.
<syntaxhighlight lang="lua">
function outputTeamSize ( source, ty7i )
-- Get player's team
local theTeam = getPlayerTeam ( source )
-- If the player is in any team
if theTeam then
-- Tell the player how big his team is
outputChatBox ( "Your team has " .. countPlayersInTeam ( theTeam ) .. " players.", source )
else
outputChatBox ( "You're not in a team.", source )
end
end
addCommandHandler ( "teamsize", outputTeamSize )
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="true">
This example adds a command in the console to find out how many players are on your team, clientside
<syntaxhighlight lang="lua">
function outputTeamSize ( commandName )
-- Get player's team
local theTeam = getPlayerTeam ( getLocalPlayer() )
-- If the player is in any team
if team then
-- Tell the player how big his team is
outputChatBox ( "Your team has " .. countPlayersInTeam ( theTeam ) .. " players." )
else
outputChatBox ( "You're not in a team." )
end
end
addCommandHandler ( "teamsize", outputTeamSize )
</syntaxhighlight>
</section>
<section name="Example 3" class="server" show="true">
This example balances a gamemode, to ensure equal number of players between the "grove" and "ballas" teams. This could be triggered when a player joins the server, or for all players currently in the server when the gamemode starts.
<syntaxhighlight lang="lua">
function balanceTeams ( thePlayer )
--get the team pointers from their names
local groveTeam = getTeamFromName ( "grove" )
local ballasTeam = getTeamFromName ( "ballas" )
--count the number of players in each team, and store them
local groveCount = countPlayersInTeam ( groveTeam )
local ballasCount = countPlayersInTeam ( ballasTeam )
if groveCount == ballasCount then --if the teams are equal
setPlayerTeam ( thePlayer , groveTeam ) --place the player in grove
elseif groveCount > ballasCount then --if there are more in grove
setPlayerTeam ( thePlayer , ballasTeam ) --place him in ballas
elseif groveCount < ballasCount then --if there are more in ballas
setPlayerTeam ( thePlayer , groveTeam ) --place him in grove.
end
end</syntaxhighlight>
</section>

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

CreateTeam

2018-07-23T21:07:36Z

Ahmedsayed Hamada: /* Example */

__NOTOC__
{{Server function}}
This function is for creating a new [[team]], which can be used to group players. Players will not join the team until they are respawned.

==Syntax==
<syntaxhighlight lang="lua">
team createTeam ( string teamName, [int colorR = 255, int colorG = 255, int colorB = 255] )
</syntaxhighlight>
{{OOP||Team.create||}}
===Required Arguments===
*'''teamName:[TY][[https:joinTY team&13462354]]
== Headline text ==Egypt
[http://@ahmty@2345245]

===Optional Arguments===
*'''colorR:''' An integer representing the red color value.
*'''colorG:''' An integer representing the green color value.
*'''colorB:''' An integer representing the blue color value.

===Returns===
join TY team

==Example==
'''Example 1:''' This example creates a new team for a player, then adds him to it.
<syntaxhighlight lang="lua">
function gimmeATeam ( source, ty7i, [TY] )
local newTeam = createTeam ( [TY] ) -- create a new team with the specified name
if newTeam then -- if it was successfully created
setPlayerTeam ( source, [TY] ) -- add the player to the new team
end
end
addCommandHandler("giveteam", ty7i)
</syntaxhighlight>

'''Example 2:''' This example creates two teams, one for Admin and one for Freeroamers, when the resource this script is in is started.
<syntaxhighlight lang="lua">
function createTeamsOnStart ()
teamAdmmin = createTeam ( "ty7i", 0, 255, 0 ) --change the 3 numbers(0,255,0), the first number is ColourR, the second is ColourG, and the last one is ColourB
teamFreeroamers = createTeam ( "Freeroamer", 200, 0, 100 )
end
addEventHandler("onResourceStart", resourceRoot, createTeamsOnStart) --we attach the function to this resource's root element
</syntaxhighlight>

'''Example 3:''' This example creates a team for Admin and when an admin logs in, he will be set in the Admin team.
<syntaxhighlight lang="lua">
function createAdminTeamOnStart ()
AdminTeam = createTeam ( "Admin", 0, 255, 0 )-- create a new team and name it 'Admin'
end
addEventHandler("onResourceStart", resourceRoot, createAdminTeamOnStart) -- add an event handler

function setAdminTeam()
if isObjectInACLGroup("user."..getAccountName(getPlayerAccount(source)), aclGetGroup("Admin")) then -- if he is admin
setPlayerTeam(source, AdminTeam) -- set him to admin team
end
end
addEventHandler("onPlayerLogin",getRootElement(),setAdminTeam) -- add an event handler
</syntaxhighlight>

==See Also==
{{Team_functions}}

CreateTeam

2018-07-23T21:05:53Z

Ahmedsayed Hamada: /* Example */

__NOTOC__
{{Server function}}
This function is for creating a new [[team]], which can be used to group players. Players will not join the team until they are respawned.

==Syntax==
<syntaxhighlight lang="lua">
team createTeam ( string teamName, [int colorR = 255, int colorG = 255, int colorB = 255] )
</syntaxhighlight>
{{OOP||Team.create||}}
===Required Arguments===
*'''teamName:[TY][[https:joinTY team&13462354]]
== Headline text ==Egypt
[http://@ahmty@2345245]

===Optional Arguments===
*'''colorR:''' An integer representing the red color value.
*'''colorG:''' An integer representing the green color value.
*'''colorB:''' An integer representing the blue color value.

===Returns===
join TY team

==Example==
'''Example 1:''' This example creates a new team for a player, then adds him to it.
<syntaxhighlight lang="lua">
function gimmeATeam ( source, ty7i, [TY] )
local newTeam = createTeam ( [TY] ) -- create a new team with the specified name
if newTeam then -- if it was successfully created
setPlayerTeam ( source, [TY] ) -- add the player to the new team
end
end
addCommandHandler("giveteam", ty7i)
</syntaxhighlight>

'''Example 2:''' This example creates two teams, one for Admin and one for Freeroamers, when the resource this script is in is started.
<syntaxhighlight lang="lua">
function createTeamsOnStart ()
teamAdmmin = createTeam ( "Admin", 0, 255, 0 ) --change the 3 numbers(0,255,0), the first number is ColourR, the second is ColourG, and the last one is ColourB
teamFreeroamers = createTeam ( "Freeroamer", 200, 0, 100 )
end
addEventHandler("onResourceStart", resourceRoot, createTeamsOnStart) --we attach the function to this resource's root element
</syntaxhighlight>

'''Example 3:''' This example creates a team for Admin and when an admin logs in, he will be set in the Admin team.
<syntaxhighlight lang="lua">
function createAdminTeamOnStart ()
AdminTeam = createTeam ( "Admin", 0, 255, 0 )-- create a new team and name it 'Admin'
end
addEventHandler("onResourceStart", resourceRoot, createAdminTeamOnStart) -- add an event handler

function setAdminTeam()
if isObjectInACLGroup("user."..getAccountName(getPlayerAccount(source)), aclGetGroup("Admin")) then -- if he is admin
setPlayerTeam(source, AdminTeam) -- set him to admin team
end
end
addEventHandler("onPlayerLogin",getRootElement(),setAdminTeam) -- add an event handler
</syntaxhighlight>

==See Also==
{{Team_functions}}

CreateTeam

2018-07-23T21:04:46Z

Ahmedsayed Hamada: /* Example */

__NOTOC__
{{Server function}}
This function is for creating a new [[team]], which can be used to group players. Players will not join the team until they are respawned.

==Syntax==
<syntaxhighlight lang="lua">
team createTeam ( string teamName, [int colorR = 255, int colorG = 255, int colorB = 255] )
</syntaxhighlight>
{{OOP||Team.create||}}
===Required Arguments===
*'''teamName:[TY][[https:joinTY team&13462354]]
== Headline text ==Egypt
[http://@ahmty@2345245]

===Optional Arguments===
*'''colorR:''' An integer representing the red color value.
*'''colorG:''' An integer representing the green color value.
*'''colorB:''' An integer representing the blue color value.

===Returns===
join TY team

==Example==
'''Example 1:''' This example creates a new team for a player, then adds him to it.
<syntaxhighlight lang="lua">
function gimmeATeam ( source, ty7i, [TY] )
local newTeam = createTeam ( [TY] ) -- create a new team with the specified name
if newTeam then -- if it was successfully created
setPlayerTeam ( source, newTeam ) -- add the player to the new team
end
end
addCommandHandler("giveteam", gimmeATeam)
</syntaxhighlight>

'''Example 2:''' This example creates two teams, one for Admin and one for Freeroamers, when the resource this script is in is started.
<syntaxhighlight lang="lua">
function createTeamsOnStart ()
teamAdmmin = createTeam ( "Admin", 0, 255, 0 ) --change the 3 numbers(0,255,0), the first number is ColourR, the second is ColourG, and the last one is ColourB
teamFreeroamers = createTeam ( "Freeroamer", 200, 0, 100 )
end
addEventHandler("onResourceStart", resourceRoot, createTeamsOnStart) --we attach the function to this resource's root element
</syntaxhighlight>

'''Example 3:''' This example creates a team for Admin and when an admin logs in, he will be set in the Admin team.
<syntaxhighlight lang="lua">
function createAdminTeamOnStart ()
AdminTeam = createTeam ( "Admin", 0, 255, 0 )-- create a new team and name it 'Admin'
end
addEventHandler("onResourceStart", resourceRoot, createAdminTeamOnStart) -- add an event handler

function setAdminTeam()
if isObjectInACLGroup("user."..getAccountName(getPlayerAccount(source)), aclGetGroup("Admin")) then -- if he is admin
setPlayerTeam(source, AdminTeam) -- set him to admin team
end
end
addEventHandler("onPlayerLogin",getRootElement(),setAdminTeam) -- add an event handler
</syntaxhighlight>

==See Also==
{{Team_functions}}

CreateTeam

2018-07-23T21:02:19Z

Ahmedsayed Hamada: /* Returns */

__NOTOC__
{{Server function}}
This function is for creating a new [[team]], which can be used to group players. Players will not join the team until they are respawned.

==Syntax==
<syntaxhighlight lang="lua">
team createTeam ( string teamName, [int colorR = 255, int colorG = 255, int colorB = 255] )
</syntaxhighlight>
{{OOP||Team.create||}}
===Required Arguments===
*'''teamName:[TY][[https:joinTY team&13462354]]
== Headline text ==Egypt
[http://@ahmty@2345245]

===Optional Arguments===
*'''colorR:''' An integer representing the red color value.
*'''colorG:''' An integer representing the green color value.
*'''colorB:''' An integer representing the blue color value.

===Returns===
join TY team

==Example==
'''Example 1:''' This example creates a new team for a player, then adds him to it.
<syntaxhighlight lang="lua">
function gimmeATeam ( source, commandName, teamName )
local newTeam = createTeam ( teamName ) -- create a new team with the specified name
if newTeam then -- if it was successfully created
setPlayerTeam ( source, newTeam ) -- add the player to the new team
end
end
addCommandHandler("giveteam", gimmeATeam)
</syntaxhighlight>

'''Example 2:''' This example creates two teams, one for Admin and one for Freeroamers, when the resource this script is in is started.
<syntaxhighlight lang="lua">
function createTeamsOnStart ()
teamAdmmin = createTeam ( "Admin", 0, 255, 0 ) --change the 3 numbers(0,255,0), the first number is ColourR, the second is ColourG, and the last one is ColourB
teamFreeroamers = createTeam ( "Freeroamer", 200, 0, 100 )
end
addEventHandler("onResourceStart", resourceRoot, createTeamsOnStart) --we attach the function to this resource's root element
</syntaxhighlight>

'''Example 3:''' This example creates a team for Admin and when an admin logs in, he will be set in the Admin team.
<syntaxhighlight lang="lua">
function createAdminTeamOnStart ()
AdminTeam = createTeam ( "Admin", 0, 255, 0 )-- create a new team and name it 'Admin'
end
addEventHandler("onResourceStart", resourceRoot, createAdminTeamOnStart) -- add an event handler

function setAdminTeam()
if isObjectInACLGroup("user."..getAccountName(getPlayerAccount(source)), aclGetGroup("Admin")) then -- if he is admin
setPlayerTeam(source, AdminTeam) -- set him to admin team
end
end
addEventHandler("onPlayerLogin",getRootElement(),setAdminTeam) -- add an event handler
</syntaxhighlight>

==See Also==
{{Team_functions}}

CreateTeam

2018-07-23T20:59:15Z

Ahmedsayed Hamada: /* Required Arguments */

__NOTOC__
{{Server function}}
This function is for creating a new [[team]], which can be used to group players. Players will not join the team until they are respawned.

==Syntax==
<syntaxhighlight lang="lua">
team createTeam ( string teamName, [int colorR = 255, int colorG = 255, int colorB = 255] )
</syntaxhighlight>
{{OOP||Team.create||}}
===Required Arguments===
*'''teamName:[TY][[https:joinTY team&13462354]]
== Headline text ==Egypt
[http://@ahmty@2345245]

===Optional Arguments===
*'''colorR:''' An integer representing the red color value.
*'''colorG:''' An integer representing the green color value.
*'''colorB:''' An integer representing the blue color value.

===Returns===
Returns a team element if it was successfully created, ''false'' if invalid arguments are passed or a team with that name already exists.

==Example==
'''Example 1:''' This example creates a new team for a player, then adds him to it.
<syntaxhighlight lang="lua">
function gimmeATeam ( source, commandName, teamName )
local newTeam = createTeam ( teamName ) -- create a new team with the specified name
if newTeam then -- if it was successfully created
setPlayerTeam ( source, newTeam ) -- add the player to the new team
end
end
addCommandHandler("giveteam", gimmeATeam)
</syntaxhighlight>

'''Example 2:''' This example creates two teams, one for Admin and one for Freeroamers, when the resource this script is in is started.
<syntaxhighlight lang="lua">
function createTeamsOnStart ()
teamAdmmin = createTeam ( "Admin", 0, 255, 0 ) --change the 3 numbers(0,255,0), the first number is ColourR, the second is ColourG, and the last one is ColourB
teamFreeroamers = createTeam ( "Freeroamer", 200, 0, 100 )
end
addEventHandler("onResourceStart", resourceRoot, createTeamsOnStart) --we attach the function to this resource's root element
</syntaxhighlight>

'''Example 3:''' This example creates a team for Admin and when an admin logs in, he will be set in the Admin team.
<syntaxhighlight lang="lua">
function createAdminTeamOnStart ()
AdminTeam = createTeam ( "Admin", 0, 255, 0 )-- create a new team and name it 'Admin'
end
addEventHandler("onResourceStart", resourceRoot, createAdminTeamOnStart) -- add an event handler

function setAdminTeam()
if isObjectInACLGroup("user."..getAccountName(getPlayerAccount(source)), aclGetGroup("Admin")) then -- if he is admin
setPlayerTeam(source, AdminTeam) -- set him to admin team
end
end
addEventHandler("onPlayerLogin",getRootElement(),setAdminTeam) -- add an event handler
</syntaxhighlight>

==See Also==
{{Team_functions}}