Skip to content

Callback Nodes

lunazera edited this page Apr 10, 2024 · 11 revisions

Twitch Callbacks

Twitch callbacks use the EventSub API and require authentication with Twitch. You must click Login Twitch in the UI and authenticate VNyan before these will work.

Channel Points

Triggers on Twitch Channel Point redeem. Make sure to first create a redeem in Twitch's channel points page.

  • Redeem Name - Case-sensitive name of the channel point redeem

Builtin Parameters

  • [message] - Contains redeem message converted to number
  • <username> - Contains user's Twitch display name
  • <message> - Contains text passed along with redeem
  • <message2> - Contains channel point redeem's name

Bits

Triggers on bits received. Built-in parameter [message] contains amount of bits.

  • Min Bits - Minimum amount of bits to trigger
  • Max Bits - Maximum amount of bits to trigger

Builtin Parameters

  • [message] - Contains amount of bits
  • <username> - Contains user's Twitch display name
  • <message> - Contains chat message

Subscriptions

Triggers once per subscription.

Builtin Parameters

  • <username> - Contains user's Twitch display name

Follows

Triggers on new follow.

Builtin Parameters

  • <username> - Contains user's Twitch display name

Raids

Triggers on incoming raids.

  • Min Raiders - Minimum amount of raiders to trigger
  • Max Raiders - Maximum amount of raiders to trigger

Builtin Parameters

  • <username> - Contains user's Twitch display name

Hype Train

Triggers on Hype Train status change.

  • Train Status - Status of hype train to trigger.

Commands

Triggers on chat commands starting with !-character.

  • Command - Command to trigger
  • Userlevel - Userlevel required to trigger
  • Allowed username - Only allow specific username to trigger
  • Excluded username - Exclude specific username from triggering

Builtin Parameters

  • <username> - Contains user's Twitch display name

Chat message

Triggers on every chat message

  • Userlevel - Userlevel required to trigger
  • Allowed username - Only allow specific username to trigger
  • Excluded username - Exclude specific username from triggering

Builtin Parameters

  • <username> - Contains user's Twitch display name
  • <message> - Contains the chat message

Ad Break

Triggered when an ad starts playing

Builtin Parameters

  • [message] - Length of the ad break in seconds

Youtube Callbacks

Youtube Command

Youtube Chat

Youtube Super Chat

Youtube Sticker

Youtube New Member

Kick Callbacks

Kick Command

Kick Chat

Kick Sub

Chaturbate Callbacks

Chaturbate requires authentication via a Token URL. To login to Chaturbate, go to VNyan's Settings > Chaturbate and click "Generate Auth Token". Copy and paste the whole Token URL into the field.

Chaturbate Chat

Triggers whenever a message is typed to Chaturbate Chat.

  • Allowed username - Exaxt username required to trigger
  • Userlevel - Userlevel required to trigger

Builtin Parameters

  • <username> - Author of the message
  • <message> - Chat message

Chaturbate Tips

Triggered when Chaturbate tips are received

  • Min Tokens - Minimum tokens to trigger
  • Max Tokens - Maximum tokens to trigger

Builtin Parameters

  • [message] - Contains amount of tokens
  • <username> - Contains user's name
  • <message> - Contains message passed along with tips

Chaturbate Follow

Triggers on new Chaturbate follow

Builtin Parameters

  • <username> - Contains follower's username

Chaturbate Fanclub

Triggers when user joins Chaturbate fanclub

Builtin Parameters

  • <username> - Contains fanclup member's username

Other Callbacks

WebSocket

WebsocketNode

Triggers on WebSocket Command. To use this node, you will need to activate the WebSockets Receiver under Settings > Misc > WebSockets.

  • Command Text - Node will trigger if received command equals the text

Builtin Parameters

  • [message] - Contains the text after the command text, converted to a number.

Note

If Command Text is empty, then the node will trigger on all WebSocket messages received. This makes it possible to read the [message] parameter, which can open up other uses of WebSockets besides single text commands.

Hotkey

Triggered by the press of a global hotkey.

  • Set Hotkey - Choose your specified hotkey by pressing the button and inputting the key on your keyboard. Accepts most keyboard inputs except for TAB, Caps Lock, or punctuations like the semi-colon, period, etc. CTRL, ALT and SHIFT can be used as modifiers with other keys.

Note

Running any application as Administrator in Windows can prevent hotkeys from being sent to the application.

Timer

Triggers on the Start Timer node.

  • Timer Name - Name of the timer to trigger on

Builtin Parameters

  • {timer name} - Contains the named timer's value.

Note

If there are multiple Timer callback nodes with the same name, the nodes will trigger in the order that they were created. Graph order generally dictates Timer node creation order on load, so if you are using the same timer for multiple graphs then they should activate in order left to right.

In cases where two differently named Timer callback noded are either wired into the node, or access the same parameter, or trigger nodes that would overwrite each other like Bone Rotation nodes, the Timer that is created first in memory takes priority. Order of execution will be first based on the order that timers are wired, then on graph order. What matters is when the Timer is named and put into memory.

Trigger

Triggers with Call Trigger-node

  • Trigger Name - Trigger Name to trigger on

Application Start

Triggers on application start

Avatar Loaded

Triggers after loading avatar

World Loaded

Triggers after loading world

Collision

Triggers on collision

  • Collision Type - Collision type to trigger on
  • Item Tag Filter - Filter by item type specified in item spawn-node. Empty will trigger on every item.

CObject Collision

Triggered on custom objects collision against anything

  • Collision Type - Collision event type to listen to

Builtin Parameters

  • <message> - Contains Custom Object's ID
  • <message2> - Contains Collision GameObject's name
  • <message3> - Contains Collision object's Tag or ID

Leap Motion Status

Triggers whenever Leap Motion tracking status of either left or right hands change.

  • Hand - Which hand to react to
  • Tracking Status - Whether to react to when status is Detected or Lost

Note

If the Mirror Hands setting is enabled in your Leap Motion Tracking settings, this will not be reflected by the Hand setting and you will find that the node will trigger for the opposite hands. In those cases, flip the Left/Right setting around.

VMC Status

Triggers on VMC Layer status change

  • VMC Layer Select which layer to listen and trigger on status change
  • Tracking Status Select whether to trigger on 'connected' or 'disconnected' status change.