ESOUI - Scene Manager and the Hidden Attribute

ESOUI (https://www.esoui.com/forums/index.php)

- Lua/XML Help (https://www.esoui.com/forums/forumdisplay.php?f=175)

- - Scene Manager and the Hidden Attribute (https://www.esoui.com/forums/showthread.php?t=4207)

Scene Manager and the Hidden Attribute

So I understand (more or less) how the Scene Manager works. I know how to get it to show and hide a control based on what scene is open. The thing is, I want a control's visibility to also depend on whether the player is in a guild.

I know how to handle the conditional stuff and detecting when a player joins or leaves a guild; I'm just wondering how I would go about keeping the control hidden. As far as I can tell, there are three possibilities:

SetHidden(true)
Remove the fragment from all of its scenes
Both?

I'd like to know which one has priority: SetHidden or the scene manager. If I manually hide it, will the Scene Manager make it visible again if I switch scenes? If I remove it from all of its scenes, will it be shown or hidden by default?

AFAIK using both would work, but I was wondering if a simpler solution would be enough.

Scene fragments have a method called SetConditional which lets you add a callback that is evaluated whenever the fragment is refreshed. If the callback returns false the fragment is hidden. If it returns true whether it's shown is based on if it's part of a scene that is showing. So you could write a function that returns if the player is in a guild and pass that to SetConditional on the fragment. Then you just call Refresh on the fragment whenever it would change (when the player joins or leaves a guild).

I really like ZO_HUDFadeSceneFragment's hidden reasons (ZO_HiddenReasons).

Lua Code:

local ADDON_NAME = "someUniquieName"
 
local function OnLoaded(evt, name)
    if name:find("^ZO_") then return end
    EVENT_MANAGER:UnregisterForEvent(ADDON_NAME, evt)
 
    local tlw, texture, fragment
    tlw = WINDOW_MANAGER:CreateTopLevelWindow()
    tlw:SetDimensions(128,128)
    tlw:SetAnchor(CENTER, GuiRoot, CENTER, 0, 0)
    tlw:SetHidden(true)
    texture = WINDOW_MANAGER:CreateControl(nil, tlw, CT_TEXTURE)
    texture:SetTexture("esoui/art/icons/poi/poi_groupboss_complete.dds")
    texture:SetAnchorFill(tlw)
 
    fragment = ZO_HUDFadeSceneFragment:New(tlw)
 
    HUD_SCENE:AddFragment(fragment)
    HUD_UI_SCENE:AddFragment(fragment)
 
    --this part does all the work
    local function UpdateHidden()
        fragment:SetHiddenForReason("notInGuild", GetNumGuilds() == 0)
    end
 
    tlw:RegisterForEvent(EVENT_GUILD_SELF_JOINED_GUILD, UpdateHidden)
    tlw:RegisterForEvent(EVENT_GUILD_SELF_LEFT_GUILD, UpdateHidden)
end
 
EVENT_MANAGER:RegisterForEvent(ADDON_NAME, EVENT_ADDON_LOADED, OnLoaded)

But this method has just ZO_HUDFadeSceneFragment, if you use any other scene fragment, you should use SetConditional as ZOS_ChipHilseberg said:

Lua Code:

--the same code as above
    fragment:SetConditional(function() return GetNumGuilds() > 0 end)
 
    tlw:RegisterForEvent(EVENT_GUILD_SELF_JOINED_GUILD, function() fragment:Refresh() end)
    tlw:RegisterForEvent(EVENT_GUILD_SELF_LEFT_GUILD, function() fragment:Refresh() end)
--

Since I'm just using a ZO_SimpleSceneFragment, I'll go with the SetConditional method. Thanks for the quick answers!