Callback Nodes - Suvidriel/VNyanDoc GitHub Wiki
Callback nodes listen for specific events (e.g. hotkey pressed, Twitch redeems, application start, etc.). For each occurrence of the event, callback nodes send a trigger signal to all nodes connected via its (yellow) Call socket. Callback nodes may also have (red) Output Value Sockets. They do not have (teal) Listen sockets to receive a signal from other nodes (but see Timers and Triggers). Different Callback nodes listen for events from VNyan internally, from your system, or even from places like your Twitch or YouTube streams.
Types of Callback nodes:
- Local Callbacks
- Twitch Callbacks
- Youtube Callbacks
- Kick Callbacks
- Chaturbate Callbacks
- Fansly Callbacks
- Other Callbacks
- M - Manual input
- T - Trigger output*
-
S - Socket input/output**
*Callback Nodes exclusively have one Call Socket that signals if the the Callback Node was activated or not. Trigger output will not be described in the overviews below.
**Callback Nodes do not have Input Socket Values, and so S will exclusively refer to Socket Output.
For more details on node input and output, see Input and Output methods
Local callbacks are callbacks originating from your own system, like hotkeys, your motion tracking system, or VNyan's trigger system.
Sends a trigger when the specified hotkey is pressed.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Set Hotkey | M | Hotkey | Click the button and press the key (combination) you want to set as hotkey. The node 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.
Sends a trigger when the specified gesture is held.
Name | Method | Type | Description |
---|---|---|---|
Gesture to Trigger | M | - | Select which predefined gesture activates the Gesture node. Gestures must be set up in the Gestures Menu before they will appear as options in the Gesture node. |
Sends a trigger signal when a timer of the specified name runs out. Timers are started with the Start Timer node. Timer nodes can be triggered by timers started on other graphs (see noted below).
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Timer Name | M | String | Name of the timer to to listen to as specified by a Start Timer node. |
Builtin Parameters
Name | Description |
---|---|
{timer_name} | A parameter that contains the named timer's value. The timer value can be read with a Set Parameter node, where the Parameter value is set to {timer_name} (including curly brackets, replace timer_name with the name of your timer). |
Note
If there are multiple Timer callback nodes listening for the same timer, the nodes will trigger in the order that they were created. Whenever VNyan is opened, Timer node creation order is generally dictated by Graph order, so if you are using the same timer for multiple graphs, then these graphs should activate in order left to right.
In cases where two differently named Timer callback nodes are either wired into the same Action or Gateway node, two Timer nodes listen for the same timer, or multiple Timer nodes trigger nodes that would overwrite each other (for example multiple Bone Rotation nodes), the Timer that is created first in memory takes priority. Order of execution is based on first the order that timers are wired, then on graph order. What matters is when the Timer is named and put into memory.
Sends a trigger signal when a Call Trigger node is activated.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Trigger Name | M | String | The name of the Trigger that a Call Trigger node can call out to. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Value 1 | S | Int | An integer value provided by the Call Trigger. |
Value 2 | S | Int | An integer value provided by the Call Trigger. |
Value 3 | S | Int | An integer value provided by the Call Trigger. |
Text 1 | S | String | A string value provided by the Call Trigger. |
Text 2 | S | String | A string value provided by the Call Trigger. |
Text 3 | S | String | A string value provided by the Call Trigger. |
Note
Plugins can use trigger signals to interact with VNyan's node graph system. Plugins can also use the Trigger node output values to send values to the node graph, which can then be forwarded by the Trigger node's Output Value Sockets.
Sends a trigger signal when the application starts. This node can be used to automatically load in your avatar, set certain Blendshapes and parameters, spawn in props and custom objects, etc, on application start.
This node has no input our output values.
Sends a trigger signal whenever an avatar is successfully loaded in.
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Avatar | S | String | The file name of the avatar that was loaded in. This can be used to trigger specific effects based on which avatar was loaded in, for example using the Case node. |
Sends a trigger signal whenever a world is successfully loaded in.
Output Values:
Name | Method | Type | Description |
---|---|---|---|
World | S | String | The file name of the world that was loaded in. This can be used to trigger specific effects based on which world was loaded in, for example using the Case node. |
Sends a trigger signal whenever a specified type collision occurs.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Collision Type | M | Dropdown | Which type of collision the node listens for. The node can listen for the following types of collisions:
|
Item Tag Filter | M | String | Filter to only send trigger signals if the colliding items have the specified Item Tag. Item Tags are assigned to items then their item spawn-node (e.g. throw item node) has an Item Tag value specified. If left empty, the Collision node will trigger on every item of the selected type. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Collision Type | S | String | A string containing the name of the collision type that activated the node. |
Item Tag Filter | S | String | A string containing the name of the Item Tag Filter that was specified for the Collision node. |
Sends a trigger signal when custom objects collide against another object.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Collision Type | M | - | Collision event type to listen to:
|
Output Values:
Name | Method | Type | Description |
---|---|---|---|
CObjectID | S | String | The ID of the custom object |
Collision GameObject | S | String | The name of the object that the custom object collided with. |
Collision Tag or ID | S | String | The tag or ID of the object that the custom object collided with. |
Builtin Parameters:
Name | Description |
---|---|
<message> | See CObjectID Output Value |
<message2> | See Collision GameObject Output Value |
<message3> | See Collision Tag or ID Output Value |
Sends a trigger signal at the moment that the Leap Motion tracking status of either the left or right hand changes.
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, i.e. if the tracking on the user's right hand is lost and Mirror Hands is enabled, the that will reflect on the left hand of the avatar.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Hand | M | - | Set the hand for which the tracking status should be monitored. |
Tracking Status | M | - | Set whether to send a trigger signal to when the tracking status is first Detected or Lost. |
Sends a trigger signal at the moment that the VMC tracking status of a specified VMC Layer changes.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
VMC Layer | M | - | Select the VMC layer for which the tracking status should be monitored. |
Tracking Status | M | - | Select whether to send a trigger signal then the tracking status first switches to 'connected' or 'disconnected'. |
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. See the Integrations page for more information on enabling Twitch integration.
Triggers on Twitch Channel Point redeem. Requires a redeem in Twitch's channel points page is created first.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Redeem Name | M | String | Case-sensitive name of the channel point redeem that should activate the trigger signal. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Display Name | S | String | The display name of the viewer that redeemed the channel point redeem. |
Value | S | Int | A number value contained within the message if there is exactly one, otherwise 0. |
Message | S | String | Any text that was passed along with the redeem. |
Redeem Name | S | String | The name of the redeem. |
Builtin Parameters:
Name | Description |
---|---|
[message] | A number value contained within the message if there is exactly one, otherwise 0. |
<username> | See Display Name output value. |
<message> | See Message output value. |
<message2> | See Redeem Name output value. |
Sends a trigger signal whenever bits are received.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Min Bits | M | Int | Minimum amount of bits to activate the node. |
Max Bits | M | Int | Maximum amount of bits to activate the node. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Bits | S | Int | The exact number of bits that were donated. |
Display Name | S | String | The display name of the viewer that donated the bits. |
Message | S | String | Any text that was passed along with the cheer. |
Builtin Parameters:
Name | Description |
---|---|
[message] | See Bits output value. |
<username> | See Display Name output value. |
<message> | See Message output value. |
Sends a trigger signal once every time a viewer (re)subscribes. Also sends a trigger signal for *each* gifted subscription.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Subscription Type | M | - | Specify whether the node should activate on normal subscriptions, gifted subscriptions, or both. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Display Name | S | String | The display name of the viewer that redeemed the channel point redeem. |
Amount | S | Int | The amount of months subscribed in advance or the amount gift subs that were gifted. |
Total | S | Int | The total cumulative months the user has subscribed to the channel or the total amount of subs the user has gifted to the channel. |
Tier | S | Int | The tier of the received subscription(s) as a number. Tier 1 = 1000; Tier 2 = 2000; Tier 3 = 3000. |
Builtin Parameters:
Name | Description |
---|---|
<username> | See Display Name output value. |
[message] | See Tier output value. |
[message2] | See Amount output value. |
[message3] | See Total output value. |
Community Note: Presumably, prime subs are also given a Tier value of 1000, but this is not verified. Please let us know if you have confirmed this so we can update the wiki.
Sends a trigger signal whenever a viewer starts to follow the channel.
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Display Name | S | String | The display name of the viewer that redeemed the channel point redeem. |
Username | S | String | The display name of the viewer that redeemed the channel point redeem. |
Builtin Parameters
Name | Description |
---|---|
<username> | See Display Name output value. |
Sends a trigger signal on incoming raids.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Min Raiders | M | Int | Minimum amount of raiders to trigger. |
Max Raiders | M | Int | Maximum amount of raiders to trigger. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Raiders | S | Int | The exact number of raiders in the raid. |
Display Name | S | String | The display name of the viewer that redeemed the channel point redeem. |
Builtin Parameters
Name | Description |
---|---|
<username> | See Display Name output value. |
Sends a trigger signal whenever a Hype Train starts or ends.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Train Status | M | - | Select whether to send a trigger signal on hype train start or end. |
Sends a trigger signal when a specified chat command starting with !-character is used.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Command | M | String | The command that will activate the Commands node. Should be entered without "!". |
Userlevel | M | - | Userlevel of the chatter required to activate the Commands node.
|
Allowed username | M | String | Only allow the viewer with the specified username to activate the Commands node. |
Excluded username | M | String | Exclude the viewer with the specified username from activating the Commands node. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Display Name | S | String | The display name of the viewer that activated the Commands node. |
Value | S | Int | Any numerical value that immediately follows the command (e.g. 4 in "!play 4"). |
Message | S | String | The full message following the command. |
Builtin Parameters:
Name | Description |
---|---|
<username> | See Display Name output value. |
[message] | See Value output value. |
<message> | Contains the whole chat message including the command. |
<message2> | See Message output value. |
Community Note: We are unsure whether the Allowed/Excluded Username input can be provided as a semicolon-delimitered list. It is also unknown whether these values supersede the UserLevel setting, or if these are combined.
Sends a trigger signal for every message in chat from a chatter with the specified permissions.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Userlevel | M | - | Userlevel of the chatter required to activate the Chat Message node.
|
Allowed username | M | String | Only allow the viewer with the specified username to activate the Chat Message node. |
Excluded username | M | String | Exclude the viewer with the specified username from activating the Chat Message node. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Display Name | S | String | The display name of the viewer that activated the Chat Message node. |
Message | S | String | The full message typed in chat. |
Builtin Parameters:
Name | Description |
---|---|
<username> | See Display Name output value. |
<message> | See Message output value. |
Community Note: We are unsure whether the Allowed/Excluded Username input can be provided as a semicolon-delimitered list. It is also unknown whether these values supersede the UserLevel setting, or if these are combined.
Sends a trigger signal when an ad starts playing.
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Seconds | S | Int | The duration of the ad in seconds. |
Builtin Parameters:
Name | Description |
---|---|
[message] | See Seconds output value. |
Sends a trigger signal whenever a Twitch user's details are loaded through the Load Twitch Profile node.
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Display Name | S | String | The username of the user whose details were loaded. |
Profile Pic URL | S | String | The URL to the user's profile picture. |
Description | S | String |
Community Note: It is unknown what information the Description output contains. Please let us know if you have more info.
Sends a trigger signal when a specified chat command starting with !-character is used.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Command | M | String | The command that will activate the Commands node. Should be entered without "!". |
Userlevel | M | - | Userlevel of the chatter required to activate the Commands node.
|
Allowed username | M | String | Only allow the viewer with the specified username to activate the Command node. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Username | S | String | The display name of the viewer that activated the Command node. |
Userlevel | S | Int | A number corresponding to the user level of the chatter using the command. |
Message | S | String | The full message following the command. |
Value | S | Int | Any numerical value that immediately follows the command (e.g. 4 in "!play 4"). |
Builtin Parameters:
Name | Description |
---|---|
<username> | See Username output value. |
<message> | Contains the whole chat message including the command. |
<message2> | See Message output value. |
[message] | See Value output value. |
[message3] | See Userlevel output value. |
Community Note: We are unsure whether the Allowed Username input can be provided as a semicolon-delimitered list. It is also unknown whether these values supersede the UserLevel setting, or if these are combined. It is currently unknown what values are associated with what Userlevel in the Userlevel output values. Please let us know if you have more information.
Sends a trigger signal for every message in chat from a chatter with the specified permissions.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Userlevel | M | - | Userlevel of the chatter required to activate the Chat node.
|
Allowed username | M | String | Only allow the viewer with the specified username to activate the YouTube Chat node. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Username | S | String | The username of the viewer that activated the YouTube Chat node. |
Userlevel | S | Int | A number corresponding to the user level of the chatter chatting. |
Message | S | String | The full message typed in chat. |
Builtin Parameters:
Name | Description |
---|---|
<username> | See Display Name output value. |
<message> | See Message output value. |
[message3] | See Userlevel output value. |
Community Note: We are unsure whether the Allowed Username input can be provided as a semicolon-delimitered list. It is also unknown whether these values supersede the UserLevel setting, or if these are combined. It is currently unknown what values are associated with what Userlevel in the Userlevel output values. Please let us know if you have more information.
Sends a trigger signal when a super chat is received.
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Username | S | String | The username of the viewer sending the super chat. |
Amount | S | String | The amount and currency donated with the super chat. |
Builtin Parameters:
Name | Description |
---|---|
<username> | See Userame output value. |
<message> | The full chat message sent with the super chat. |
<message2> | See Amount output value. |
[message3] | The userlevel of the user sending the super chat as a number. |
Community Note: It is currently unknown what values are associated with what Userlevel in the Userlevel output values. Please let us know if you have more information.
Sends a trigger signal receiving a YouTube Sticker.
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Username | S | String | The username of the viewer sending the sticker. |
Amount | S | String | The amount and currency donated paid for the sticker. |
Builtin Parameters:
Name | Description |
---|---|
<username> | See Userame output value. |
<message2> | See Amount output value. |
[message3] | The userlevel of the user sending the super chat as a number. |
Community Note: It is currently unknown what values are associated with what Userlevel in the Userlevel output values. Please let us know if you have more information.
Sends a trigger signal whenever a new member signs up for the channel.
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Username | S | String | The username of the viewer sending the sticker. |
Message | S | String | The message sent along with the new membership. |
Builtin Parameters:
Name | Description |
---|---|
<username> | See Userame output value. |
<message> | See Message output value. |
[message3] | The userlevel of the user sending the super chat as a number. |
Community Note: It is currently unknown what values are associated with what Userlevel in the Userlevel output values. Please let us know if you have more information.
Sends a trigger signal when a specified chat command starting with !-character is used.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Command | M | String | The command that will activate the Commands node. Should be entered without "!". |
Allowed username | M | String | Only allow the viewer with the specified username to activate the Command node. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Username | S | String | The display name of the viewer that activated the Command node. |
Value | S | Int | Any numerical value that immediately follows the command (e.g. 4 in "!play 4"). |
Message | S | String | The full message following the command. |
Builtin Parameters:
Name | Description |
---|---|
<username> | See Username output value. |
<message> | Contains the whole chat message including the command. |
<message2> | See Message output value. |
[message] | See Value output value. |
Community Note: We are unsure whether the Allowed Username input can be provided as a semicolon-delimitered list. It is also unknown whether these values supersede the UserLevel setting, or if these are combined.
Sends a trigger signal for every message in chat from a chatter with the specified username.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Allowed username | M | String | Only allow the viewer with the specified username to activate the Kick Chat node. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Username | S | String | The username of the viewer that activated the Kick Chat node. |
Message | S | String | The full message typed in chat. |
Builtin Parameters:
Name | Description |
---|---|
<username> | See Display Name output value. |
<message> | See Message output value. |
Community Note: We are unsure whether the Allowed Username input can be provided as a semicolon-delimitered list. It is also unknown whether these values supersede the UserLevel setting, or if these are combined.
Sends a trigger signal whenever someone subscribes to the channel.
This node has no input or output values.
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.
Sends a trigger signal for every message in chat from a chatter with the specified permissions.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Allowed username | M | String | Only allow the viewer with the specified username to activate the YouTube Chat node. |
Userlevel | M | - | Userlevel of the chatter required to activate the Chat node.
|
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Username | S | String | The username of the viewer that activated the YouTube Chat node. |
Message | S | String | The full message typed in chat. |
Builtin Parameters:
Name | Description |
---|---|
<username> | See Display Name output value. |
<message> | See Message output value. |
[message3] | The userlevel of the user sending the super chat as a number. |
Community Note: We are unsure whether the Allowed Username input can be provided as a semicolon-delimitered list. It is also unknown whether these values supersede the UserLevel setting, or if these are combined. It is currently unknown what values are associated with what Userlevel in the Userlevel output values. Please let us know if you have more information.
Sends a trigger signal whenever tokens are received.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Min Bits | M | Int | Minimum amount of tokens to activate the node. |
Max Bits | M | Int | Maximum amount of tokens to activate the node. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Tokens | S | Int | The exact number of tokens that were donated. |
Username | S | String | The username of the viewer that donated the tokens. |
Message | S | String | Any text that was passed along with the donation. |
Builtin Parameters:
Name | Description |
---|---|
[message] | See Tokens output value. |
<username> | See Username output value. |
<message> | See Message output value. |
Sends a trigger signal whenever a viewer starts to follow the channel.
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Username | S | String | The display name of the viewer that redeemed the channel point redeem. |
Builtin Parameters
Name | Description |
---|---|
<username> | See Username output value. |
Sends a trigger signal whenever someone joins the streamer's Chaturbate Fanclub.
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Username | S | String | The display name of the viewer that redeemed the channel point redeem. |
Builtin Parameters
Name | Description |
---|---|
<username> | See Username output value. |
Sends a trigger signal for every message in chat from a chatter with the specified username.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Allowed username | M | String | Only allow the viewer with the specified username to activate the Fansly Chat node. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Username | S | String | The username of the viewer that activated the Fansly Chat node. |
Message | S | String | The full message typed in chat. |
Builtin Parameters:
Name | Description |
---|---|
<username> | See Display Name output value. |
<message> | See Message output value. |
Community Note: We are unsure whether the Allowed Username input can be provided as a semicolon-delimitered list. It is also unknown whether these values supersede the UserLevel setting, or if these are combined.
Sends a trigger signal whenever a tip is received.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Min Bits | M | Int | Minimum tip amount to activate the node. |
Max Bits | M | Int | Maximum tip amount to activate the node. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Tips | S | Float | The exact amount that was donated. |
Username | S | String | The username of the viewer that tipped. |
Message | S | String | Any text that was passed along with the donation. |
Sends a trigger signal whenever a donation is made.
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Donor Name | S | String | The username of the viewer that donated the tokens. |
Comment | S | String | Any text that was passed along with the donation. |
Amount | S | Float | The exact amount that was donated. |
Currency | S | String | The currency that the donation was made in. |
Sends a trigger signal whenever a WebSocket Command is received. To use this node, you will need to activate the WebSockets Receiver under `Settings > Misc > WebSockets`.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Command Text | M | String | The node will activate if the received command equals the text. The node will also activate on all received commands that start with this value, if space-separated. Note: If Command Text is empty, then the node will trigger on all WebSocket messages received. This can be combined with the Message output to react to a variety of WebSocket commands, or Dictionary to import dictionaries into VNyan. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Value | S | Int | The command text after the value specified in Command Text converted to a numerical value. |
Message | S | String | The full command payload, including the value in Command Text. |
Data | S | Dict | The incoming command text converted to a Dictionary. Note: The incoming command text must be configured as a JSON string. This output only works if Command Text is left empty. Any filtering will need to be done in later nodes. |
Builtin Parameters:
Name | Description |
---|---|
[message] | See Value output value. |
<message> | See Message output value. |
Send a trigger signal when VNyan receives a web request with a given action name. VNyan listens to web request messages sent to http://localhost:8069 port.
Input Values:
Name | Method | Type | Description |
---|---|---|---|
Action | M | String | The value of the action parameter of the web request that the API Message node will respond to. Note: Unlike the WebSocket node, the API Message node does not activate on all web requests when the Action field is left empty. |
Copy Payload to Dictionary | M | String | The name of the dictionary to save the payload of the web request to. |
Output Values:
Name | Method | Type | Description |
---|---|---|---|
Action | S | String | The name of the action that was responded to. |
json | S | String | The web request payload as a JSON string. |
Payload | S | Dict | The web request payload, converted to a dictionary without being stored. |
Examples: POST-messages must be configured as JSON strings, containing an "action" string value, and a "payload" dictionary value. The node's Action value should then be set to the same value as the message's "action" value in order for the node to trigger.
For example, the message { "action":"Test", "payload": { "key1":"value1", "key2":2 } }
will activate an API message node where Action is set to "Test", and output a dictionary with two key-value pairs; one with the pair "key1" and "value1" and one with the pair "key2" and 2.
GET-messages are configured are browser URLs, targeting localhost:8069. The action and values are specified as parameters in the URL. The following URL will have the same results at the POST message above:
http://localhost:8069/?action=Test&key1=value1&key2=2
This node is the starting node for VNyan's blendshape processing pipeline. The Blendshape List does not send trigger output, as the resulting blendshape lists are evaluated automatically during the specified Processing Time. The node is activated only when tracking blendshapes are available.
See Blendshape Processing Nodes for more information and nodes of the blendshape processing pipeline.
Processing Time
Name | Description |
---|---|
After Tracking | The input and output blendshape values of the resulting node chain are processed immediately after tracking blendshape values are evaluated, and before nodes graphs, pendulums and expressions are processed. For example, this can be used to map ARKit blendshape values onto non-ARKit blendshapes before other processing procedures evaluate them further. |
After Nodes | The input and output blendshape values of the resulting node chain are processed after tracking, node graphs and pendulum blendshape values are evaluated, and before expressions are processed. For example, his can be used to map blendshape values from one blendshape onto another, that need to be reactive to nodes or pendulums. |
After Nodes | The input and output blendshape values of the resulting node chain are processed after tracking, node graphs, pendulum and expression blendshape values are evaluated. For example, this can be used to evaluate whether blendshapes need to be mapped based on whether a predefined expression is active. |
Note: A chain can be created at each processing time, taking the output from the previous chain as input, after the other processes of the selected step are finished and applied to the blendshape list. Multiple chains at the same processing time will override each other.
Output Values
Name | Method | Type | Description |
---|---|---|---|
Values | S | blendshapelist | A list of all blendshapes and their blendshape values after being processed by the node, evaluated each frame. If a given node from the blendshape processing pipeline is the last node in the chain, then the blendshapes and corresponding blendshape values in the output blendshape list are automatically applied to VNyan's blendshapes. If there are multiple chain ends, the blendshape list that was created last will be used to set VNyan's blendshape values. |