getTeamFromName
Client-side
Server-side
Shared
Manual Review Required
Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.
This function finds a team element using the provided team name.
OOP Syntax Help! I don't understand this!
- Method: Team.getFromName(...)
Syntax
team getTeamFromName ( string teamName )Required Arguments
- teamName: A string determining the name of the team you wish to find.
Returns
- team: value
Returns the team element if it was found, false otherwise.
Code Examples
shared
This example creates a team, and sets the player's team to it's partial name:
-- Creates a red teamcreateTeam("Red", 255, 0, 0)
function joinRedTeam (source) local redteam = getTeamFromName("Red") if (redteam) then -- If the team was successfully created -- Sets the player's team by getting the partial name of the red team. setPlayerTeam(client, readteam) outputChatBox("You are now in the 'Red' team", source) else outputChatBox("Sorry, we can't set your team. An error occurred!", source) endend
--Add console command to join the team when 'joinTeam' is typed.addCommandHandler("jointeam", joinRedTeam)