Customizable UI to replace Roblox's default for ProximityPrompt instances.
This is a fork of an older proximity prompt system previously written with Fusion 0.2. Some changes that were made to this version include:
- Swapping from Fusion 0.2 to Seam, which has faster performance, scopability, and more
- A configuration dictionary, allowing you to change basic properties for animation and appearance easily
- A myriad of bug fixes and stability improvements
- Portability, making it a module instead of a script
- And more!
As of right now it has a similar structure behind-the-scenes as the previous script, but this module will be the one that gets updates, including updates to configuration, backend, and more.
You can install this from Wally or releases.
To get this working, simply insert it into your game, require it on the client, and call Init()!
ExpressivePrompts comes with lots of config options, listed below:
-- Since v1.0.0
Config.BackgroundTransparency number -- The background transparency
Config.BackgroundColor Color3 -- The background color
Config.TextColor Color3 -- The text and icon color
Config.SubTextColor Color3 -- The sub text color
Config.CornerRadius number -- The corner radius on the main background
Config.MainSizeSpringSpeed number -- The spring speed for the main size animation
Config.MainSizeSpringDampening number -- The spring dampening for the main size animation
Config.MainRotationSpringSpeed number -- The spring speed for the main rotation animation
Config.MainRotationSpringDampening number -- The spring dampening for the main rotation animation
Config.MainRotationStrength number -- How far the main frame can rotate
Config.AspectRatioSpringSpeed number -- The spring speed for the aspect ratio animation
Config.AspectRatioSpringDampening number -- The spring dampening for the aspect ratio animation
Config.ProgressBarYScale number -- The Y scale (0-1) of the progress bar size
Config.ProgressBarColor -- The color of the progress bar
Config.ProgressBarTransparency number -- The transparency of the progress bar
Config.ShowShimmer boolean -- Whether the shimmer effect plays when the prompt appears
Config.GuiOffsetSpringSpeed number -- The spring speed for the BillboardGui animation
Config.GuiOffsetSpringDampening number -- The spring dampening for the BillboardGui animation
-- Since v1.1.0
Config.PromptHeight number -- The offset height for the prompt
Config.PromptWidth number -- The offset width for the prompt
Config.TextPaddingLeft number -- The offset padding left to the text
Config.ActionTextSize number -- The text size of the action text
Config.ObjectTextSize number -- The text size of the object text
Config.ActionTextFont Enum.Font -- The text font of the action text
Config.ObjectTextFont Enum.Font -- The text font of the object text
Config.ActionTextYOffset number -- The Y offset separating the text labels
Config.MiddlePadding number -- The middle padding offset between elements
Config.AppearSoundId string -- The sound id for the appear sound
Config.ClickSoundId string -- The sound id for the click sound
Config.HoldSoundId string -- The sound id for the hold sound
Config.TriggerSoundId string -- The sound id for the hold trigger sound
Config.SoundVolume number -- The volume of the prompt sounds