Equipment Tooltip - Issue

Krixus

In ORK 2 with IMGUI system, you could create a "Latest Turn" HUD type and then when you add a "Status Element" to it, you could create an "Equipment" type status element and it would give you an option to enable a tooltip.

In that setup, it just resulted in a very small box that just displayed the name of the weapon equipped in a specific equipment part. So basically, if you hovered over [[[Weapon: Sword]]] it would detect a tooltip and that tooltip could display the weapon icon/name/description etc.

I've tried to mirror that setup in ORK 3 with the Unity UI system. By using a "HUD Equipment Slot (Content Provider" component alongside a "ORK HUD Status Text Content" component, I'm able to display the shortname of a weapon on a specific equipment slot.

I've then added a "HUD Tooltip" component to the root of the HUDs prefab.

Issue 1:

I am unable to trigger the tooltip. I don't believe it is an issue with the tooltip prefab itself as I can trigger custom tooltips just fine. If I attached a "UI Custom Tooltip" component to the root of the gameobject the tooltip will trigger just fine but I cannot get the actual information from the defined weapon in the editor to appear in tooltips.

I've also made sure that the HUD tooltip defined in the editor can properly display information from equipment. I'm at a loss as to how to set this up to mimic ORK 2.

Krixus

Issue 2:

Similar to the first issue but this time I am using a "ORK HUD Status Text Content" component with the status type set to "Actions Per Turn".

Is there anyway that we can define information for "Actions Per Turn"? Aside from triggering the actual tooltip, I guess the real issue is being able to define information for this. In my combat system (phase based), the amount of actions per turn is determined by a status value/formula.

So I guess just using this status type to display APT is not enough to actually show information, as I am not even displaying the related status value?

So, do you think a custom UI tooltip is the only way here? It isn't like the first issue above where the weapon can change all the time so obviously can't define a predefined custom tooltip for that. Could probably get away with it for this one since I just need to display some basic information that won't change, unless there is already a better way?

I added a "HUD Tooltip" component but I guess that's useless since there isn't actually any HUD tooltip type for Actions Per Turn?

gamingislove

1) HUD Tooltip components provide a tooltip for the content they receive from their Content Provider, so where this is added is crucial. E.g. at the root of the HUD using the HUD component, it'll most likely be the combatant for which the HUD is displayed.
If it's placed somewhere, e.g. the equipment slot game object and using the equipment slot content provider, it'll use the equipment slot as tooltip.

If you want to display the tooltip for the equipment of the slot, you could e.g. use a HUD Equipment List component instead, which spawns equipment shortcut UI prefabs (on which you need to place the HUD Tooltip component). Or use a HUD Equipment Slot Content component to spawn the equipment's shortcut UI prefab.

2) Actions per turn isn't a status value, it's just a number on the combatant (e.g. like move range in grid battles). There is no tooltip for this, so you'll have to use custom tooltips.

Krixus

I still can't get this to work. I removed the "HUD Equipment Slot Content Provider" as well as the "ORK HUD Status Text Content" components. The two were originally just used to show the <shortname> of the weapon, so it would look something like "Weapon: Sword".

I wanted to make it so that hovering over the HUD would trigger a tooltip of the equipped weapon itself, similar to the behavior of which it does in ORK 2.

I removed the first two components above just to see if I could trigger the shortcut alone so I could see the tooltip, but no luck.

This is what my "new" setup looks like:

You mentioned that I should use a "HUD Equipment List" component instead, so I assumed you mean I should replace out the other components, so I removed the "HUD Equipment Slot Content Provider" component since if I added a "HUD Tooltip" component then I'd be pulling information from the equipment slot itself rather than the equipment ON the slot.

I've set up a prefab in "Shortcut Settings" specifically for equipment too and tried seeing if enabling "Equipment" for the "Default Auto Add Slots" would do anything but I cannot get the shortcut slot to spawn.

Well, I guess the real issue is it seems to appear, but it is greyed out so I'm assuming it hasn't spawn so I can't interact with it to see the tooltip.

