Reference Sub actions Voicemod

Voicemod sub-actions

Also on the Cuebot Docs site.

Get current voice

Finds out which voice Voicemod is using now and puts it into variables for later steps.

Variables it adds

Variable	What it holds
%voicemodVoiceName%	The name of the current voice
%voicemodVoiceId%	The current voice's ID

Type id: voicemod.getCurrentVoice

Get sounds

Gets the list of your Voicemod soundboard sounds into variables for later steps.

Variables it adds

Variable	What it holds
%voicemodSounds%	The sound names, separated by commas
%voicemodSoundCount%	How many sounds there are
%voicemodSoundsJson%	The full list with details, for people who use scripts

Type id: voicemod.getSounds

Get voices

Gets the list of your Voicemod voices into variables for later steps.

Setting	What to put in
Only favorites	Tick to list only the voices you starred as favorites in Voicemod. Untick to list them all. Starts as: false.

Variables it adds

Variable	What it holds
%voicemodVoices%	The voice names, separated by commas
%voicemodVoiceCount%	How many voices there are
%voicemodVoicesJson%	The full list with details, for people who use scripts

Type id: voicemod.getVoices

Hear myself on/off

Turns 'hear my voice' on or off, so you can listen to yourself in your headphones.

Setting	What to put in
State	Toggle flips the current setting, On turns it on and Off turns it off. Options: Switch (on if off, off if on), Turn on, Turn off. Starts as: Switch (on if off, off if on).

Variables it adds

Variable	What it holds
%voicemodHearMyself%	True when hearing yourself is on now

Type id: voicemod.setHearMyself

Play sound

Plays a sound from your Voicemod soundboard. Handy for a sound effect reward.

Setting	What to put in
Sound (name)	The sound's name as the Voicemod soundboard shows it.

Variables it adds

Variable	What it holds
%voicemodSoundName%	The name of the sound that was played

Type id: voicemod.playSound

Select random voice

Switches Voicemod to a random voice. Fun for a surprise reward.

Setting	What to put in
From	Which voices to pick from: all voices, Voicemod's free voices, your favourites (the ones you starred in Voicemod) or your custom voices (the ones you made). Options: All voices, Free voices, Favourite voices, My custom voices. Starts as: All voices.

Type id: voicemod.selectRandomVoice

Select voice

Switches Voicemod to a voice of your choice. Handy as a reward, like a robot voice for a few minutes.

Setting	What to put in
Voice (name or id)	The voice's name as Voicemod shows it, like "Robot", or its ID.

Variables it adds

Variable	What it holds
%voicemodVoiceName%	The name of the voice that was chosen
%voicemodVoiceId%	That voice's ID

Type id: voicemod.selectVoice

Set background effect state

Turns Voicemod's background sound effects on or off.

Setting	What to put in
State	Toggle flips the current setting, On turns it on and Off turns it off. Options: Switch (on if off, off if on), Turn on, Turn off. Starts as: Switch (on if off, off if on).

Variables it adds

Variable	What it holds
%voicemodBackgroundEffects%	True when background effects are on now

Type id: voicemod.setBackgroundEffects

Set censor beep

Turns Voicemod's censor beep, which bleeps out bad language, on or off.

Setting	What to put in
Beep	On turns the censor beep on. Off turns it off. Options: On, Off. Starts as: On.

Type id: voicemod.setCensorBeep

Set microphone mute state

Mutes or unmutes your microphone in Voicemod.

Setting	What to put in
Microphone	Toggle flips the current setting, On mutes the microphone and Off unmutes it. Options: Switch (on if off, off if on), Mute, Unmute. Starts as: Switch (on if off, off if on).

Variables it adds

Variable	What it holds
%voicemodMuted%	True when the microphone is muted now

Type id: voicemod.setMute

Set voice changer state

Turns the Voicemod voice changer on or off.

Setting	What to put in
State	Toggle flips the current setting, On turns it on and Off turns it off. Options: Switch (on if off, off if on), Turn on, Turn off. Starts as: Switch (on if off, off if on).

Variables it adds

Variable	What it holds
%voicemodVoiceChanger%	True when the voice changer is on now

Type id: voicemod.setVoiceChanger

Stop all sounds

Stops every Voicemod soundboard sound that is playing.

Type id: voicemod.stopAllSounds