GetTeamName: Difference between revisions
Jump to navigation
Jump to search
m (→Example) |
m (→Example) |
||
Line 17: | Line 17: | ||
This example gets the current team of a player, then prints its name to the chatbox. | This example gets the current team of a player, then prints its name to the chatbox. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function whatTeamAmIOn ( source ) | function whatTeamAmIOn (source) | ||
-- Get the player's team (source is the player who entered the command) | -- Get the player's team (source is the player who entered the command) | ||
local playerTeam = getPlayerTeam ( source ) | local playerTeam = getPlayerTeam(source) | ||
if ( playerTeam ) then -- if he was on a team | if (playerTeam) then -- if he was on a team | ||
outputChatBox ( getPlayerName ( source ) .. " is on team: " .. getTeamName ( playerTeam ) ) | outputChatBox(getPlayerName(source).." is on team: "..getTeamName(playerTeam)) | ||
else | else | ||
outputChatBox ( getPlayerName ( source ) .. " isn't on a team" ) | outputChatBox(getPlayerName(source).. " isn't on a team") | ||
end | end | ||
end | end | ||
-- Add console command to find your team when 'whatTeamAmIOn' is typed. | -- Add console command to find your team when 'whatTeamAmIOn' is typed. | ||
addCommandHandler ( "whatTeamAmIOn", whatTeamAmIOn ) | addCommandHandler("whatTeamAmIOn", whatTeamAmIOn) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Team_functions}} | {{Team_functions}} |
Revision as of 05:57, 10 April 2014
This function gets the team name of a team object.
Syntax
string getTeamName ( team theTeam )
Required Arguments
- theTeam: The team you want to retrieve the name of.
Returns
Returns a string representing the team's name if the team object was valid, false otherwise.
Example
This example gets the current team of a player, then prints its name to the chatbox.
function whatTeamAmIOn (source) -- Get the player's team (source is the player who entered the command) local playerTeam = getPlayerTeam(source) if (playerTeam) then -- if he was on a team outputChatBox(getPlayerName(source).." is on team: "..getTeamName(playerTeam)) else outputChatBox(getPlayerName(source).. " isn't on a team") end end -- Add console command to find your team when 'whatTeamAmIOn' is typed. addCommandHandler("whatTeamAmIOn", whatTeamAmIOn)
See Also
- countPlayersInTeam
- getPlayerTeam
- getPlayersInTeam
- getTeamColor
- getTeamFriendlyFire
- getTeamFromName
- getTeamName