after ages of waiting, notifiiedV3 has finally been released!
notifiied is an easy way of creating notifications to alert players to in-game events, and has now been made even easier! with the power of notifiied, you can create and configure your notification from a modulescript.
the module is very customizable, redundant, and simple-to-use while being extremely capable. it features animations (including loading), built-in sounds and icons (which you can, of course, customise yourself, if you want) , and smart notifications (the notifications are aware of each other).
GET THE NOTIFICATION
please note: you cannot call require() from the notification’s AssetId.
BASIC SHOWCASE
corner (currently the only notification type implemented)
https://1drv.ms/v/s!Auz1-GxC3wQCkelprlALY06Mxg75kw?e=0MahIC
(sorry for low quality, couldn’t be bothered configuring roblox recorder so i just screen recorded the viewport)
JOIN THE GROUP (optional)
QUICK START GUIDE
- you know the drill, get the module from your toolbox and move it into ReplicatedStorage.
EXAMPLE SCRIPT
- if this script scares you, don’t worry! i break it down more in the API section of this post.
local notifiiedV3 = require(game:GetService("ReplicatedStorage").notifiiedV3)
local notification = notifiiedV3.new()
notification:setType("corner")
script.Parent.MouseButton1Down:Connect(function()
notification:notify()
end)
API
module.new()
creates a new instance of the notification module. in this instance, you can modify individual notification settings, which we’ll get to later.
EXAMPLE USAGE:
local notification = notifiiedV3.new()
notification:setType(type:string)
sets the type of the notification to the selected value.
- available values: “corner” or “banner” (coming soon, along with more, newer notification types.)
EXAMPLE USAGE:
notification:setType("corner")
(of course, notification being an instance of notifiiedV3 created with notifiiedV3.new())
this command is required.
notification:setBroadcast(type:string|Instance)
sets the broadcast type of the notification. this controls who the notification is broadcast to.
- available values: “local”, “localServer”, “global”
- alternatively, you can use the player’s instance as an argument.
local: only broadcasts to the local player from which the notification’s instance was created.
localServer: broadcasts to the local server that the client is currently in
global: broadcasts to every player in every server of that game.
EXAMPLE USAGE:
notification:setBroadcast(game.Players.LocalPlayer or "local") -- set the broadcast type to game.Players.LocalPlayer, but if that's nil, set it to "local", and let notifiiedV3 handle the player for me.
this command is optional.
notification:setText(text:string)
self-explanatory. sets the text of the notification.
EXAMPLE USAGE:
notification:setText("i am an og kfc enjoyer")
this command is optional, but recommended.
notification:setTextColor(color:BrickColor|Color3)
also self-explanatory. sets the color of the text of the notification.
EXAMPLE USAGE:
notification:setTextColor(Color3.new(0,0,0))
-- or --
notification:setTextColor(BrickColor.new("White"))
this command is optional.
notification:silenceWarnings(bool:boolean)
silence notifiied from printing anything unimportant to console.
by default, silenceWarnings() will silence notifiied, but setting the bool argument to false or true can also control whether the output is silenced or not (though, i’m not sure about the use case for that)
EXAMPLE USAGE:
notification:silenceWarnings(true)
this command is optional.
notification:setMode(mode:string)
sets the notification’s ui color scheme.
- available values: “dark”, “light”
EXAMPLE USAGE:
notification:setMode("light")
this command is optional.
notification:setIcon(icon:number|string)
sets the icon displayed beside the notification.
- available values: AssetId, Asset URL, or premade icon selection (“warning”, “information”, “clock”, “plus”, “critical”, “checkmark”)
EXAMPLE USAGE:
notification:setIcon("critical")
-- or --
notification:setIcon(12278037723)
-- or --
notification:setIcon("http://www.roblox.com/asset/?id=12278037723")
this command is optional, but recommended
notification:setIconColor3(color:Color3)
sets the notification icon’s color.
EXAMPLE USAGE:
notification:setIconColor3(Color3.new(255,255,255))
this command is optional.
notification:setAudio(audio:boolean|number|string)
sets the audio that plays when the notification appears.
- available values: true/false, AssetId, Asset URL
true/false will use premade audio that matches the selected icon, if the icon is also premade. otherwise, nothing will play.
EXAMPLE USAGE:
notification:setAudio(false)
-- or --
notification:setAudio("information")
-- or --
notification:setAudio(12276279019)
-- or --
notification:setAudio("http://www.roblox.com/asset/?id=12276279019")
this command is optional, but recommended.
notification:notify()
uses the created notification instance to finally create the notification with all of the settings you specified using the above commands, and show it to the player.
EXAMPLE USAGE:
notification:notify()
DEFAULTS
the “notifiiedV3.defaults” folder
the defaults folder is used in case you want to specify your own defaults for when settings are not entered (for example, you didn’t use notification:setIcon(), and you want to at least make sure the icon it defaults back to is the most likely icon to be chosen.)
below is the instructions on how you can configure defaults. it’s highly recommended to read through the API first so you understand what you’re doing.
audio
- folder contains three values:
bool,str, andnum, representing audio settings. - you can choose the type of the default you enter as one of those three values.
- keep in mind, only one of those values in the
defaults.audiofolder can have a value.
broadcast
- folder contains three boolvalues:
local,localServer,globalrepresenting broadcast settings. - you can choose the type of the default you enter as one of those three values.
- keep in mind, only one of those values in the
defaults.audiofolder can be ticked (have atruevalue).
icon
- folder contains a default for icon color, and also defaults for the icon itself.
- for the icon itself, you can choose between a numbervalue or a stringvalue.
- keep in mind, only one of those values (numbervalue and stringvalue) can have a value.
text
- contains two values:
textandcolor, representing text settings. - text is a default text value for if you don’t enter any text value using
:setText() - color is a default value for if you don’t enter any color value using
setTextColor3()
ui_mode
- contains two boolvalues:
darkandlight, representing default ui modes. - keep in mind, only one of those values in the
defaults.ui_modefolder can be ticked (have atruevalue).
animTime
the animation time for showing/hiding notifications.
loadingAnim
whether to display a loading animation for unloaded icon images.
verbose
whether the module is verbose by default (:silenceWarnings())
visibleTime
the amount of time a notification remains visible.
FIN
omg finally finished writing allat i can breathe
hey if u seeing this pls go check out other stuff i made/make
past notifiied versions
v1: Simplynotifiied v1 | the simplest and cleanest animated notification module on roblox
v2: Simplynotifiiedv2 â—Ź a clean, flexible notification module