Settings

Component configuration options

Settings

The HUD Navigation System component has a ton of settings, which offers a variety of possibilities for your project.

We provide a tooltip for almost every setting, just hover them with your mouse pointer in the unity editor.

General Settings

  • Player Transform: Assign your Player Controller (the Transform, which represents your player). You can also add the HNSPlayerController component to your player, to dynamically assign this setting.

  • Player Camera: Assign your Player Camera (in most cases, this is your main camera). You can also add the HNSPlayerCamera component to your player camera, to dynamically assign this setting.

  • Enabled / Active: If enabled, the system will start automatically. This setting can be changed at runtime to e.g. temporarily disable HNS.

System Settings

  • Rotation Reference: HNS will use the rotation of this transform for it's calculations.

  • Update Mode: Depending on your project, you might have to change this setting, if the icon positioning is not synced with your character movement.

  • Don't Destroy On Load: By default, HNS will automatically persist between scene changes. You can globally disable this behavior with this setting. Note: You then have to manually include HNS again, if you change scenes!

Radar Settings

  • Radar Mode: You can switch the mode to change the behavior of the radar. Select the mode, which fits best to your project.

  • Radar Zoom: Controls the overall zoom of the radar. The higher the value, the higher the virtual drone floats above the player. :)

  • Radar Radius: Radius of the radar in meters/units. Elements outside this radius will be displayed on the border of the radar.

  • Radar Radius (Border): Border radius in meters/units. Elements outside this radius will be hidden on the radar.

  • Enable Height System: Enable the height based system for each element inside the radar. If an element is physically above or below a certain distance, it will show an arrow above/below the element inside the radar.

    • Min. Distance Above: Minimum distance upwards to activate the element's ABOVE arrow.

    • Min. Distance Below: Minimum distance downwards to activate the element's BELOW arrow.

    • Show Debug Gizmos: If enabled, it will draw two planes above and below the player, which indicate the distance of the height system above and below the player.

      • Gizmo Size: Defines the size of the Debug Gizmos.

      • Gizmo Color: Defines the color and opacity of the Debug Gizmos.

Compass Bar Settings

  • Compass Bar Radius: Radius of the compass bar in meters/units. Elements outside this radius will be hidden on the compass bar.

Indicator Settings

  • Indicator Radius: Radius of the indicators in meters/units. Indicators of elements outside this radius will be hidden.

  • Indicator Hide Distance: Controls the distance in meters/units at where indicators are automatically hidden, if your player comes closer to the element. Set the value to 0 to disable auto-hide on your indicators.

  • Enable Offscreen Indicators: If enabled, indicators will stick to the borders of the screen, if they're currently not visible on screen.

    • Screen Border: Controls the distance of your offscreen indicators to the screen borders. A higher value increases the distance to the border.

  • Enable Distance Scaling: If enabled, the indicators will scale by distance within the defined scale radius.

    • Scale Radius: Indicators inside this radius will be scaled by distance. Value must be lower or equal to the actual indicator radius.

    • Minimum Scale: Controls the minimum scale of indicators affected by the distance scaling functionality.

  • Enable Distance Fading: If enabled, the indicators will fade by distance within the defined fade radius.

    • Fade Radius: Indicators inside this radius will be faded by distance. Value must be lower or equal to the actual indicator radius.

    • Minimum Opacity: Controls the minimum opacity of indicators affected by the distance fading functionality. Set the value to 0 to completely fade-out indicators.

Minimap Settings

  • Minimap Profile: Assign the map profile you want to use for the minimap. For more informations on how to generate a map profile, follow the instructions in the map profile documentation.

  • Minimap Mode: You can switch the mode to change the behavior of the minimap. Select the mode, which fits best to your project.

  • Minimap Scale: Controls the overall scale of the minimap. Decrease the value to zoom out the minimap and show more area around the player.

  • Minimap Radius: Radius of the minimap in meters/units. Elements outside this radius will be displayed on the border of the minimap.

  • Show Minimap Bounds: If enabled, it will draw a cube which scales to the size of your minimap bounds. Can be useful to debug your minimap profiles.

    • Gizmo Color: Defines the color and opacity of the minimap bounds cube.

  • Enable Height System: Enable the height based system for each element inside the minimap. If an element is physically above or below a certain distance, it will show an arrow above/below the element inside the minimap.

    • Min. Distance Above: Minimum distance upwards to activate the element's ABOVE arrow.

    • Min. Distance Below: Minimum distance downwards to activate the element's BELOW arrow.

    • Show Debug Gizmos: If enabled, it will draw two planes above and below the player, which indicate the distance of the height system above and below the player.

      • Gizmo Size: Defines the size of the Debug Gizmos.

      • Gizmo Color: Defines the color and opacity of the Debug Gizmos.