About this class

Team library.

Public Member Functions
int	BestAutoJoinTeam (void)
	Find out what the best choice of team it is to join. More...

int	TeamCount (void)
	Find out how many teams are registered in the current game. More...

int	OpenTeamCount (void)
	Find out how many teams are open to new players. More...

vector	Color (int teamID)
	Find out which color represents a team. More...

string	Name (int teamID)
	Find the name of a team, that you can use in prints and written text. More...

int	Score (int teamID)
	Find the current score of a team. More...

string	SpawnPoint (int teamID)
	Find the entity class name representing individual team spawn points. More...

int	NumPlayers (int teamID)
	Find out how many players are in an active team. More...

int	NumAlivePlayers (int teamID)
	Find out how many team players are active/alive in a match. More...

int	NumDeadPlayers (int teamID)
	Find out how many team players are currently inactive/dead in a match. More...

int	TotalDeaths (int teamID)
	Find out how many times all the players in a given team have 'died' in the game. More...

int	TotalFrags (int teamID)
	Find out how many times all the players in a given team have scored 'frags'. More...

float	Valid (int teamID)
	Find out if a given team exists, or valid. More...

void	AddScore (int teamID, int addedScore)
	Increases the score of a specified team. More...

void	SetScore (int teamID, int scoreValue)
	Overridess the score of a specified team. More...

entity	RandomPlayer (int teamID)
	Find a random player belonging to a given team. More...

void	SetUp (int teamID, string teamTitle, vector teamColor, float openTeam)
	Sets up a team for the current session. More...

void	AddClass (int teamID, string classType)
	Sets up a team class for the current session. More...

int	TotalClasses (int teamID)
	Find out how many classes are registered within a team. More...

string	ClassForIndex (int teamID, int classIndex)
	Find out the name of a team class given an index. More...

void	SetSpawnPoint (int teamID, string spawnPointEntityClassname)
	Sets up a team spawn point for the current session. More...

Member Function Documentation

◆ AddClass()

void teamAPI_t::AddClass	(	int	teamID,
		string	classType
	)

Sets up a team class for the current session.

Making them available to choose in the team selection menu. You can have different classes per teams also.

Parameters

teamID	specifies which team slot to occupy.
classType	specifies the name of the player class. Used as an identifer in rules and menus.

◆ AddScore()

void teamAPI_t::AddScore	(	int	teamID,
		int	addedScore
	)

Increases the score of a specified team.

Parameters

teamID	specifies the team to query.
addedScore	is the amount of points to add to the existing score.

◆ BestAutoJoinTeam()

int teamAPI_t::BestAutoJoinTeam ( void )

Find out what the best choice of team it is to join.

Returns: the team ID that needs an additional team member the most.

◆ ClassForIndex()

string teamAPI_t::ClassForIndex	(	int	teamID,
		int	classIndex
	)

Find out the name of a team class given an index.

Returns: the class type of a given team + index.

Parameters

teamID	specifies which team slot to query for class types.
classIndex	specifies the index of the class to query. Use teams.TotalClasses() for the range.

◆ Color()

vector teamAPI_t::Color ( int teamID )

Find out which color represents a team.

Returns: a normalized RGB color of a team.

Parameters

teamID specifies the team to query.

◆ Name()

string teamAPI_t::Name ( int teamID )

Find the name of a team, that you can use in prints and written text.

Returns: the name of a team.

Parameters

teamID specifies the team to query.

◆ NumAlivePlayers()

int teamAPI_t::NumAlivePlayers ( int teamID )

Find out how many team players are active/alive in a match.

Returns: the number of 'surviving' players that are part of a team.

Parameters

teamID specifies the team to query.

◆ NumDeadPlayers()

int teamAPI_t::NumDeadPlayers ( int teamID )

Find out how many team players are currently inactive/dead in a match.

Returns: the number of 'dead' players that are part of a team.

Parameters

teamID specifies the team to query.

◆ NumPlayers()

