View source for API:IsPlayerMainAssist

{{LuaApi|group=Group}}
Returns whether the player is the main assist of their group, as the number <code>1</code> or <code>0</code>.

<pre>
isMainAssist = IsPlayerMainAssist()
</pre>

== Arguments ==
None.

== Returns ==
;isMainAssist : <code>number</code> – <code>1</code> if the main assist id the client has stored equals the player's own character id, otherwise <code>0</code>. Nothing if there is no player object.

== Details ==
* The result is a '''number''', not a boolean. <code>0</code> is a true value in Lua, so compare with <code>== 1</code>, as the stock UI does.
* The same stored main assist id is used for the <code>isMainAssist</code> field of [[API:GameData.GetScenarioPlayerGroups|GameData.GetScenarioPlayerGroups]].

== Errors ==
None.

== Example ==
From <code>default/ea_playerstatuswindow/source/playerwindow.lua</code>:
<pre>
playerIsMainAssist = ( IsPlayerMainAssist() == 1 )
</pre>

== See also ==
* [[API:IsPlayerSolo|IsPlayerSolo]]
* [[API:GetGroupData|GetGroupData]]