SetPlayerTeam - Revision history

FileEX: /* See Also */

2024-09-06T23:01:35Z

FileEX: /* See Also */

2024-09-06T22:44:00Z

MarioKart: OOP syntax added

2014-07-12T06:58:45Z

OOP syntax added

← Older revision		Revision as of 06:58, 12 July 2014
Line 7:		Line 7:
	bool setPlayerTeam ( player thePlayer, team theTeam )		bool setPlayerTeam ( player thePlayer, team theTeam )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[player]]:setTeam\|team\|getPlayerTeam}}
	===Required Arguments===		===Required Arguments===
	*'''thePlayer:''' The [[player]] you wish to add to a team.		*'''thePlayer:''' The [[player]] you wish to add to a team.

Myonlake: Removed resolved issue #6861 (fixed on r5302)

2013-11-16T13:56:21Z

Removed resolved issue #6861 (fixed on r5302)

← Older revision		Revision as of 13:56, 16 November 2013
Line 34:		Line 34:
	addCommandHandler ( "takeawaymyteam", unassignTeam )		addCommandHandler ( "takeawaymyteam", unassignTeam )
	</syntaxhighlight>		</syntaxhighlight>

	~~==Issues==~~
	~~{{Issues\|~~
	~~{{Issue\|6861\|Teams members aren't sent to clients if set in onResourceStart}}~~
	}}

	==See Also==		==See Also==
	{{Team_functions}}		{{Team_functions}}

Arran Fortuna at 21:34, 10 October 2012

2012-10-10T21:34:25Z

← Older revision		Revision as of 21:34, 10 October 2012
Line 34:		Line 34:
	addCommandHandler ( "takeawaymyteam", unassignTeam )		addCommandHandler ( "takeawaymyteam", unassignTeam )
	</syntaxhighlight>		</syntaxhighlight>

			==Issues==
			{{Issues\|
			{{Issue\|6861\|Teams members aren't sent to clients if set in onResourceStart}}
			}}

	==See Also==		==See Also==
	{{Team_functions}}		{{Team_functions}}

Jbeta at 15:14, 9 November 2007

2007-11-09T15:14:35Z

← Older revision		Revision as of 15:14, 9 November 2007
Line 10:		Line 10:
	===Required Arguments===		===Required Arguments===
	*'''thePlayer:''' The [[player]] you wish to add to a team.		*'''thePlayer:''' The [[player]] you wish to add to a team.
	*'''theTeam:''' The [[team]] you want to add the player to.		*'''theTeam:''' The [[team]] you want to add the player to, or ''nil'' if you wish to unassign a player from his team.

	~~Note:~~ if you wish to unassign a player from a team~~, set theTeam to [[nil]]~~

	===Returns===		===Returns===
	Returns ''true'' if the player was successfully added to the specified team, ''false'' otherwise.		Returns ''true'' if the player was successfully added to the specified team or removed from his previous one, ''false'' otherwise.

	==Example==		==Example==
	This example adds a command to create a new team for a player, then add him to it. It also adds a command to remove him from ~~the~~ team ~~too~~.		This example adds a command to create a new team for a player, then add him to it. It also adds a command to remove him from his team.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function assignNewTeam ( source, commandName, teamName )		function assignNewTeam ( source, commandName, teamName )
Line 28:		Line 26:
	addCommandHandler ( "gimmeateam", assignNewTeam )		addCommandHandler ( "gimmeateam", assignNewTeam )

	function ~~unassignNewTeam~~ ( source, commandName )		function unassignTeam ( source, commandName )
	local theTeam = getPlayerTeam ( source ) -- Check if the player is on a team		local theTeam = getPlayerTeam ( source ) -- Check if the player is on a team
	if theTeam then -- this player is on a team, so we can remove them from it		if theTeam then -- this player is on a team, so we can remove them from it
Line 34:		Line 32:
	end		end
	end		end
	addCommandHandler ( "~~takeawaymeteam~~", ~~unassignNewTeam~~ )		addCommandHandler ( "takeawaymyteam", unassignTeam )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Team_functions}}		{{Team_functions}}

AlienX: /* Example */

2007-11-09T10:31:15Z

Example

← Older revision		Revision as of 10:31, 9 November 2007
Line 30:		Line 30:
	function unassignNewTeam ( source, commandName )		function unassignNewTeam ( source, commandName )
	local theTeam = getPlayerTeam ( source ) -- Check if the player is on a team		local theTeam = getPlayerTeam ( source ) -- Check if the player is on a team
	if theTeam then -- if it ~~was successfully created~~		if theTeam then -- this player is on a team, so we can remove them from it
	setPlayerTeam ( source, nil ) -- ~~add~~ the player to the ~~new~~ team		setPlayerTeam ( source, nil ) -- remove the player from the current team
	end		end
	end		end

AlienX: /* Example */

2007-11-09T10:30:26Z

Example

← Older revision		Revision as of 10:30, 9 November 2007
Line 34:		Line 34:
	end		end
	end		end
	addCommandHandler ( "takeawaymeteam", ~~assignNewTeam~~ )		addCommandHandler ( "takeawaymeteam", unassignNewTeam )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Team_functions}}		{{Team_functions}}

