WoW:API UnitInParty: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Sry for those mass editing, hope this is fine now) |
||
| Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ | |||
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section --> | |||
Returns 1 if the unit is in your party, nil otherwise. | |||
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args --> | |||
isTrue = UnitInParty("arg1") | |||
---- | == Parameters == | ||
=== Arguments === | |||
<!-- List each argument, together with its type --> | |||
:;arg1 : String - Unit who should be checked | |||
=== Returns === | |||
<!-- List each return value, together with its type --> | |||
:;isTrue : 1 or nil | |||
== Example == | |||
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory --> | |||
local TargetInParty = UnitInParty("target") | |||
====Result==== | |||
<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. --> | |||
TargetInParty = 1 - If your target is in your party | |||
TargetInParty = nil - If your target is not in your party | |||
==Details== | |||
<!-- Details not appropriate for the main description can go here. | |||
REMOVE the section if you're just going to restate the intro line! --> | |||
: Pets are not considered to be part of your party. | |||
: UnitInParty("player") always returns false. (since patch 1.11.2, always returned 1 before) | |||
Revision as of 23:11, 12 July 2006
← WoW API < UnitInParty
Returns 1 if the unit is in your party, nil otherwise.
isTrue = UnitInParty("arg1")
Parameters
Arguments
- arg1
- String - Unit who should be checked
Returns
- isTrue
- 1 or nil
Example
local TargetInParty = UnitInParty("target")
Result
TargetInParty = 1 - If your target is in your party TargetInParty = nil - If your target is not in your party
Details
- Pets are not considered to be part of your party.
- UnitInParty("player") always returns false. (since patch 1.11.2, always returned 1 before)