WoW:API InviteUnit: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
("Several functions no longer accept unit tokens as parameters, and should now be used in conjunction with UnitName("token") instead.")
Line 1: Line 1:
{{wowapi}}__NOTOC__
{{wowapi}}__NOTOC__
Invite a player to join your party.  
Invite a player to join your party.  
<pre> InviteUnit(playerName); or InviteUnit(UnitName("token")) </pre>
<pre> InviteUnit(playerName) </pre>


== Parameters ==
== Parameters ==
=== Arguments ===
=== Arguments ===
(String playerName, unit)  
(String playerName)  


:; [[API_UnitName|UnitName]]("token") : For example UnitName("target")
:; playerName : The name of the player you would like to invite to a group.  
:; playerName : The name of the player you would like to invite to a group.  


Line 20: Line 19:
== Description ==
== Description ==
Invites the specified playerName to your group.
Invites the specified playerName to your group.
== History ==
Patch 3.0.8 - This function originally accepted "token" as a possible argument, but was changed in the patch to accept only player names. Code should be updated to use [[API_UnitName|UnitName]]("token") instead.

Revision as of 20:19, 1 April 2009

WoW API < InviteUnit

Invite a player to join your party.

 InviteUnit(playerName) 

Parameters

Arguments

(String playerName)

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

Returns

nil

Example

 InviteUnit("Dyselon"); 

Result

Description

Invites the specified playerName to your group.

History

Patch 3.0.8 - This function originally accepted "token" as a possible argument, but was changed in the patch to accept only player names. Code should be updated to use UnitName("token") instead.