View source for API:GetNewbieGuildFlag

{{LuaApi|group=Guild}}
Returns whether the player is in a newbie guild.

<pre>
isInNewbieGuild = GetNewbieGuildFlag()
</pre>

== Arguments ==
None.

== Returns ==
;isInNewbieGuild : <code>boolean</code> – <code>true</code> if the player is in a newbie guild.

== Details ==
* The function returns a flag the client stores; it does not contact the server.
* The stock UI calls it once when the roster tab is set up and then follows changes through <code>SystemData.Events.GUILD_NEWBIE_GUILD_STATUS_UPDATED</code>, whose handler receives the same flag as its argument.

== Errors ==
None.

== Example ==
From <code>default/ea_guildwindow/source/guildwindowtabroster.lua</code>:
<pre>
WindowRegisterEventHandler("GWRoster", SystemData.Events.GUILD_NEWBIE_GUILD_STATUS_UPDATED, "GuildWindowTabRoster.OnNewbieGuildStatusUpdated")
GuildWindowTabRoster.OnNewbieGuildStatusUpdated(GetNewbieGuildFlag())
...
function GuildWindowTabRoster.OnNewbieGuildStatusUpdated(isInNewbieGuild)
    -- Do not show the "Hide Offline" check box if the player is in a newbie guild
    WindowSetShowing("GWRosterHideOfflineHeader", not isInNewbieGuild)
    WindowSetShowing("GWRosterHideOfflineCheckBox", not isInNewbieGuild)
end
</pre>

== See also ==
* [[API:GetGuildMemberData|GetGuildMemberData]]