Skip to content
Misc ping

$ping[]

The $ping[] function returns the value of the bot.ping variable of the execution context, meant as the bot’s latency in milliseconds (ms). It does not measure anything itself: the engine makes no network request.

Syntax

$ping

Note: This function takes no parameters.

Return Value

The text of the bot.ping context variable, or 0 when that variable is absent. The engine’s standard command execution fills bot.ping with 0 (no caller passes a measured latency), so in practice $ping returns 0 unless the host running the script supplies a real value.

Examples

Simple ping command

🏓 Pong! Latency: $ping ms

Detailed embed

$title[🏓 Pong!]
$description[Latency: **$ping ms**]
$color[#5865F2]
$footer[🤖 $username]

Visual indicator

$if[$ping<100]
🟢 | $ping ms
$elseif[$ping<200]
🟡 | $ping ms
$else
🔴 | $ping ms
$endif

Notes

  • $ping takes no argument; any argument is refused (“Invalid argument count”).
  • Do not rely on $ping to measure latency: check the value on your own bot before using it in a condition.
  • To check the bot’s uptime, use $uptime[].

Try it

Paste an example into the playground to preview its message (functions that act on Discord are not run), or build the same thing with blocks.