AlienX: New page: NOTOC {{Server function}} This function adds a player to an existing team. The player will automatically be removed from his current team if he's on one. ==Syntax== [lua...

2007-11-09T10:27:22Z

New page: __NOTOC__ {{Server function}} This function adds a player to an existing team. The player will automatically be removed from his current team if he's on one. ==Syntax== <syntaxhighlight lang="lua">[lua...

New page

__NOTOC__
{{Server function}}
This function adds a [[player]] to an existing [[team]]. The player will automatically be removed from his current team if he's on one.

==Syntax==
<syntaxhighlight lang="lua">
bool setPlayerTeam ( player thePlayer, team theTeam )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The [[player]] you wish to add to a team.
*'''theTeam:''' The [[team]] you want to add the player to.

Note: if you wish to unassign a player from a team, set theTeam to [[nil]]

===Returns===
Returns ''true'' if the player was successfully added to the specified team, ''false'' otherwise.

==Example==
This example adds a command to create a new team for a player, then add him to it. It also adds a command to remove him from the team too.
<syntaxhighlight lang="lua">
function assignNewTeam ( source, commandName, teamName )
local theTeam = createTeam ( teamName ) -- create a new team with the specified name
if theTeam then -- if it was successfully created
setPlayerTeam ( source, theTeam ) -- add the player to the new team
end
end
addCommandHandler ( "gimmeateam", assignNewTeam )

function unassignNewTeam ( source, commandName )
local theTeam = getPlayerTeam ( source ) -- Check if the player is on a team
if theTeam then -- if it was successfully created
setPlayerTeam ( source, nil ) -- add the player to the new team
end
end
addCommandHandler ( "takeawaymeteam", assignNewTeam )
</syntaxhighlight>

==See Also==
{{Team_functions}}

← Older revision		Revision as of 23:01, 6 September 2024
Line 37:		Line 37:
	==See Also==		==See Also==
	{{Player functions\|server}}		{{Player functions\|server}}
			{{Team functions\|server}}

← Older revision		Revision as of 22:44, 6 September 2024
Line 36:		Line 36:

	==See Also==		==See Also==
	{{~~Team_functions~~}}		{{Player functions\|server}}

SetPlayerTeam - Revision history

FileEX: /* See Also */

FileEX: /* See Also */

MarioKart: OOP syntax added

Myonlake: Removed resolved issue #6861 (fixed on r5302)

Arran Fortuna at 21:34, 10 October 2012

Jbeta at 15:14, 9 November 2007

AlienX: /* Example */

AlienX: /* Example */

AlienX: New page: __NOTOC__ {{Server function}} This function adds a player to an existing team. The player will automatically be removed from his current team if he's on one. ==Syntax== [lua...

AlienX: New page: NOTOC {{Server function}} This function adds a player to an existing team. The player will automatically be removed from his current team if he's on one. ==Syntax== [lua...