WoW API: UnitCanAssist

From AddOn Studio
Jump to navigation Jump to search
Reference 

WoW API < UnitCanAssist

Indicates whether the first unit can assist the second unit.

canAssist = UnitCanAssist(unitToAssist, unitToBeAssisted);

Parameters[edit]

Arguments[edit]

unitToAssist
UnitId - the unit that would assist (e.g., "player" or "target")
unitToBeAssisted
UnitId - the unit that would be assisted (e.g., "player" or "target")

Returns[edit]

canAssist
Bool - 1 if the unitToAssist can assist the unitToBeAssisted, nil otherwise.

Example[edit]

  if (UnitCanAssist("player", "target")) then 
     DEFAULT_CHAT_FRAME:AddMessage("You can assist the target.")
  else 
     DEFAULT_CHAT_FRAME:AddMessage("You cannot assist the target.")
  end

Result[edit]

A message indicating whether the player can assist the current target is displayed in the default chat frame.