WoW:API UnitPlayerControlled: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API UnitPlayerControlled to API UnitPlayerControlled without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<center>'''UnitPlayerControlled''' - ''Documentation by VelvetPaw''</center>
{{wowapi}}


Return whether the "unit" is controlled by a player or an NPC.
Return whether the "unit" is controlled by a player or an NPC.
Line 8: Line 8:
:("unit")
:("unit")


:;unit : String - The [[API TYPE UnitId|UnitId]] to select as a target.
:;unit : String - The [[API TYPE UnitId|UnitId]] to select as a target. Using a unit's name as the unit ID only works if the unit is a member of your party.


=== Returns ===
=== Returns ===
Line 27: Line 27:


:;[[API ScrollingMessageFrame AddMessage|ScrollingMessageFrame:AddMessage("text",r,g,b,id)]] : Valid Frame names:<br>DEFAULT_CHAT_FRAME<br>ChatFrame1 - ChatFrame7
:;[[API ScrollingMessageFrame AddMessage|ScrollingMessageFrame:AddMessage("text",r,g,b,id)]] : Valid Frame names:<br>DEFAULT_CHAT_FRAME<br>ChatFrame1 - ChatFrame7
----
{{WoW API}}

Latest revision as of 04:47, 15 August 2023

WoW API < UnitPlayerControlled

Return whether the "unit" is controlled by a player or an NPC.

UnitIsPlayerControlled = UnitPlayerControlled("unit")

Parameters[edit]

Arguments[edit]

("unit")
unit
String - The UnitId to select as a target. Using a unit's name as the unit ID only works if the unit is a member of your party.

Returns[edit]

UnitIsPlayerControlled
UnitIsPlayerControlled
Boolean - Returns true if the "unit" is controlled by a player.
Returns false if the "unit" is an NPC.

Example[edit]

if (UnitPlayerControlled("target")) then
  DEFAULT_CHAT_FRAME:AddMessage("Your selected target is a player.",1,1,0)
else
  DEFAULT_CHAT_FRAME:AddMessage("Your selected target is an NPC.",1,1,0)
end

Info[edit]

DEFAULT_CHAT_FRAME:AddMessage("text",r,g,b)[edit]

ScrollingMessageFrame:AddMessage("text",r,g,b,id)
Valid Frame names:
DEFAULT_CHAT_FRAME
ChatFrame1 - ChatFrame7