Client

Client plugins can be used to send messages, connect remote events, create bubble chats, and connect game events.

Bubble Chat

Bubble chat is a feature that adds messages over users heads when they speak. The plugin API allows you to create bubble chat for non-player objects super easily.

newBubbleChat

local bubbleChatFunctions = API.newBubbleChat(workspace:WaitForChild("Part"),"part")

This method allows you to create a "bubble chat speaker" for any object. It will return a table of functions to use.

Type	Name
object	bubble chat adornee
name	GUI name

Bubble chat functions:

say

local bubbleChatFunctions = API.newBubbleChat(workspace:WaitForChild("Part"),"part")
bubbleChatFunctions:say("hi")

This method allows you to make an actual chat bubble. And that's pretty much it! All you need to do is create a link between the part and the bubble chat and then you can make it say whatever you need.\

Type	Name
string	message

getUI

local bubbleChatFunctions = API.newBubbleChat(workspace:WaitForChild("Part"),"part")
print(bubbleChatFunctions:getUI():GetFullName())

This method will return the chat bubble's UI in PlayerGui.

System Messages

API.systemMessage("hello","all")

System messages are also super easy to do. All you need to do is specify the message and channel name (usually "all.")

Type	Name
string	message
string	channel name

Events

friendJoined

API.friendJoined:Connect(function(player)
    print(player)
end)

This event is fired when any friend of the LocalPlayer joins.

playerBlocked

API.playerBlocked:Connect(function(player)
    print(player,"was blocked")
end)

This event is fired when the LocalPlayer blocks an in-game user.

playerUnblocked

API.playerUnblocked:Connect(function(player)
    print(player,"was unblocked")
end)

This event is fired when the LocalPlayer unblocks an in-game user.

playerFriended

API.playerFriended:Connect(function(player)
    print(player,"was friended")
end)

This event is fired when the LocalPlayer adds someone as a friend in-game.

playerUnfriended

API.playerUnfriended:Connect(function(player)
    print(player,"was unfriended")
end)

This event is fired when the LocalPlayer removes a friend in-game.

Methods

quickMessage

API:quickMessage("Player1","Hello world!",Color3.fromRGB(255,0,0),Color3.fromRGB(255,255,0));

This method allows you to quickly forge a message for the client, useful for system messages to the client / warnings.

Type	Name
string	username
string	message
color3 (optional)	name color
color3 (optional)	text color

getPermissions

print(API:getPermissions(game.Players.LocalPlayer))

This method returns a number that represents the player's rank that was set using the configuration.

Type	Name
player object	user

getBlockedUsers

print(API:getBlockedUsers())

This method returns a table of all users that the LocalPlayer has blocked.

Variables

userPlatform

print(API.userPlatform)

This variable tells you what platform the user is on.

Platform type

Desktop

Mobile

Console