WoW:API InviteUnit: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (→‎Past changes: add note argument.)
m (Move page script moved page API InviteUnit to API InviteUnit without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 11: Line 11:
=== Returns  ===
=== Returns  ===
nil  
nil  
=== Example ===  
=== Example ===


<pre> InviteUnit("Dyselon"); </pre>
<pre> InviteUnit("Dyselon"); </pre>
Line 18: Line 18:


== Description ==
== Description ==
Invites the specified playerName to your group.
Invites the specified playerName to your group. Players from other realms can be invited by using this function, like so:
<pre>InviteUnit("Player-RealmName")</pre>
Presumably this can only be done with RealID friends, though it possibly also works with players in your current cross-realm zone.


== Past changes ==
== Past changes ==
{{patched|patch=3.0.8|note=This function originally accepted "token" as a possible argument, but was changed in the patch to accept only player names.|comment=Code should be updated to use [[API_UnitName|UnitName]]("token") instead.}}
{{Patch 3.0.8|note=This function originally accepted "token" as a possible argument, but was changed in the patch to accept only player names.|comment=Code should be updated to use [[API UnitName|UnitName]]("token") instead.}}

Latest revision as of 04:46, 15 August 2023

WoW API < InviteUnit

Invite a player to join your party.

 InviteUnit(playerName) 

Parameters[edit]

Arguments[edit]

(String playerName)

playerName
The name of the player you would like to invite to a group.

Returns[edit]

nil

Example[edit]

 InviteUnit("Dyselon"); 

Result[edit]

Description[edit]

Invites the specified playerName to your group. Players from other realms can be invited by using this function, like so:

InviteUnit("Player-RealmName")

Presumably this can only be done with RealID friends, though it possibly also works with players in your current cross-realm zone.

Past changes[edit]

Template:Patch 3.0.8