Usage
Note: Everything must be done from the Server, through ServerScriptService
:Init()
Server Script
This is required in order to initialize the Overhead UI Module.
:GiveOverhead(args)
Server Script
This creates the base of the Overhead UI. This will give the player the UI whenever their character spawns in.
:GiveBadge(plr, badgeName, badgeId)
Server Script
This will give the player a "badge" or an overhead icon.
Plr is the player instance.
badgeName is the name the badge will be given.
badgeId is the image id of the badge.
:RemoveBadge(plr, badgeName)
Server Script
:SetName(plr, name, nameColor)
Server Script
:SetRank(plr, rank, rankColor)
Server Script
:SetSpecialRank(plr, rank, rankColor)
Server Script
The :Set
will only work if they player already has an OverheadUI, if not it will not work.
Last updated