Skip to content

SusCooldownWipe

SusCooldownWipe

Cooldown overlay atom — radial pie wipe or bottom-up linear fill over an ability icon; 0 = ready, 1 = full remaining.

Package

SusKit · Atoms (commercial)

Open in Playground

SusKit · Atoms

Props

NameTypeDefault
Progress01Prop<float>0f
ShapeProp<string>"Radial"

Slots

No slots.

Events

No public events.

Style hooks

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

  • sus-cooldown-wipe
  • sus-cooldown-wipe__canvas
  • sus-cooldown-wipe__linear
  • sus-cooldown-wipe--active
  • sus-cooldown-wipe--linear
  • sus-cooldown-wipe--radial

Usage

xml
<template>
  <ui:VisualElement class="ability-icon">
    <sus:SusIcon Icon="fire" />
    <sus:SusCooldownWipe :Progress01="Cooldown.Value" Shape="Radial" />
  </ui:VisualElement>
</template>

<script>
// 0.4 = 40% of the cooldown still remaining; counts down to 0 (ready).
public Prop<float> Cooldown = new(0.4f);
</script>
csharp
var wipe = new SusCooldownWipe();
wipe.Shape.Value = "Linear";
wipe.Progress01.Value = 1f; // just triggered — full remaining

Shape

Radial · Linear

Notes

  • Absolutely-position the wipe over the icon it darkens — it fills its parent's rect and ignores pointer events (pickingMode = Ignore), so it never blocks the icon's own click/hover.
  • Radial draws a Painter2D pie wedge clockwise from 12 o'clock; Linear grows a bottom-anchored dark overlay by height percent — same visual contract as the legacy SusAbilitySlot cooldown overlay it replaces.
  • Progress01 <= 0.01 hides the overlay entirely, so a ready ability shows a clean icon with no residual pixel.