ESOUI - How to put a control on the Guild Home page

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

- General Authoring Discussion (https://www.esoui.com/forums/forumdisplay.php?f=174)

- - How to put a control on the Guild Home page (https://www.esoui.com/forums/showthread.php?t=7161)

How to put a control on the Guild Home page

I want to put a control on the Guild Home screen. But I can't find a suitable event to respond to, comparable to EVENT_CRAFTING_STATION_INTERACT for crafting stations, or EVENT_OPEN_GUILD_BANK for the guild bank. Have I just overlooked it, or do I need a different approach?

In most cases you shouldn't actually add elements in response to an event, but instead create a scenefragment and assign it to a scene.
For example the guild home menu is a scene. The buttons on top (home, roster, history, etc) are one fragment which is added to the guild home scene.
A fragment is basically just a wrapper around a control and can be added to any number of scenes. When a scene shows up, it will automatically make all its fragments visible.

The scene you are looking for is called GUILD_HOME_SCENE. For most cases you can just create a ZO_SimpleSceneFragment.

Lua Code:

local fragment = ZO_SimpleSceneFragment:New(myControl)
GUILD_HOME_SCENE:AddFragment(myControl)

Of course you need to set your anchors as required. If you reuse a fragment on different scenes and want to position it relative to different elements, you can listen to a scene's "StateChange" callback:

Lua Code:

GUILD_HOME_SCENE:RegisterCallback("StateChange", function(oldState, newState)
    myControl:ClearAnchors()
    if(GUILD_HOME_SCENE:IsShowing()) then
        myControl:SetAnchor(...) -- configuration a
    else
        myControl:SetAnchor(...) -- configuration b
    end
end)

Otherwise you could just set them once when you first create the fragment.

Thank you for the very helpful reply.

Despite your help, I'm not yet up to speed. I'm having trouble positioning my control relative to
GUILD_HOME_SCENE. It is quite clearly being positioned relative to the main window. I suspect that is because my container control is an instance of TopLevelControl, which I'm sure isn't right, but it is the only thing the tutorials suggest, and I can't find any indication of what else it could be.

Code:

<GuiXml>

  <Controls>

    <TopLevelControl name="MyControl" hidden="true">

      <Dimensions x="200" y="200" />

      <Anchor point="BOTTOM" relativeTo="$(parent)" relativePoint="BOTTOM"  />

      <Controls>

        ... etc

      </Controls>

    </TopLevelControl>

  </Controls>

</GuiXml>

Perhaps try to change the relative anchor point of your control:

Code:

relativeTo="ZO_GuildHome"

Code:

relativeTo="ZO_GuildSharedInfo"

You can check the guild home files inside the esoui source code (download here http://www.esoui.com/downloads/info1...ourcecode.html
and extract, then look into the folders "esoui/ingame/guild").

Inside the keyboard subfolder you'll find the file guildhome_keyboard.xml and .lua including some control names where you could anchor to or set the parent of your control by the help of lua commands:

Lua Code:

yourControl:SetParent(parentControlName)

I'm trying to follow this advice:

Quote:

Originally Posted by sirinsidiator (Post 31573)

Of course you need to set your anchors as required. ... [Y]ou can listen to a scene's "StateChange" callback:

Lua Code:

GUILD_HOME_SCENE:RegisterCallback("StateChange", function(oldState, newState)
    myControl:ClearAnchors()
    if(GUILD_HOME_SCENE:IsShowing()) then
        myControl:SetAnchor(...) -- configuration a
    end
end)

My difficulty is that calling myControl:ClearAnchors() results in the message *function expected instead of nil* and d() confirms that myControl.ClearAnchors is in fact nil (but myControl is not). Any suggestions about what I am doing wrong?

Quote:

Originally Posted by BoarGules (Post 31648)

I'm trying to follow this advice:

My difficulty is that calling myControl:ClearAnchors() results in the message *function expected instead of nil* and d() confirms that myControl.ClearAnchors is in fact nil (but myControl is not). Any suggestions about what I am doing wrong?

Show us your definition of myControl. I would say your myControl is not a control, but something else.