Skip to content

SusHudMinimapFrame

SusHudMinimapFrame

Square chrome frame for a minimap widget — placeholder text or slotted / injected content.

Package

SusGame · HUD (commercial)

Open in Playground

SusGame · HUD

Props

NameTypeDefault
PlaceholderTextProp<string>"Minimap"
ShowPlaceholderProp<bool>true
FrameSizeProp<float>160f
ShapeProp<string>"square"
SizeProp<string>"default"

Slots

Name
(default)

Events

No public events.

Style hooks

USS class contract — override appearance without touching C#. States toggle via these classes:

  • sus-hud-minimap-frame
  • sus-hud-minimap-frame__content
  • sus-hud-minimap-frame__placeholder
  • sus-hud-minimap-frame--circle
  • sus-hud-minimap-frame--square
  • sus-minimap--fit

Usage

csharp
var frame = new SusHudMinimapFrame();
frame.FrameSize.Value = 140f;
frame.PlaceholderText.Value = "Minimap";
frame.ShowPlaceholder.Value = true;
// After your map visual exists:
// frame.SetContent(minimapRoot); // clears placeholder
xml
<template>
  <sus:SusHudMinimapFrame :PlaceholderText="Placeholder.Value"
                          :ShowPlaceholder="ShowPh.Value"
                          :FrameSize="Size.Value">
    <!-- Optional default slot: your minimap VisualElement tree -->
  </sus:SusHudMinimapFrame>
</template>

<script>
public Prop<string> Placeholder = new("Minimap");
public Prop<bool> ShowPh = new(true);
public Prop<float> Size = new(140f);
</script>
Prop / APIRole
PlaceholderTextLabel when empty (default Minimap)
ShowPlaceholderShow / hide placeholder
FrameSizeWidth & height (≤40 falls back to 140)
default slotNested content inside the frame
SetContent(ve)Replace host children + hide placeholder

Notes

  • Frame is chrome only — paint / fog / icons live in your content or SusMinimap (when used).
  • SetContent sets ShowPlaceholder = false after injecting.