RemovePlayerFromParty

Takes a player out of their party - the mode’s /leave and /kick.

reason "left" (the default) or "kicked" is what OnPlayerLeaveParty hears. The leader leaving hands the lead on (or ends the party, by [party] leader_leaves); a party left with one member ends.

Syntax

RemovePlayerFromParty(pid [, reason])

Parameter	Type
pid	number	the member
reason	string	"left" or "kicked" (optional)

Returns

boolean - false when in no party

Example

elseif cmd == "leave" then
  if not RemovePlayerFromParty(pid, "left") then SendClientMessage(pid, COLOUR_RED, "You are in no party.") end
  return true

See also

AddPlayerToParty · DisbandParty · OnPlayerLeaveParty · the Parties group of the index