Game logic - Custom HUD – Ylands
| Line 2: | Line 2: | ||
'''Custom HUD''' game logic provides a way of displaying additional custom information on the screen of the player, such as healthbars, timers, custom minimaps etc. It is possible to create and activate multiple overlaying Custom HUD layouts. | '''Custom HUD''' game logic provides a way of displaying additional custom information on the screen of the player, such as healthbars, timers, custom minimaps etc. It is possible to create and activate multiple overlaying Custom HUD layouts. | ||
This game logic shares a layout editor with '''Custom Window''' game logic and the details on how to operate can be found on it's own separate page: | This game logic shares a layout editor with '''Custom Window''' game logic and the details on how to operate can be found on it's own separate page: | ||
'''[[Ylands Custom UI - Edit layout|Edit layout]]''' | |||
=Activating the Custom HUD= | =Activating the Custom HUD= | ||
Custom HUD can be activated by default by checking the '''Visible to new players''' box in the properties window and it can be activated or deactivated via the visual scripting using the '''Show Custom Hud''' tile. | Custom HUD can be activated by default by checking the '''Visible to new players''' box in the properties window and it can be activated or deactivated via the visual scripting using the '''Show Custom Hud''' tile. | ||
Revision as of 14:59, 6 May 2021
Overview
Custom HUD game logic provides a way of displaying additional custom information on the screen of the player, such as healthbars, timers, custom minimaps etc. It is possible to create and activate multiple overlaying Custom HUD layouts. This game logic shares a layout editor with Custom Window game logic and the details on how to operate can be found on it's own separate page:
Activating the Custom HUD
Custom HUD can be activated by default by checking the Visible to new players box in the properties window and it can be activated or deactivated via the visual scripting using the Show Custom Hud tile.
Scripting Custom HUD
Principles
The layout of Custom HUD consists of Widgets and it is through modification of their properties the scripting works. You can view the list of related scripting tiles by switching to Advanced directory and then navigating to Game Logic - Custom UI or by searching the keyword Widget in the search bar.
Switch to advanced tile list
Optimization
While it might be tempting to update the widgets using the Time Trigger, it is much more efficient to utilize other Game Logics, such as Zone trigger or Event trigger when possible.
Example
An example scenario User Interface exists in the game, which can be found in Editor - Create game - Examples menu.