Effect Success

Preview

Parameters

Gamerequired

Select

default:Any

Game to which the trigger should react on

Packrequired

Select

default:Any

Pack of the game the trigger should react on

Effectrequired

Select

default:Any

Effect, is based on the Game and Pack

Typerequired

Select

default:Any

Any
Immediate
Timed

Price

Range

Filter events between a specified Min and Max

Min and Max are inclusive of the entered values

Any Value - Leave both min and max empty to accept any value
Exact Value - Enter only a Max to trigger on a specific value
Greater Than - Enter only a Min to trigger on any value greater than the specified value
Range - Enter a min and a max to trigger within a desired range

Variables

The following variables will be populated when this trigger executes:

		Description
`effect.category`	`string`	The category of the effect
`effect.description`	`string`	The description of the effect Example: `Steal a shine sprite from the player!`
`effect.duration`	`number`	The duration of the effect
`effect.effectID`	`string`	The id of the effect Example: `removesprite`
`effect.image`	`string`	The image of the effect Example: `https://resources.crowdcontrol.live/images/PaperMarioTTYD/PaperMarioTTYD/icons/removesprite.png`
`effect.name`	`string`	The name of the effect Example: `Take Shine Sprite`
`effect.note`	`string`	The effect note
`effect.price`	`number`	The price of the effect Example: `1`
`effect.type`	`string`	The type of the effect Example: `game`
`game.gameID`	`number`	The game id Example: `PaperMarioTTYD`
`game.name`	`string`	The name of the game Example: `Paper Mario: The Thousand-Year Door`
`gamePack.gamePackID`	`string`	The game pack id Example: `PaperMarioTTYD`
`gamePack.name`	`string`	The name of the game pack Example: `Paper Mario: The Thousand-Year Door`
`gamePack.platform`	`string`	The game pack platform Example: `GCN`
`price`	`number`	The price Example: `1`
`requestID`	`string`	The request id Example: `a2d00d8c-89ef-4f59-aac5-0030a01a53f6`
`requester.ccUID`	`string`	The requester ccuid unique id Example: `ccuid-01hkkmd53tdf7q4bf43k58effq`
`requester.image`	`string`	The requester image Example: `https://static-cdn.jtvnw.net/jtv_user_pictures/4ad22e7e-ac1d-404d-b820-cab16d16f98f-profile_image-300x300.png`
`requester.name`	`string`	The requester name Example: `KermitThePOGGIES`
`requester.originID`	`number`	the requester origin id Example: `738066902`
`requester.profile`	`string`	The requester profile Example: `twitch`
`target.ccUID`	`string`	the target ccuuid unique identifier Example: `ccuid-01hb25ab3n9v6861v0855s1wdf`
`target.image`	`string`	The target image Example: `https://static-cdn.jtvnw.net/jtv_user_pictures/9bb598a0-9fab-4a0c-8ad9-48b41d5ab2fe-profile_image-300x300.png`
`target.name`	`string`	The target name Example: `Rondhi`
`target.originID`	`number`	The target origin id Example: `3405825`
`target.profile`	`string`	The target profile Example: `twitch`
`timestamp`	`number`	The timestamp of the event Example: `1704830667420`
`unitPrice`	`number`	The unit price Example: `1`

		Description
`__source`	`EventType`	The event which triggered the action. This will not always exist and requires C# to access, read more Example: `TwitchChatMessage`
`actionId`	`Guid`	The unique ID of the action being executed Example: `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`actionName`	`string`	The name of the action being executed Example: `My Action`
`actionQueuedAt`	`DateTime`	The timestamp of when action was queued Example: `12/21/2023 9:25:21 AM`
`eventSource`	`EventSource`	The service of the event which triggered the action. This will not always exist and requires C# to access, read more Example: `twitch`
`runningActionId`	`Guid`	The unique ID of this running action instance within the queue Example: `c83dd939-9f86-4435-b07c-b6e7e3eef134`
`triggerCategory`	`string`	The category of the trigger which executed the action Example: `Twitch/Chat`
`triggerId`	`Guid`	The unique id of the trigger with executed the action Example: `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`triggerName`	`string`	The name of the trigger which executed the action Example: `Chat Message`

Effect Request

Trigger for a Crowd Control Effect Request

Game Session End

Trigger for when a Crowd Control Game Session Ends