Emote Bar

Emotes are a core component of any social experience. The EmoteBar developer module aims to provide players an accessible, customizable way to facilitate meaningful social interaction.

Module Usage

Installation

To use the EmoteBar module in an experience:

1. From the View tab, open the Toolbox and select the Creator Store tab.

   

2. Make sure the Models sorting is selected, then click the See All button for Categories.

   

3. Locate and click the Dev Modules tile.

   

4. Locate the Emote Bar module and click it, or drag-and-drop it into the 3D view.

   

5. In the Explorer window, move the entire EmoteBar model into ServerScriptService. Upon running the experience, the module will distribute itself to various services and begin running.

   

Configuration

The module is preconfigured with 7 emotes and it can be easily customized with your own emotes and display options. Additionally, if the player owns any emotes from previous Roblox events such as Lil Nas X, Royal Blood, or Twenty One Pilots, those emotes will be automatically added to the list of available emotes.

1. In ServerScriptService, create a new Script and rename it ConfigureEmotes.

   

2. Paste the following code into the new ConfigureEmotes script. The useDefaultEmotes setting of false overrides the default emotes and lets you define custom emotes via the setEmotes function.

   Script - ConfigureEmotes
   local ReplicatedStorage = game:GetService("ReplicatedStorage")
   
   local EmoteBar = require(ReplicatedStorage:WaitForChild("EmoteBar"))
   
   EmoteBar.configureServer({
   	useDefaultEmotes = false,
   })
   
   EmoteBar.setEmotes({
   	{
   		name = "Hello",
   		animation = "rbxassetid://3344650532",
   		image = "rbxassetid://7719817462",
   		defaultTempo = 1,
   	},
   	{
   		name = "Applaud",
   		animation = "rbxassetid://5915693819",
   		image = "rbxassetid://7720292217",
   		defaultTempo = 2,
   	},
   })

Mega Emotes

A mega emote is formed when multiple players in the same area perform the same emote at the same time. As more and more players join in, the mega emote grows larger. As players stop performing the emote, the mega emote grows smaller until eventually it disappears.

Tempo

An emote's tempo is the speed at which it plays when its button is tapped once. The default speed of an emote is determined by its defaultTempo. An emote's speed can be increased or decreased by tapping its button faster or slower.

API Reference

Types

Emote

Each emote is represented by a dictionary with the following key-value pairs:

Enums

EmoteBar.GuiType

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EmoteBar = require(ReplicatedStorage:WaitForChild("EmoteBar"))

EmoteBar.configureClient({
	guiType = EmoteBar.GuiType.EmoteWheel,
})

Functions

configureServer

Overrides default server-side configuration options through the following keys/values in the config table. This function can only be called from a Script and changes will automatically replicate to all clients.

Script
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EmoteBar = require(ReplicatedStorage:WaitForChild("EmoteBar"))

EmoteBar.configureServer({
	emoteMinPlayers = 2,
	playParticles = false,
})

configureClient

Overrides default client-side configuration options through the following keys/values in the config table. This function can only be called from a LocalScript. Depending on the value of guiType, options in the noted tabs also apply.

LocalScript - Emote Bar
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EmoteBar = require(ReplicatedStorage:WaitForChild("EmoteBar"))

EmoteBar.configureClient({
	guiType = EmoteBar.GuiType.EmoteBar,
	maxEmotesPerPage = 6,
	nextPageKey = Enum.KeyCode.Z,
	prevPageKey = Enum.KeyCode.C,
})

LocalScript - Emote Wheel
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EmoteBar = require(ReplicatedStorage:WaitForChild("EmoteBar"))

EmoteBar.configureClient({
	guiType = EmoteBar.GuiType.EmoteWheel,
})

setEmotes

Sets the custom emotes to use. These will be added to the defaults if useDefaultEmotes is true, or replace the defaults if useDefaultEmotes is false. This function can only be called from a Script and changes will automatically replicate to all clients.

See Emote for the structure of each emote passed to this function.

Script - ConfigureEmotes
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EmoteBar = require(ReplicatedStorage:WaitForChild("EmoteBar"))

EmoteBar.configureServer({
	useDefaultEmotes = false,
})

EmoteBar.setEmotes({
	{
		name = "Hello",
		animation = "rbxassetid://3344650532",
		image = "rbxassetid://7719817462",
		defaultTempo = 1,
	},
	{
		name = "Applaud",
		animation = "rbxassetid://5915693819",
		image = "rbxassetid://7720292217",
		defaultTempo = 2,
	},
})

setGuiVisibility

Shows or hides the emotes GUI. This function can only be called from a LocalScript on a specific client.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EmoteBar = require(ReplicatedStorage:WaitForChild("EmoteBar"))

EmoteBar.setGuiVisibility(false)

getEmote

Gets an Emote by name. Returns nil if the emote cannot be found. This function can only be called from a LocalScript on a specific client.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EmoteBar = require(ReplicatedStorage:WaitForChild("EmoteBar"))

local shrug = EmoteBar.getEmote("Shrug")

playEmote

Plays the given Emote and fires the emotePlayed event on the server, if connected. This function can only be called from a LocalScript on a specific client.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EmoteBar = require(ReplicatedStorage:WaitForChild("EmoteBar"))

local shrug = EmoteBar.getEmote("Shrug")
EmoteBar.playEmote(shrug)

lockEmote

Locks the Emote with the given name. This function can only be called from a LocalScript on the client.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EmoteBar = require(ReplicatedStorage:WaitForChild("EmoteBar"))

EmoteBar.lockEmote("Applaud")

unlockEmote

Unlocks the Emote with the given name. This function can only be called from a LocalScript on the client.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EmoteBar = require(ReplicatedStorage:WaitForChild("EmoteBar"))

EmoteBar.unlockEmote("Applaud")

Events

emotePlayed

Fires when any client plays an emote. This event can only be connected in a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EmoteBar = require(ReplicatedStorage:WaitForChild("EmoteBar"))

EmoteBar.emotePlayed:Connect(function(player, emote)
	print(player.Name, "played", emote.name)
end)

lockedEmoteActivated

Fires when a client clicks a locked emote. This event can only be connected in a LocalScript.

LocalScript
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local Players = game:GetService("Players")

local EmoteBar = require(ReplicatedStorage:WaitForChild("EmoteBar"))

EmoteBar.lockedEmoteActivated:Connect(function(emote)
	print(Players.LocalPlayer, "clicked", emote.name)
end)