So, what components am I missing? Do I need to define a UI key or do I still need to define other things on the "HUD Equipment List" component itself or perhaps the reference to the "Content Provider" is not correct? Please let me know what I am missing to get this to work please.

All I want to do is to have a simple HUD that displays a box with the text that says something like "Weapon: Sword" and hovering over the box triggers a tooltip that directly references the actual weapon equipped in that slot.

I have the text part figured out, the problem is the tooltip being referenced back to the weapon. I figured once I can get the shortcut slot spawn, I can position it over the text from the HUD so that hovering over the box will show a tooltip from the equipped weapon, but that is the problem I am having, not being able to actually spawn the shortcut slot UI prefab.

As for the alternative option you mentioned the "HUD Equipment Slot Content" component, I have no idea what I would need to assign within the component to get that to work.

I'd appreciate more specific steps for this, please.

gamingislove

You've defined the Shortcut Slot prefab in the HUD Equipment List component as prefab, so it'll try to use that instead, and since it gets an equipment and not an equipment slot as component it's disabled. Remove that prefab from the component and it should spawn the equipment UI prefab.

Krixus

gamingislove

Thanks, although I am still confused as to how to set this up completely. I will break this issue into multiple points.

1a. I have removed the prefab that I previously defined in the "HUD Equipment List" component. So now it seems the prefab that spawns is "Shortcut Default", eg the prefab that I have defined in Shortcut Settings/Default UI Settings/Default Shortcut UI.

When I hover over it though, I still don't get a tooltip. I'm now not sure where exactly I should put the "HUD Tooltip" component.

Based on what you've tried to explain to me, where the "HUD Tooltip" component goes is crucial. I don't want it to be referencing and pulling information from the combatant, I specially need it to display information from the equipped equipment in the slot.

So...I assume in that case, that I should be adding the component in the "Shortcut Default" prefab then? If that is the correct prefab to add the component, the question is then where within the hierarchy should I be adding it?

Putting it at the root just references the equipment slot. I tried putting it on "Content", but I don't get any tooltip at all from that. So now I'm confused as to what exactly would be the "Content Provider" for the weapon that is spawned on the specified slot. Should it not be somewhere within the shortcut prefab?

1b. When the shortcut slot of the weapon spawns, it spawns under the HUD and not within it. I have no idea how to format this either because it doesn't exist within the HUD prefab (when setting it up) and it is spawned during runtime.

gamingislove

Krixus When I hover over it though, I still don't get a tooltip. I'm now not sure where exactly I should put the "HUD Tooltip" component.

1a) On your shortcut UI prefab, usually the root of the prefab.
The shortcut UI prefab is spawned for shortcuts, e.g. the equipment, and it'll have the content for that shortcut and not the shortcut slot.

1b) This is up to your UI setup on the HUD prefab - e.g. using layout components or not.
You can e.g. just drag the shortcut UI prefab and other things that will be spawned on it to see how it'll be placed and adjust the setup of the HUD to make it work the way you want.
This is all just Unity UI handling the layout, so best check some tutorials or information on how to best do this - it can be a bit confusing to get it working the way you want :)

Krixus

gamingislove

Thanks for responding.

1a. Sorry, I'm still a bit confused since there are so many prefabs that are used in relation to the setup of the shortcut HUD.

So I have, "Shortcut Default", "Shortcut Empty", "Shortcut Slot" and "Shortcut HUD" and then the prefab for the UI that is meant to display the equipped weapon which has the "HUD Equipment List" component, "Simple Player HUD 5 (Current Weapon)".

I will just show images of the names of each UI prefab and hopefully you'll be able to tell me the exact name of which specific prefab I need to use.

Krixus

"Shortcut Default" is the prefab that is actually spawned as the shortcut which has the equipped weapon. It at least displays the icon of the weapon. However, hovering over it currently only shows information about the equipment slot rather than the equipped equipment. This is also with the "HUD Tooltip" on the root. If I place it on "Equipment Slot Content", I won't get any tooltip.

I'm really scratching my head, I can't for the life of me get this tooltip to display the equipped weapon lol.

