Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards.

This function is restricted. #hwevent - This requires a hardware event i.e. keyboard/mouse input.

Removes a player from the group if you're the leader, or initiates a vote to kick.

UninviteUnit(name [, reason])

Arguments

name

string - Name of the player to remove from group. When removing cross-server players, it is important to include the server name: "Ygramul-Emerald Dream".

reason

string? - Used when initiating a kick vote against the player.

Details

• If you're in a Dungeon Finder group and call UninviteUnit without providing a reason, the VOTE_KICK_REASON_NEEDED event will fire to notify you that a reason is required to initiate a kick vote.

History

• The first argument to this function was changed from "unit" to "name" in Patch 3.0.8.
• The reason argument was added in Patch 3.3.3; previously, kick votes did not require a reason.