Firebot v5.61 ‐ Variable Changes

Jump to bottom

Zack Williamson edited this page Feb 12, 2024 · 5 revisions

Breaking Changes

The following variables now return ("raw") instances instead of JSON strings unless otherwise noted

If you need the JSON string, you can wrap the variable call with a call to $convertToJSON[]

All $array* variables that previously returned JSON strings
$argArray
$bitsCheeredLeaderboard
$customRoleUsers
$objectWalkPath
$quoteAsObject
$readApi
$regexExec
$regexMatches
$setObjectProperty
$subUsers
$userMetadata
$usernameArray
$userRoles

The following return ("raw") arrays instead of comma seperated lists

If you need the comma seperated list you can wrap the call with $arrayJoin[ var , ","]

$chatMessageAnimatedEmoteUrls
$chatMessageEmoteNames
$chatMessageEmoteUrls

Deprecated

The following variables are deprecated. They will continue function in the foreseeable future but are hidden from the $vars UI list

All $rawArray* variables - use the $array* equivalent
$rawArgArray - use $argArray
$rawBitsCheeredLeaderboard - use $bitsCheeredLeaderboard
$rawCustomRoleUsers - use $customRoleUsers
$rawObjectWalkPath - use $objectWalkPath
$rawQuoteAsObject - use $quoteAsObject
$rawReadApi - use $readApi
$rawRegexMatches - use $regexMatches
$rawSetObjectProperty - use $setObjectProperty
$rawUserMetadata - use $userMetadata
$rawUsernameArray - use $usernameArray
$rawUserRoles - use $userRoles