Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Add z-index management to HUD
  • Loading branch information
pyrollo authored and rubenwardy committed Dec 6, 2019
1 parent f6de86c commit cf7fda0
Show file tree
Hide file tree
Showing 10 changed files with 57 additions and 7 deletions.
8 changes: 8 additions & 0 deletions doc/lua_api.txt
Expand Up @@ -1260,6 +1260,11 @@ precisely positioned items in the HUD.
**Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling
factor!

The `z_index` field specifies the order of HUD elements from back to front.
Lower z-index elements are displayed behind higher z-index elements. Elements
with same z-index are displayed in an arbitrary order. Default 0.
Supports negative values.

Below are the specific uses for fields in each type; fields not listed for that
type are ignored.

Expand Down Expand Up @@ -7322,6 +7327,9 @@ Used by `Player:hud_add`. Returned by `Player:hud_get`.

size = { x=100, y=100 },
-- Size of element in pixels

z_index = 0,
-- Z index : lower z-index HUDs are displayed behind higher z-index HUDs
}

Particle definition
Expand Down
1 change: 1 addition & 0 deletions src/client/clientevent.h
Expand Up @@ -131,6 +131,7 @@ struct ClientEvent
v2f *offset;
v3f *world_pos;
v2s32 *size;
s16 z_index;
} hudadd;
struct
{
Expand Down
5 changes: 5 additions & 0 deletions src/client/game.cpp
Expand Up @@ -2650,6 +2650,7 @@ void Game::handleClientEvent_HudAdd(ClientEvent *event, CameraOrientation *cam)
e->offset = *event->hudadd.offset;
e->world_pos = *event->hudadd.world_pos;
e->size = *event->hudadd.size;
e->z_index = event->hudadd.z_index;
hud_server_to_client[server_id] = player->addHud(e);

delete event->hudadd.pos;
Expand Down Expand Up @@ -2728,6 +2729,10 @@ void Game::handleClientEvent_HudChange(ClientEvent *event, CameraOrientation *ca
case HUD_STAT_SIZE:
e->size = *event->hudchange.v2s32data;
break;

case HUD_STAT_Z_INDEX:
e->z_index = event->hudchange.data;
break;
}

delete event->hudchange.v3fdata;
Expand Down
14 changes: 14 additions & 0 deletions src/client/hud.cpp
Expand Up @@ -283,11 +283,25 @@ void Hud::drawLuaElements(const v3s16 &camera_offset)
{
u32 text_height = g_fontengine->getTextHeight();
irr::gui::IGUIFont* font = g_fontengine->getFont();

// Reorder elements by z_index
std::vector<size_t> ids;

for (size_t i = 0; i != player->maxHudId(); i++) {
HudElement *e = player->getHud(i);
if (!e)
continue;

auto it = ids.begin();
while (it != ids.end() && player->getHud(*it)->z_index <= e->z_index)
++it;

ids.insert(it, i);
}

for (size_t i : ids) {
HudElement *e = player->getHud(i);

v2s32 pos(floor(e->pos.X * (float) m_screensize.X + 0.5),
floor(e->pos.Y * (float) m_screensize.Y + 0.5));
switch (e->type) {
Expand Down
2 changes: 2 additions & 0 deletions src/hud.cpp
Expand Up @@ -43,6 +43,8 @@ const struct EnumString es_HudElementStat[] =
{HUD_STAT_ALIGN, "alignment"},
{HUD_STAT_OFFSET, "offset"},
{HUD_STAT_WORLD_POS, "world_pos"},
{HUD_STAT_SIZE, "size"},
{HUD_STAT_Z_INDEX, "z_index"},
{0, NULL},
};

Expand Down
4 changes: 3 additions & 1 deletion src/hud.h
Expand Up @@ -74,7 +74,8 @@ enum HudElementStat {
HUD_STAT_ALIGN,
HUD_STAT_OFFSET,
HUD_STAT_WORLD_POS,
HUD_STAT_SIZE
HUD_STAT_SIZE,
HUD_STAT_Z_INDEX,
};

struct HudElement {
Expand All @@ -90,6 +91,7 @@ struct HudElement {
v2f offset;
v3f world_pos;
v2s32 size;
s16 z_index = 0;
};

extern const EnumString es_HudElementType[];
Expand Down
7 changes: 7 additions & 0 deletions src/network/clientpackethandler.cpp
Expand Up @@ -1081,6 +1081,7 @@ void Client::handleCommand_HudAdd(NetworkPacket* pkt)
v2f offset;
v3f world_pos;
v2s32 size;
s16 z_index = 0;

*pkt >> server_id >> type >> pos >> name >> scale >> text >> number >> item
>> dir >> align >> offset;
Expand All @@ -1093,6 +1094,11 @@ void Client::handleCommand_HudAdd(NetworkPacket* pkt)
*pkt >> size;
} catch(SerializationError &e) {};

try {
*pkt >> z_index;
}
catch(PacketError &e) {}

ClientEvent *event = new ClientEvent();
event->type = CE_HUDADD;
event->hudadd.server_id = server_id;
Expand All @@ -1108,6 +1114,7 @@ void Client::handleCommand_HudAdd(NetworkPacket* pkt)
event->hudadd.offset = new v2f(offset);
event->hudadd.world_pos = new v3f(world_pos);
event->hudadd.size = new v2s32(size);
event->hudadd.z_index = z_index;
m_client_event_queue.push(event);
}

Expand Down
1 change: 1 addition & 0 deletions src/network/networkprotocol.h
Expand Up @@ -563,6 +563,7 @@ enum ToClientCommand
v2f1000 offset
v3f1000 world_pos
v2s32 size
s16 z_index
*/

TOCLIENT_HUDRM = 0x4a,
Expand Down
19 changes: 14 additions & 5 deletions src/script/common/c_content.cpp
Expand Up @@ -1851,11 +1851,13 @@ void read_hud_element(lua_State *L, HudElement *elem)
elem->size = lua_istable(L, -1) ? read_v2s32(L, -1) : v2s32();
lua_pop(L, 1);

elem->name = getstringfield_default(L, 2, "name", "");
elem->text = getstringfield_default(L, 2, "text", "");
elem->number = getintfield_default(L, 2, "number", 0);
elem->item = getintfield_default(L, 2, "item", 0);
elem->dir = getintfield_default(L, 2, "direction", 0);
elem->name = getstringfield_default(L, 2, "name", "");
elem->text = getstringfield_default(L, 2, "text", "");
elem->number = getintfield_default(L, 2, "number", 0);
elem->item = getintfield_default(L, 2, "item", 0);
elem->dir = getintfield_default(L, 2, "direction", 0);
elem->z_index = MYMAX(S16_MIN, MYMIN(S16_MAX,
getintfield_default(L, 2, "z_index", 0)));

// Deprecated, only for compatibility's sake
if (elem->dir == 0)
Expand Down Expand Up @@ -1921,6 +1923,9 @@ void push_hud_element(lua_State *L, HudElement *elem)

push_v3f(L, elem->world_pos);
lua_setfield(L, -2, "world_pos");

lua_pushnumber(L, elem->z_index);
lua_setfield(L, -2, "z_index");
}

HudElementStat read_hud_change(lua_State *L, HudElement *elem, void **value)
Expand Down Expand Up @@ -1978,6 +1983,10 @@ HudElementStat read_hud_change(lua_State *L, HudElement *elem, void **value)
elem->size = read_v2s32(L, 4);
*value = &elem->size;
break;
case HUD_STAT_Z_INDEX:
elem->z_index = MYMAX(S16_MIN, MYMIN(S16_MAX, luaL_checknumber(L, 4)));
*value = &elem->z_index;
break;
}
return stat;
}
3 changes: 2 additions & 1 deletion src/server.cpp
Expand Up @@ -1654,7 +1654,8 @@ void Server::SendHUDAdd(session_t peer_id, u32 id, HudElement *form)

pkt << id << (u8) form->type << form->pos << form->name << form->scale
<< form->text << form->number << form->item << form->dir
<< form->align << form->offset << form->world_pos << form->size;
<< form->align << form->offset << form->world_pos << form->size
<< form->z_index;

Send(&pkt);
}
Expand Down

0 comments on commit cf7fda0

Please sign in to comment.