WoW:API SetGuildRosterShowOffline: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
m (Move page script moved page API SetGuildRosterShowOffline to API SetGuildRosterShowOffline without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<center>'''SetGuildRosterShowOffline''' </center>
{{wowapi}}
 
Enables or disables offline members filter for all calls of guild roster related function that follow.
Returns true if you are in range of the specified unit to perform the action specified by distIndex. Otherwise, returns false.


----
----
Line 13: Line 12:
;''Notes''
;''Notes''


:It appears making a call to this function results in an implicit call to GuildRoster().  That means the guild window will likely open after calling it.  See that function's details for more info.
:[[Events/G#GUILD_ROSTER_UPDATE|GUILD_ROSTER_UPDATE]] event is fired if and only the filtering mode was changed by the call. The function does not call [[API GuildRoster|GuildRoster()]] implicitly or explicitly.


----
----
;''Example''
;''Example''
  SetGuildRosterShowOffline(false);
  SetGuildRosterShowOffline(false);
----
{{Template:WoW API}}
[[Category:API Functions|SetGuildRosterShowOffline]]
[[Category:API Guild Functions|SetGuildRosterShowOffline]]

Latest revision as of 04:47, 15 August 2023

← WoW API < SetGuildRosterShowOffline

Enables or disables offline members filter for all calls of guild roster related function that follow.

Arguments
(Boolean enabled)
enabled
True to allow all guild members to be queried. False to filter out guild members who are offline.
Notes
GUILD_ROSTER_UPDATE event is fired if and only the filtering mode was changed by the call. The function does not call GuildRoster() implicitly or explicitly.
Example
SetGuildRosterShowOffline(false);
Retrieved from "https://addonstudio.org/mw1/index.php?title=WoW:API_SetGuildRosterShowOffline&oldid=12186"