Treasure Chest
- Alert key:
tiktok-treasureChest - Source: TikTok
- Event list label: Treasure Chest
Default message template
{{username}} sent a treasure chest
Template variables
Use any of these in alert text, TTS, or chat templates. The same names appear under data.extraSettings.* when you subscribe via Overlay.on('alert').
| Template variable | Overlay payload field | Description |
|---|---|---|
{{username}} | data.extraSettings.username | The username of the sender |
{{userId}} | data.extraSettings.userId | The user ID of the sender |
{{avatar}} | data.extraSettings.avatar | The url of the avatar of the sender for a message |
{{envelopeId}} | data.extraSettings.envelopeId | No description available yet. |
{{diamondCount}} | data.extraSettings.diamondCount | No description available yet. |
{{peopleCount}} | data.extraSettings.peopleCount | No description available yet. |
{{unpackAt}} | data.extraSettings.unpackAt | No description available yet. |
{{amount}} | data.extraSettings.amount | The amount sent |
Example payloads
Each scenario below mirrors what Lumia emits in Overlay.on('alert', (data) => …).
Treasure Chest
{
"alert": "tiktok-treasureChest",
"dynamic": {
"value": 50,
"name": "lumiastream",
"amount": 50
},
"extraSettings": {
"username": "lumiastream",
"diamondCount": 50,
"peopleCount": 5,
"amount": 50,
"userId": "",
"avatar": "",
"envelopeId": "",
"unpackAt": ""
}
}
Variation conditions
Dimensions you can branch on when configuring alert variations:
RANDOMEQUAL_USERNAMEEQUAL_NUMBER- Diamond Count is equal toGREATER_NUMBER- Diamond Count is greater than or equal toEQUAL_VARIABLE
Related
- Alert Explorer - live preview of every alert
- Overlay Type Definitions - full
AlertEventTypeScript type