GetTeamName: Difference between revisions
Jump to navigation
Jump to search
| (3 intermediate revisions by one other user not shown) | |||
| Line 8: | Line 8: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[team]]:getName|name|setTeamName}} | {{OOP||[[team]]:getName|name|setTeamName}} | ||
=== | ===Required Arguments=== | ||
*'''theTeam:''' | *'''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. | |||
<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) | ||
local playerTeam = getPlayerTeam(source) | local playerTeam = getPlayerTeam(source) | ||
if (playerTeam) then -- | if (playerTeam) then -- if he was on a team | ||
outputChatBox(getPlayerName(source).." | outputChatBox(getPlayerName(source).." is on team: "..getTeamName(playerTeam)) | ||
else | else | ||
outputChatBox(getPlayerName(source).. " | outputChatBox(getPlayerName(source).. " isn't on a team") | ||
end | end | ||
end | end | ||
-- | -- Add console command to find your team when 'whatTeamAmIOn' is typed. | ||
addCommandHandler("whatTeamAmIOn", whatTeamAmIOn) | addCommandHandler("whatTeamAmIOn", whatTeamAmIOn) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== | ==See Also== | ||
{{Team_functions}} | {{Team_functions}} | ||
Latest revision as of 14:44, 13 July 2019
This function gets the team name of a team object.
Syntax
string getTeamName ( team theTeam )
OOP Syntax Help! I don't understand this!
- Method: team:getName(...)
- Variable: .name
- Counterpart: setTeamName
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
- createTeam
- getPlayerTeam
- getPlayersInTeam
- getTeamColor
- getTeamFriendlyFire
- getTeamFromName
- getTeamName
- setPlayerTeam
- setTeamColor
- setTeamFriendlyFire
- setTeamName