int teamAPI_t::NumPlayers ( int teamID )

Find out how many players are in an active team.

Returns: the number of players that are part of a team.

Parameters

teamID specifies the team to query.

◆ OpenTeamCount()

int teamAPI_t::OpenTeamCount ( void )

Find out how many teams are open to new players.

Returns: the amount of teams open to join.

◆ RandomPlayer()

entity teamAPI_t::RandomPlayer ( int teamID )

Find a random player belonging to a given team.

Returns: a single random entity reference to a player of a given team. Will return __NULL__ if one does not exist.

Parameters

teamID specifies the team to query.

◆ Score()

int teamAPI_t::Score ( int teamID )

Find the current score of a team.

Usually tested against the cvar scorelimit.

Returns: the score of a team.

Parameters

teamID specifies the team to query.

◆ SetScore()

void teamAPI_t::SetScore	(	int	teamID,
		int	scoreValue
	)

Overridess the score of a specified team.

Parameters

teamID	specifies the team to query.
scoreValue	is the value which the score should be set to.

◆ SetSpawnPoint()

void teamAPI_t::SetSpawnPoint	(	int	teamID,
		string	spawnPointEntityClassname
	)

Sets up a team spawn point for the current session.

Using this function you can override the default team spawn, such as info_player_deathmatch type entities - and reroute spawns for a specific team to a different class.

Parameters

teamID	specifies which team slot to occupy.
spawnPointEntityClassname	specifies the classname of this team's spawn point.

◆ SetUp()

void teamAPI_t::SetUp	(	int	teamID,
		string	teamTitle,
		vector	teamColor,
		float	openTeam
	)

Sets up a team for the current session.

Will flush the team specific scores.

Parameters

teamID	specifies which team slot to occupy.
teamTitle	specifies the title of the team.
teamColor	specifies the color of the team (e.g. [0, 255, 0] for green).
openTeam	specifies whether players can join the team manually.

◆ SpawnPoint()

string teamAPI_t::SpawnPoint ( int teamID )

Find the entity class name representing individual team spawn points.

Returns: the default spawn point class of a team.

Parameters

teamID specifies the team to query.

◆ TeamCount()

int teamAPI_t::TeamCount ( void )

Find out how many teams are registered in the current game.

Returns: the amount of teams set up in the game.

◆ TotalClasses()

int teamAPI_t::TotalClasses ( int teamID )

Find out how many classes are registered within a team.

Returns: the maximum number of classes this team can select.

Parameters

teamID specifies which team slot to query for class types.

◆ TotalDeaths()

int teamAPI_t::TotalDeaths ( int teamID )

Find out how many times all the players in a given team have 'died' in the game.

Returns: the number of deaths in a given team.

Parameters

teamID specifies the team to query.

◆ TotalFrags()

int teamAPI_t::TotalFrags ( int teamID )

Find out how many times all the players in a given team have scored 'frags'.

A frag can be a 'kill' or just an alternative way of saying scorepoints, specific to players.

Returns: the number of frags in a given team.

Parameters

teamID specifies the team to query.

◆ Valid()

float teamAPI_t::Valid ( int teamID )

Find out if a given team exists, or valid.

Invalid teams should not be joined, and aren't offered on the client.

Returns: whether a team ID is valid, set up.

Parameters

teamID specifies the team to query.

The documentation for this struct was generated from the following file:

src/shared/api.h

About this class

Public Member Functions

Member Function Documentation

◆ AddClass()

◆ AddScore()

◆ BestAutoJoinTeam()

◆ ClassForIndex()

◆ Color()

◆ Name()

◆ NumAlivePlayers()

◆ NumDeadPlayers()

◆ NumPlayers()

◆ OpenTeamCount()

◆ RandomPlayer()

◆ Score()

◆ SetScore()

◆ SetSpawnPoint()

◆ SetUp()

◆ SpawnPoint()

◆ TeamCount()

◆ TotalClasses()

◆ TotalDeaths()

◆ TotalFrags()

◆ Valid()