ESOUI - Trouble Hiding Objects

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

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

- - Trouble Hiding Objects (https://www.esoui.com/forums/showthread.php?t=4764)

Trouble Hiding Objects

Hello again,

I am having trouble hiding objects related to the reticle, such as the reticle itself, stealth text, reticle interact button etc

In the mean time i have been setting a Anchor offscreen if i wanted to hide the element, then restoring the original anchor when i want to show it, as calling SetHidden(true) seems to hide it until it shows after exiting UI, killing an enemy and other cases. I have registered events to try and combat this, but it seems that unless i set a delay on the function that was registered to the event, that the object wil reappear (seems to reappear within first 0.7-0.8 seconds). I am guessing that I need to somehow unregister an event on the object (?), as I have seen that function in zgoo, however I havent had any success while playing around with it.

Any ideas?

The method ive been using in the meantime does work, however I would rather see if i can somehow use SetHidden() so i dont have to store original anchors and such.

Thank you

Quote:

Originally Posted by hoydyd (Post 21435)

Any ideas?

The method ive been using in the meantime does work, however I would rather see if i can somehow use SetHidden() so i dont have to store original anchors and such.

Thank you

The reticle hidden state is updated by various events and functions. (Together with the stealth and disguise state)
All calling this function:

Lua Code:

RETICLE:UpdateHiddenState()

The reticle control itself is:

Lua Code:

RETICLE.reticleTexture

You could post-hook RETICLE:UpdateHiddenState or replace/overwrite RETICLE.reticleTexture.SetHidden.

Quote:

Originally Posted by votan (Post 21436)

The reticle hidden state is updated by various events and functions. (Together with the stealth and disguise state)
All calling this function:

Lua Code:

RETICLE:UpdateHiddenState()

The reticle control itself is:

Lua Code:

RETICLE.reticleTexture

You could post-hook RETICLE:UpdateHiddenState or replace/overwrite RETICLE.reticleTexture.SetHidden.

Sorry, but what do you mean by posti-hook?, and regarding the RETICLE.reticleTexture.SetHidden(), wouldn't that only hide the crosshair itself? or would i be able to control the visibility of the stealth eye, and the interaction display and so-on using that method?

Also, I have been using ZO_ReticleContainerReticle, ZO_ReticleContainerStealth etc rather than RETICLE, what is the differences between ZO_ReticleContainer and RETICLE?

Thank you for your help

Quote:

Originally Posted by hoydyd (Post 21437)

Sorry, but what do you mean by posti-hook?

I'm at work now, so I can not test what I'm writing, but it is basically:

Lua Code:

local function HookReticle()
  local baseUpdateHiddenState = RETICLE.UpdateHiddenState
  -- Redefine UpdateHiddenState:
  function RETICLE:UpdateHiddenState()
    -- Do your pre-hook stuff
    baseUpdateHiddenState(self)
    -- Do your post-hook stuff
  end
end

Lua Code:

local function HookReticleSetHidden()
  local baseSetHidden = RETICLE.reticleTexture.SetHidden
  function RETICLE.reticleTexture:SetHidden(hidden)
    -- Modify hidden as needed
    baseSetHidden(self, hidden)
  end
end

Call the Hook function(s) in your AddOnLoaded event handler.

Quote:

Originally Posted by hoydyd (Post 21437)

and regarding the RETICLE.reticleTexture.SetHidden(), wouldn't that only hide the crosshair itself? or would i be able to control the visibility of the stealth eye, and the interaction display and so-on using that method?

Also, I have been using ZO_ReticleContainerReticle, ZO_ReticleContainerStealth etc rather than RETICLE, what is the differences between ZO_ReticleContainer and RETICLE?

Thank you for your help

I did not forget the parentheses. ;)
I talk about the reference to the function, not calling it. :)

RETICLE is the instance of the controller class handling the ZO_ReticleContainer control and its child controls.

Quote:

Originally Posted by votan (Post 21438)

I'm at work now, so I can not test what I'm writing, but it is basically:

Lua Code:

local function HookReticle()
  local baseUpdateHiddenState = RETICLE.UpdateHiddenState
  -- Redefine UpdateHiddenState:
  function RETICLE:UpdateHiddenState()
    -- Do your pre-hook stuff
    baseUpdateHiddenState(self)
    -- Do your post-hook stuff
  end
end

Lua Code:

local function HookReticleSetHidden()
  local baseSetHidden = RETICLE.reticleTexture.SetHidden
  function RETICLE.reticleTexture:SetHidden(hidden)
    -- Modify hidden as needed
    baseSetHidden(self, hidden)
  end
end

Call the Hook function(s) in your AddOnLoaded event handler.

I did not forget the parentheses. ;)
I talk about the reference to the function, not calling it. :)