I am assuming this is the name of the prefab you meant when you said, "On your shortcut UI prefab, usually the root of the prefab." Unless you are referring to another shortcut prefab that I have named above?

gamingislove

Ah, yeah - sorry the HUD Equipment List currently also lists equipment slots and not equipment directly. I'll look into changes for this.
However, as I said in my first reply to #1, if you use a HUD Equipment Slot Content component alongside the HUD Equipment Slot (Content Provider) component, it'll spawn the shortcut UI prefab for the equipment with the equipment as it's content (where you can use the HUD Tooltip component). Additionally, it has tooltip options to display a tooltip for the slot if empty and equipment if equipped.

Krixus

gamingislove

Thanks, I'll try that method while waiting for the changes that you make to the HUD Equipment List, thanks for that.

Some questions:

If I use HUD Equipment List and HUD Equipment Slot (Content Provider), do I have to create individual HUDs per item slot? It seems like that is the case.
If you can only define 1 item per slot, when I go to create my inventory menuscreen and I want to display the typical RPG/Diablo-esque paper doll UI that has the character and then around it various equipment box slots, do I have to set up an individual HUD for each equipment slot and then manually position them? I haven't gotten to the menuscreen yet so I don't know if there are additional options there.
Regarding the ordering of these components. I got it working with the combo setup of the two components above but I wonder why if "HUD Tooltip" is placed lower in the order/after "HUD Equipment Slot Content" that it displays the tooltip for the equipment slot rather than the equipped item yet if "HUD Equipment Slot Content" doesn't exist either, then it also displays just the equipment slot rather than the actual equipment.

I'm perplexed because I get that the order of scripts matters in the inspector window for the prefab, but wouldn't it make more sense for "HUD Tooltip" to be placed after in order to pull information for the equipped weapon?

Basically, I understand in this case, you need a content provider to show a tooltip.

So you create a "HUD Equipment Slot (Content Provider)" component first and then add the "HUD Tooltip". Just those two now displays tooltip information from the equipment slot.

Adding a "HUD Equipment Slot Content" component after then pulls information from the equipped weapon.

If you reorder it and put the "HUD Equipment Slot Content" above "HUD Equipment Slot (Content Provider)" then you don't get any tooltip at all.

Putting "HUD Tooltip" above everything works again in that it pulls information from the equipped weapon, but once you put it at the bottom under both equipment components it pulls information only from the equipment slot.

It seems extremely finnicky, I'm trying to understand the logic of it this Unity UI setup but this one really confuses me. I thought the logical thing was, first it needs content provider for equipment slot, then you display the content for that slot, then lastly you add the tooltip. But everything gets thrown out the window when putting the tooltip HUD above "HUD Equipment Slot Content" component pulls equipped equipment info but putting it below pulls equipment slot info instead.

Lmao, it's doing my head in.

gamingislove

1) Those are separate things for separate use cases.

The HUD Equipment List will spawn a shortcut UI prefab of the equipment in equipment slots (empty slots can spawn the prefab set up in the component), so it's used to spawn other content prefabs.

The HUD Equipment Slot (Content Provider) is only used to get an equipment slot from a combatant (that's the content of the content provider the equipment slot component uses) and can further provide that as content to other HUD components. I.e. any HUD content component using the HUD Equipment Slot (Content Provider) component as their content provider will have the equipment slot as content.

There are many different content providers, and some don't even need another to get them content, e.g. the HUD Player Combatant (Content Provider) component can be used on it's own even outside of a HUD, e.g. as part of a UI box prefab.

2) If this is for an equipment menu screen, this is set up in your UI box prefab via Placed Inputs.
Basically add and position inputs on your UI box prefab and add them as placed inputs to the UI Box component's input settings. They're used in the order that they are added to the settings. Maybe combine this with horizontal/vertical input change of 0 as well to use direction-based input selection.

3) As said in #2 - if this is a menu screen, you don't need a HUD setup (unless you want to use HUD elements in your input button prefabs for better control or more information).

The order of the components shouldn't really make any difference - though who knows what Unity does in the background regarding initialisation order.