Streamerbot / docs

Official documentation for Streamer.bot
https://docs.streamer.bot
7 stars 45 forks source link

Documentation needed - Trigger - Crowd Control Timed Effect Update #78

Closed rondhi closed 5 months ago

rondhi commented 6 months ago

Describe the missing documentation Crowd Control Timed Effect Update Trigger

Where do you think this documentation should be included? An existing page or new page? Trigger page for Crowd Control Timed Effect Update doesn't exist

Additional context Variable Value
%__source% CrowdControlTimedEffectEnded
%requestID% e87d1b96-5275-4240-a7f4-7fba7d1e37d8
%effect.effectID% disablehammer
%effect.type% game
%effect.name% Disable Battle Hammer
%effect.duration% 30
%effect.note% <null>
%effect.category[0]% Party Battle Effects
%effect.description% ``
%effect.price% 1
%effect.image% https://resources.crowdcontrol.live/images/PaperMarioTTYD/PaperMarioTTYD/icons/disablehammer.png
%price% 1
%unitPrice% 1
%game.gameID% PaperMarioTTYD
%game.name% Paper Mario: The Thousand-Year Door
%gamePack.gamePackID% PaperMarioTTYD
%gamePack.name% Paper Mario: The Thousand-Year Door
%gamePack.platform% GCN
%target.ccUID% ccuid-01hb25ab3n9v6861v0855s1wdf
%target.name% Rondhi
%target.profile% twitch
%target.originID% 3405825
%target.image% https://static-cdn.jtvnw.net/jtv_user_pictures/9bb598a0-9fab-4a0c-8ad9-48b41d5ab2fe-profile_image-300x300.png
%requester.ccUID% ccuid-01hkkmd53tdf7q4bf43k58effq
%requester.name% KermitThePOGGIES
%requester.profile% twitch
%requester.originID% 738066902
%requester.image% https://static-cdn.jtvnw.net/jtv_user_pictures/4ad22e7e-ac1d-404d-b820-cab16d16f98f-profile_image-300x300.png
%isTest% False
%timestamp% 1704831408345
%status% end
%timeRemaining% 0
%triggerId% e0baf3ab-981e-420c-adcc-ade7db89808a
%triggerName% Timed Effect Update
%triggerCategory% CrowdControl
%actionId% 3ba09bd3-b7ca-40e7-aed0-f15c0037ade4
%actionName% Crowd Control Timed Effect Update
%user% KermitThePOGGIES
%userName% kermitthepoggies
%userId% 738066902
%userType% twitch
%isSubscribed% False
%isModerator% False
%isVip% True
%userPreviousActive% 2024-01-09 12:14:42
%eventSource% crowdcontrol
%runningActionId% e55a9405-82be-44c4-bedc-894c26e5cd19
%actionQueuedAt% 2024-01-09 12:17:21

I don't fully understand how this one is triggered, as it has almost identical variables to the Timed Effect Started/Ended triggers, other than it has variables for who redeemed the effect.