Game logic - Custom HUD – Ylands
Lou Montana (talk | contribs) m (Text replacement - " (\=+)([a-zA-Z0-9][^ ]+[a-zA-Z0-9])(\=+) " to " $1 $2 $3 ") |
Lou Montana (talk | contribs) m (Text replacement - " (\=+)([a-zA-Z0-9][^ ]+[a-zA-Z0-9])(\=+) " to " $1 $2 $3 ") |
||
| Line 9: | Line 9: | ||
= Scripting Custom HUD = | = Scripting Custom HUD = | ||
==Principles== | == Principles == | ||
The layout of Custom HUD consists of '''Widgets''' and it is through modification of their properties the scripting works. | The layout of Custom HUD consists of '''Widgets''' and it is through modification of their properties the scripting works. | ||
You can view the list o 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. If you plan on accessing these in more places, it makes sense to store the widget inside a variable so that you could later access it in a more convenient way. In case of multiplayer games, consider storing these variables in an '''[[Ylands_Game_logic_-_Entity_storage|Entity storage]]''' as the variables stored in '''Custom HUD''' itself are shared by all players. | You can view the list o 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. If you plan on accessing these in more places, it makes sense to store the widget inside a variable so that you could later access it in a more convenient way. In case of multiplayer games, consider storing these variables in an '''[[Ylands_Game_logic_-_Entity_storage|Entity storage]]''' as the variables stored in '''Custom HUD''' itself are shared by all players. | ||
Revision as of 15:54, 17 November 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 set to be activated at the start of the game 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 o 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. If you plan on accessing these in more places, it makes sense to store the widget inside a variable so that you could later access it in a more convenient way. In case of multiplayer games, consider storing these variables in an Entity storage as the variables stored in Custom HUD itself are shared by all players.
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 Trigger zone or Event listener when possible.
Example
An example scenario User Interface exists in the game, which can be found in Editor - Create game - Examples menu.