@lumiastream/lumia-types 3.9.4 → 3.9.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/activity.types.d.ts +3 -0
- package/dist/activity.types.js +3 -0
- package/dist/api.schema.d.ts +20 -0
- package/dist/api.schema.js +1693 -0
- package/dist/custom-code/custom-actions.md +8 -2
- package/dist/esm/activity.types.js +3 -0
- package/dist/esm/api.schema.js +1690 -0
- package/package.json +1 -1
|
@@ -75,7 +75,7 @@ async function() {
|
|
|
75
75
|
|
|
76
76
|
These are the built-in `type` values for each system base.
|
|
77
77
|
|
|
78
|
-
**`base: "lumia"`** — `callCommand, callRandomCommand, chatbot, tts, setStreamMode, toggleStreamMode, setFuzeAudioSensitivity, playAudio, writeToFile, setConnection, updateVariable, updateCounter, appendToVariable, unappendFromVariable, saveLocal, addToUserlevel, removeFromUserlevel, addToRestrictionsList, removeFromRestrictionsList, setFolder, setAlert, setAlertVariation, setCommand, setChatbotCommand, setTwitchPointsCommand, setTwitchExtensionCommand, setKickPointsCommand, setChatMatchCommand, setTwitchPointValue, setLoyaltyPointValue, setUserLoyaltyPoint, setTwitchExtensionBitsValue, setAutomation, setVoicecommands, sendToDiscordWebhook, sendToDiscordWithMediaWebhook, sendToWebhook, sendToPrinter, raffleEntry, raffleRemoveEntry, raffleGetWinner, raffleStart, raffleStop, raffleEnd, viewerQueueEntry, viewerQueueLeave, tournamentEntry, tournamentRemoveEntry, tournamentUpdatePoints, tournamentStart, tournamentEnd, viewerQueuePlayPause, viewerQueueEndQueue, viewerQueuePickPlayer, backToDefault, replayLastEventListEvent, runLastQueueItem, resumeQueue, pauseQueue, removeCurrentQueueItem, clearQueue, clearCooldowns, resetSession, cleanAll, refreshSettings, addSongRequest, skipSongRequest, clearSongRequestQueue, delay`
|
|
78
|
+
**`base: "lumia"`** — `callCommand, callRandomCommand, chatbot, tts, setStreamMode, toggleStreamMode, setFuzeAudioSensitivity, playAudio, writeToFile, setConnection, updateVariable, updateCounter, appendToVariable, unappendFromVariable, saveLocal, addToUserlevel, removeFromUserlevel, addToRestrictionsList, removeFromRestrictionsList, setFolder, setAlert, setAlertVariation, setCommand, setChatbotCommand, setTwitchPointsCommand, setTwitchExtensionCommand, setKickPointsCommand, setChatMatchCommand, setTwitchPointValue, setLoyaltyPointValue, setUserLoyaltyPoint, setTwitchExtensionBitsValue, setAutomation, setVoicecommands, sendToDiscordWebhook, sendToDiscordWithMediaWebhook, sendToWebhook, sendToPrinter, raffleEntry, raffleRemoveEntry, raffleGetWinner, raffleStart, raffleStop, raffleEnd, viewerQueueEntry, viewerQueueLeave, tournamentEntry, tournamentRemoveEntry, tournamentUpdatePoints, tournamentStart, tournamentEnd, viewerQueuePlayPause, viewerQueueEndQueue, viewerQueuePickPlayer, backToDefault, replayLastEventListEvent, runLastQueueItem, resumeQueue, pauseQueue, removeCurrentQueueItem, clearQueue, clearCooldowns, resetSession, cleanAll, refreshSettings, addSongRequest, skipSongRequest, clearSongRequestQueue, delay, setColor, accessory`
|
|
79
79
|
|
|
80
80
|
**`base: "overlay"`** — `alertTrigger, alertEvent, setOverlayVisibility, setLayerVisibility, setLayerPosition, setLayerSize, setTextContent, setImageContent, setVideoContent, setAudioContent, setLayerVolume, playPauseMedia, setContent, sendShoutout, sendCustomOverlayContent, sendGameTrigger, sendGameUpdate, takeScreenshot, spinwheelReset, spinwheelAddItem, spinwheelRemoveItem, sendHfx, hudOverlayChange, hudToggle, hudVolumeSet, hudOpacitySet, timerIncrement, pollTrigger, pollStart, pollResetVotes, pollSetTimer, pollAddItem, pollRemoveItem, delay`
|
|
81
81
|
|
|
@@ -113,6 +113,12 @@ async function() {
|
|
|
113
113
|
|
|
114
114
|
// Counter (operator is one of + - * /)
|
|
115
115
|
await actions([{ base: "lumia", type: "updateCounter", value: { value: "deaths", message: "1", operator: "+" } }]);
|
|
116
|
+
|
|
117
|
+
// Lights — set every light to red (lights: {} = all lights; power: false turns them off)
|
|
118
|
+
await actions([{ base: "lumia", type: "setColor", value: { rgb: { r: 255, g: 0, b: 0 }, lights: {}, power: true } }]);
|
|
119
|
+
|
|
120
|
+
// Smart plug / key light — id/brand/brandOrigin come from your connected devices (brandOrigin 7 = key light)
|
|
121
|
+
await actions([{ base: "lumia", type: "accessory", value: { accessories: [{ id: "<device id>", brand: "<brand key>", brandOrigin: 7, state: { on: true, brightness: 100, temperature: 6000 } }] } }]);
|
|
116
122
|
done();
|
|
117
123
|
}
|
|
118
124
|
```
|
|
@@ -402,7 +408,7 @@ Every connected integration is also a valid `base` (`spotify`, `discord`, `vtube
|
|
|
402
408
|
|
|
403
409
|
Every integration also supports a delay step: `{ base: "<integration>", type: "delay", delay: <ms> }`. String fields generally resolve `{{template}}` tokens (Art-Net is the exception).
|
|
404
410
|
|
|
405
|
-
> **Lights** (Hue, LIFX, Govee, Nanoleaf, WLED, Elgato key lights
|
|
411
|
+
> **Lights, smart plugs & key lights** are native `lumia` actions (not a separate `base`): use `{ base: "lumia", type: "setColor", value: { rgb, lights, power } }` to set light colors (Hue, LIFX, Govee, Nanoleaf, WLED, …) and `{ base: "lumia", type: "accessory", value: { accessories: [...] } }` for smart plugs & Elgato key lights — see the examples in the **Common `lumia` action examples** section above. The `sendColor` helper (see `helper-functions.md`) is still available for fine-grained per-light control from code.
|
|
406
412
|
|
|
407
413
|
#### Spotify (`base: "spotify"`)
|
|
408
414
|
|
|
@@ -55,6 +55,9 @@ export var LumiaActivityCommandTypes;
|
|
|
55
55
|
LumiaActivityCommandTypes["REMOVE_CURRENT_QUEUE_ITEM"] = "remove-current-queue-item";
|
|
56
56
|
LumiaActivityCommandTypes["SET_COMMNAD_STATE"] = "set-command-state";
|
|
57
57
|
LumiaActivityCommandTypes["SET_FOLDER_STATE"] = "set-folder-state";
|
|
58
|
+
LumiaActivityCommandTypes["CREATE_CHATBOT_COMMAND"] = "create-chatbot-command";
|
|
59
|
+
LumiaActivityCommandTypes["UPDATE_CHATBOT_COMMAND"] = "update-chatbot-command";
|
|
60
|
+
LumiaActivityCommandTypes["DELETE_CHATBOT_COMMAND"] = "delete-chatbot-command";
|
|
58
61
|
LumiaActivityCommandTypes["CLEAR_QUEUE"] = "clear-queue";
|
|
59
62
|
LumiaActivityCommandTypes["CLEAR_COOLDOWNS"] = "clear-cooldowns";
|
|
60
63
|
LumiaActivityCommandTypes["CHATBOT_MESSAGE"] = "chatbot-message";
|