RETICLE is the instance of the controller class handling the ZO_ReticleContainer control and its child controls.

Sorry, I sort of understand, but still have some confusion.

I think i just don't really understand some of the terms and what is meant by hooking, so i googled it and that i think i get what you mean.

Here:

Lua Code:

local function HookReticle()
  local baseUpdateHiddenState = RETICLE.UpdateHiddenState
  -- Redefine UpdateHiddenState:
  function RETICLE:UpdateHiddenState()
    -- Do your pre-hook stuff
    baseUpdateHiddenState(self)
    -- Do your post-hook stuff
  end
end

So the first RETICLE.UpdateHiddenState is the reference for the UpdateHiddenState() function, which belongs in RETICLE (Also why is it RETICLE.Update.. instead of RETICLE:Update..) We grab it now as we will need to store this original function to use, as we then redefine the function and thus change its contents.

the function RETICLE:UpdateHiddenState() is replacing the function UpdateHiddenState() in RETICLE, so we are pretty much redefining what the UpdateHiddenState() function in RETICLE does, so in this case where your '--Do your post-hook stuff' comment is, I would call SetHidden(true) on the children of RETICLE?, and thus in my case in particular i do not need any pre-hook stuff? Also does the redefined function's placement being inside the hook function matter? if so, why? would it position inside a function mean that i would have to call the function differently, or would it still be just RETICLE:UpdateHiddenState().

But then whats the difference between that method, and simply calling the orininal RETICLE:UpdateHiddenState(), followed by a SetHidden(), wouldnt the reticle just toggle back on again as i described in the OP?

Am I on the right track or is my understanding/interpretation completely off?

Sorry for the bombardment of questions, I have always just called functions on ZO_ objects before and had no idea about these handlers(?). Was using these handlers(?) the intended way for manipulating objects?

Thank you for your help

EDIT: Nevermind on those questions above, I tried it out and it works perfectly and I think I understand it all, so basically its in a way similar to RegisterForEvent, but instead of an event on the event list, its whenever the UpdateHiddenState is called, right? (And you can do code before the function call) Also, in the original UpdateHiddenState(), it calls the SetHidden(value) function right? otherwise the second method (HookReticleSetHidden) wouldnt work. is that correct?

Quote:

Originally Posted by hoydyd (Post 21439)

EDIT: Nevermind on those questions above, I tried it out and it works perfectly and I think I understand it all, so basically its in a way similar to RegisterForEvent, but instead of an event on the event list, its whenever the UpdateHiddenState is called, right? (And you can do code before the function call) Also, in the original UpdateHiddenState(), it calls the SetHidden(value) function right? otherwise the second method (HookReticleSetHidden) wouldnt work. is that correct?

Yes, correct.

Inside UpdateHiddenState the SetHidden of that control is called based on GetUnitDisguiseState("player") and GetUnitStealthState("player")

function RETICLE:UpdateHiddenState() is a Lua shortcut for function RETICLE.UpdateHiddenState(self)

In Lua nearly everything is a variable. Including function names. Replacing/Overwritting a function is just assigning a new nameless function to a named table member/variable.
The overwritting takes place in the moment you do the assignment.
Putting the code into a function has two effects:
1. The scope of the "backup" variable is limited. So you know who can and will call the base function only.
2. The assignment=replacement is delayed to the moment everything is initialized (e.g. your saved variable=addon settings)

Otherwise you may get unexpected nil value errors. Happened to me :)

edit 1:

Quote:

Originally Posted by hoydyd (Post 21439)

Was using these handlers(?) the intended way for manipulating objects?

Well, controls are just controls. Like your addon, there is always some additional code doing something with them.
And for a lot classes/instances ZOS is so kind to give public access via those global variables like RETICLE, PLAYER_INVENTORY and so on.

Quote:

Originally Posted by votan (Post 21440)

Thank you,

Just wondering, but in the function listed here: http://esodata.uesp.net/100010/src/i...e.lua.html#217

there is no mention of getting the disguise or stealth state. And i can't seem to find out what is inside the IsReticleHidden function. I mention this as I have an issue when reenabling the stealth eye, and i think i can fix it, but i cant really explore all thats happening during UpdateHiddenState(). the reticle works fine but the stealth eye either doesnt reappear, or depending on how i do it, looks like a weird half-eye fuzzy texture.

Any other way to see everything thats happening in that function?

Also, does an (m) next to a function in zgoo mean you cant access it or something?, having trouble with only one function and it has an (m) before it

I seems like RETICLE may be different to what i linked

Thank you

Quote:

Originally Posted by hoydyd (Post 21453)

The source of your link seems out-dated. Look at the links shown here kindly given by Ayantir.
I think the "m" stands for "metadata". Meaning it is from a "class" definition.

CU