How-To: Write Augment Tooltips

Every augment can describe itself to the player. You get a generated description for free, you can override the wording anywhere it reads badly, and the numbers stay live either way - an override never goes stale when a value changes, because the numbers come from the data, not from what you typed.

The three layers

Tokens

Write {PropertyName} anywhere in an override and it is replaced with that property's current value. Property names are the ones on the action, listener or mutation you are editing - the same names shown in the details panel, without spaces.

Chains to {MaxTargets} nearby foes within {Radius}cm.
   ->   Chains to 2 nearby foes within 600cm.

Finding nested values

Some values are not directly on the action. Apply Gameplay Effect keeps its magnitudes in a map keyed by SetByCaller tag, so the Amount you want is one level down. Tokens search inside automatically - a direct property always wins, and only if there is no match does it look deeper.

Format specifiers

A colon after the name adds formatting. The right form depends on where the token sits in the sentence, which is why there is no single default - "Radius" at the start of a sentence and "radius" in the middle are both correct, in different places.

Tokens only mutations have

Sets your blade alight for {Value} seconds, burning {Target}.
   ->   Sets your blade alight for 5 seconds, burning Attack Power.

Referencing a gate

An event group's gate - its chance and minimum level - is not a property of any single action, so a step's override gets a second pass against the group it belongs to. {Chance} and {MinimumLevel} resolve there.

Chains to {MaxTargets} nearby foes. {Chance:percent} chance.
   ->   Chains to 2 nearby foes. 35% chance.

The generator adds no wording of its own

It will not insert connectives (, or and ), an On Hit: prefix, a 35% chance to prefix, or trailing periods. All of that is phrasing, and phrasing is yours - "Chains to 2 foes. 35% chance." is unreachable if the generator has already committed to "35% chance to chain to 2 foes". Clauses are joined with a single space and carry their own punctuation, so write the punctuation you want inside each override.

Rich text

These descriptions are FText that your widget renders - the plugin never draws them. So markup you type into an override reaches a UCommonRichTextBlock unchanged, and works today with no setup.

Deals {Amount:style=Damage} damage over {Duration:1}s.
   ->   Deals <Damage>600</> damage over 3.0s.

You can also write the tags by hand - "Chains to <Damage>{MaxTargets}</> foes." - if you want the markup around more than one token.

The image table's row type is read reflectively, so both shapes work - a Brush, or a ResourceObject plus ImageSize. An <img> whose id is not in the table renders as the literal tag in warning color, the same way an unrecognized {Token} stays visible.

Setting up colored text

1. Create the table. Content Browser > Miscellaneous > Data Table, and pick RichTextStyleRow as the row structure.
2. Add a row per style. The row name is the tag - a row called Damage is written <Damage>. Set its Font, Color, and any decoration on the row.
3. Point your widget at it. On the Rich Text Block in your tooltip widget, set Text Style Set to that table.
4. Use it. Write <Damage>600</> in a Description Override, or let a token do it: {Amount:style=Damage}.

DT_TooltipTextStyles   (row structure: RichTextStyleRow)
  Default   <- SRichTextBlock falls back to this; worth adding
  Damage    Font: Bold 12,  Color: (1.0, 0.35, 0.25)
  Buff      Font: Bold 12,  Color: (0.45, 0.9, 0.5)

Description Override:
  "Deals {Amount:style=Damage} damage."
     ->  Deals <Damage>600</> damage.

Setting up inline images

1. Create the table. Data Table with RichImageRow as the row structure (or CommonUI's RichTextIconData if you are using UCommonRichTextBlock).
2. Add a row per icon. The row name is the id. Set its Brush - texture plus image size.
3. Attach the decorator. On an engine Rich Text Block, add RichTextBlockImageDecorator to Decorator Classes and set its Image Set to your table. With CommonUI instead, subclass UCommonUIRichTextData, put your table in its Inline Icon Set, and select that subclass in Project Settings > CommonUI.
4. Use it - and mind the syntax, which differs between the two.

DT_TooltipIcons   (row structure: RichImageRow)
  Skull     Brush: T_Icon_Skull,  Size: 16 x 16

Description Override, engine rich text block:
  "Executes below <img id=\"Skull\"/> 20% health."

Description Override, CommonUI rich text block:
  "Executes below <Skull/> 20% health."

Bound values print a name, not a number

A value bound to an ability property resolves to whatever is equipped at the time, so outside a live loadout there is no single number to print - it shows the property's name instead. The Augment Editor's Tooltip Preview resolves it for the previewed contract and shows both, as Chain Targets (3).

Reading it from a widget

Drawing it your own way

Build Ability Tooltip returns the whole structure, which suits a UI that draws the whole structure. For anything else, UCrimsonAbilityTooltipStatics (same Crimson | Ability | UI category) takes it apart rather than making you walk Stats yourself.

Each property also carries a Display block - Suffix, As Percent, Decimals, Higher Is Better, Hide From Tooltip. That is what turns 8.5 into 8.5s, and what lets Get Stat Change Direction say a lower cooldown is an improvement without every widget keeping its own list of inverted stats.

Checking your work

The Augment Editor's Summary tab renders a Tooltip Preview using real numbers for the previewed contract at the toolbar's Preview Level - not placeholders. Change Preview Level and the numbers move with it. It assumes this augment alone is equipped, so a real loadout with several augments touching the same property will read differently - Build Ability Tooltip With Augment is the one that answers the loadout question.

See also

• Concept: Augment System - what mutations, actions and listeners are
• How-To: Add Your Own Augment Event - broadcasting events your game defines
• API Reference - BuildAbilityTooltip, UCrimsonAbilityTooltipStatics and the tooltip structs