VTube Studio triggers¶
Any VTube Studio message (advanced)¶
Runs for any message VTube Studio sends, so you can react to things Cuebot has no special trigger for. For advanced users.
| Setting | What to put in |
|---|---|
| API event names | Only react to these kinds of VTube Studio messages, like "ModelMovedEvent". Separate several with commas. Leave empty for all. |
Variables you get
| Variable | What it holds |
|---|---|
%eventName% |
The kind of VTube Studio message |
%data% |
All the details of the message, as raw text |
Type id: vtubestudio.event
Background changed¶
Runs when you switch the background in VTube Studio.
| Setting | What to put in |
|---|---|
| Background names | Only react to these backgrounds, typed by name. Separate several with commas. Leave empty for any background. |
Variables you get
| Variable | What it holds |
|---|---|
%backgroundName% |
The name of the new background |
Type id: vtubestudio.backgroundChanged
Connected¶
Runs when Cuebot connects to VTube Studio.
Type id: vtubestudio.connected
Disconnected¶
Runs when Cuebot loses its connection to VTube Studio, for example when you close it.
Variables you get
| Variable | What it holds |
|---|---|
%reason% |
Why the connection ended |
Type id: vtubestudio.disconnected
Expression toggled¶
Runs when an expression (a face or pose preset) is switched on or off in VTube Studio.
| Setting | What to put in |
|---|---|
| Expression names | Only react to these expressions, typed by name or file. Separate several with commas. Leave empty for any expression. |
| State | Pick On to react when it turns on, Off when it turns off, or Any for both. Options: Either way, Turned on, Turned off. Starts as: Either way. |
Variables you get
| Variable | What it holds |
|---|---|
%modelName% |
The name of the model |
%modelId% |
VTube Studio's id for the model |
%expressionName% |
The name of the expression |
%expressionFile% |
The expression's file |
%active% |
True when the expression is now on |
Type id: vtubestudio.expressionToggled
Face tracking found¶
Runs when VTube Studio sees your face again after losing it.
Variables you get
| Variable | What it holds |
|---|---|
%faceFound% |
True if a face is being tracked |
%leftHandFound% |
True if the left hand is tracked |
%rightHandFound% |
True if the right hand is tracked |
Type id: vtubestudio.trackingFound
Face tracking lost¶
Runs when VTube Studio can no longer see your face. Good for a "brb" reaction.
Variables you get
| Variable | What it holds |
|---|---|
%faceFound% |
True if a face is being tracked |
%leftHandFound% |
True if the left hand is tracked |
%rightHandFound% |
True if the right hand is tracked |
Type id: vtubestudio.trackingLost
Hotkey triggered¶
Runs when a VTube Studio hotkey is used, for example to change an expression or play an animation.
| Setting | What to put in |
|---|---|
| Hotkey names | Only react to these hotkeys, typed by name or id. Separate several with commas. Leave empty for any hotkey. |
| Hotkey action | Only react to this kind of hotkey, like "ToggleExpression" or "TriggerAnimation". Leave empty for any kind. |
| Ignore hotkeys triggered by plugins | Tick to ignore hotkeys that other programs (including Cuebot) triggered, so only hotkeys you press yourself count. Starts as: false. |
Variables you get
| Variable | What it holds |
|---|---|
%hotkeyName% |
The name of the hotkey |
%hotkeyId% |
The hotkey's id |
%hotkeyAction% |
What the hotkey does |
%hotkeyFile% |
The file the hotkey uses, if any |
%triggeredByApi% |
True if another program triggered it |
%modelName% |
The model it was used on |
Type id: vtubestudio.hotkeyTriggered
Item added¶
Runs when an item (a prop or picture) is added to your VTube Studio scene.
| Setting | What to put in |
|---|---|
| Item files | Only react to these item files (the picture or prop file names, like "star.png"). Separate several with commas. Leave empty for any item. |
Variables you get
| Variable | What it holds |
|---|---|
%itemEventType% |
What happened to the item: Added, Removed, Clicked and so on |
%itemInstanceId% |
The id of this copy of the item |
%itemFileName% |
The item's file name |
%itemX% |
Where the item is, left to right |
%itemY% |
Where the item is, bottom to top |
Type id: vtubestudio.itemAdded
Item event¶
Runs when something happens to an item (a prop or picture in your VTube Studio scene), like being added, removed or clicked.
| Setting | What to put in |
|---|---|
| Item event | Which kind of thing to react to. Pick Any to react to all of them. Options: Any, Added, Removed, DroppedPinned, DroppedUnpinned, Clicked, Locked, Unlocked. Starts as: Any. |
| Item files | Only react to these item files (the picture or prop file names, like "star.png"). Separate several with commas. Leave empty for any item. |
Variables you get
| Variable | What it holds |
|---|---|
%itemEventType% |
What happened to the item: Added, Removed, Clicked and so on |
%itemInstanceId% |
The id of this copy of the item |
%itemFileName% |
The item's file name |
%itemX% |
Where the item is, left to right |
%itemY% |
Where the item is, bottom to top |
Type id: vtubestudio.itemEvent
Item removed¶
Runs when an item (a prop or picture) is removed from your VTube Studio scene.
| Setting | What to put in |
|---|---|
| Item files | Only react to these item files (the picture or prop file names, like "star.png"). Separate several with commas. Leave empty for any item. |
Variables you get
| Variable | What it holds |
|---|---|
%itemEventType% |
What happened to the item: Added, Removed, Clicked and so on |
%itemInstanceId% |
The id of this copy of the item |
%itemFileName% |
The item's file name |
%itemX% |
Where the item is, left to right |
%itemY% |
Where the item is, bottom to top |
Type id: vtubestudio.itemRemoved
Model animation¶
Runs when an animation on the model starts, ends or sends a custom signal.
| Setting | What to put in |
|---|---|
| Animation event | Start reacts when an animation begins, End when it finishes, Custom for special signals set inside the animation, Any for all. Options: Any, Start, End, Custom. Starts as: Any. |
| Animation names | Only react to these animations, typed by name. Separate several with commas. Leave empty for any animation. |
| Ignore idle animations | Tick to ignore the animations the model plays by itself while doing nothing (idle animations). Starts as: true. |
Variables you get
| Variable | What it holds |
|---|---|
%modelName% |
The name of the model |
%modelId% |
VTube Studio's id for the model |
%animationEventType% |
Start, End or Custom |
%animationName% |
The name of the animation |
%animationLength% |
How long the animation lasts, in seconds |
%animationEventData% |
Extra text for custom signals |
%isIdleAnimation% |
True if it is an idle animation |
Type id: vtubestudio.modelAnimation
Model clicked¶
Runs when someone clicks in the VTube Studio window, for example on your model.
| Setting | What to put in |
|---|---|
| Mouse button | Only react to this mouse button, or pick Any. Options: Any, Left, Right, Middle. Starts as: Any. |
| Only clicks on the model | Tick to only react when the click lands on the model. Untick to react to clicks anywhere. Starts as: true. |
Variables you get
| Variable | What it holds |
|---|---|
%modelName% |
The name of the model |
%modelId% |
VTube Studio's id for the model |
%modelWasClicked% |
True if the click hit the model |
%mouseButton% |
Left, Right or Middle |
%clickX% |
Where the click landed, sideways |
%clickY% |
Where the click landed, up or down |
%clickedArtMeshCount% |
How many parts of the model were hit |
Type id: vtubestudio.modelClicked
Model configuration changed¶
Runs when the settings of the loaded model change in VTube Studio, for example when you edit its hotkeys.
Variables you get
| Variable | What it holds |
|---|---|
%modelName% |
The name of the model |
%modelId% |
VTube Studio's id for the model |
%hotkeyConfigChanged% |
True if the hotkey list changed |
Type id: vtubestudio.modelConfigChanged
Model loaded¶
Runs when a model (your avatar) is loaded in VTube Studio.
| Setting | What to put in |
|---|---|
| Model names | Only react to these models, typed by name. Separate several with commas. Leave empty for any model. |
Variables you get
| Variable | What it holds |
|---|---|
%modelName% |
The name of the model |
%modelId% |
VTube Studio's id for the model |
Type id: vtubestudio.modelLoaded
Model moved¶
Runs when the model is moved, turned or resized in VTube Studio.
Variables you get
| Variable | What it holds |
|---|---|
%modelName% |
The name of the model |
%modelId% |
VTube Studio's id for the model |
%positionX% |
Left to right position (-1 is left edge, 1 is right edge) |
%positionY% |
Bottom to top position (-1 is bottom, 1 is top) |
%rotation% |
How far it is turned, in degrees |
%size% |
How big it is |
Type id: vtubestudio.modelMoved
Model unloaded¶
Runs when the model (your avatar) is unloaded from VTube Studio.
Variables you get
| Variable | What it holds |
|---|---|
%modelName% |
The name of the model |
%modelId% |
VTube Studio's id for the model |
Type id: vtubestudio.modelUnloaded
Post-processing changed¶
Runs when VTube Studio's post-processing (extra visual effects) is turned on or off or its preset changes.
Variables you get
| Variable | What it holds |
|---|---|
%postProcessingOn% |
True when post-processing is on |
%postProcessingPreset% |
The name of the preset in use |
Type id: vtubestudio.postProcessingChanged
Tracking status changed¶
Runs when VTube Studio's face or hand tracking changes (found or lost).
Variables you get
| Variable | What it holds |
|---|---|
%faceFound% |
True if a face is being tracked |
%leftHandFound% |
True if the left hand is tracked |
%rightHandFound% |
True if the right hand is tracked |
Type id: vtubestudio.trackingStatusChanged