Skip to main content

Tooltips & descriptions

CommandRunner shows hover tooltips in two places: on sidebar commands and on argument cards. Both come from Description fields you write.

Hovering the Path argument card surfaces its tooltip "Dotted path to a service or instance" below the card

Command description​

The top-level Description field on the module return table:

return {
    Description = "Recolor every selected BasePart with the chosen BrickColor.",

    Arguments = { ... },
    Run = function(props) ... end,
}

When the user hovers over the command in the sidebar for ~400ms, a tooltip appears showing this text. If the field is missing or empty, no tooltip shows.

The tooltip text is re-parsed from the script every time the user hovers (cheap, uses CommandRunner's RequireNoCache), so editing the description and saving the script reflects on the next hover.

Argument description​

Each entry in Arguments can have its own Description:

Arguments = {
    Spacing = {
        Type = "number",
        Default = 4,
        Description = "Studs between each duplicated copy. 0 = stacked.",
    },
}

Argument tooltips work the same way. Hover the card for ~400ms and the tooltip appears.

Storage detail: the description is mirrored onto the card as the ArgDescription attribute by setArguments. Tooltips read from the attribute, not the schema, so setArguments is the single sync point.

Tooltip behavior​

  • Delay: ~400ms hover before the tooltip appears. Quick mouse passes don't trigger it.
  • Position: shown next to the hovered element. Auto-flips left if it would overflow the right edge of the widget.
  • Wrapping: text wraps at ~280px max width.
  • Hidden by other UI: opening the right-click context menu or any modal popup hides any visible tooltip immediately.

Turning tooltips off​

If you've memorized your commands and find the hover delay distracting, you can disable hover tooltips entirely from the Settings popup (gear icon in the TopBar). Toggle Hover tooltips off and no tooltip ever shows, on commands or arg cards. The Description fields you've written are still preserved, just not surfaced via hover. Toggle it back on at any time, no widget reload needed.

See settings for the full list of toggles.

Markdown? Rich text?​

Tooltips are plain text. They render in a TextLabel with TextWrapped = true. Markdown / rich text is not supported. Keep descriptions to one or two short sentences.

If you need a longer explanation that benefits from formatting, the right surface is the docs site itself. Link to a relevant page from the description if it helps:

Description = "Cross-place library save. See the docs at /features/library",

…but most users won't follow URLs from a hover tooltip. Aim for self-contained one-liners.