Proximity Prompt Customizer

BitwiseAndrea · February 11, 2022, 5:32am

ProximmityPromptCustomizerIconTransparent

Do you love proximity prompts? Do you wish it was easier to customize them?? Say no more.

Introducing the Proximity Prompt Customizer

It supports everything from basic customization…

… to advanced customization!

Just follow the following steps.

Clone the model into your workspace
Move ProximityPromptScript into StarterPlayerScripts
Set a ProximityPrompt's style to Custom

image1064×62 8.11 KB
Modify the default prompt provided as a child of ProximityPromptScript to your liking

And voila! You should see the changes you’ve made immediately reflected in game

Themes are also supported!

Clone the default proximity prompt and rename it to the name of your theme
On your ProximityPrompt instance, add a string attribute called Theme, and set the value to the themes name.

image1074×108 11.6 KB

And your prompts will be properly themified

Here is a copy of the readme provided with the model - it repeats whats said above but with a bit more information and an FAQs section!

Welcome to the Proximity Prompt Customizer
This is a free model that make it easier to customize Proximity Prompts within any experience.

The code is adapted from the sample provided here:
ProximityPrompt.Style ¹

Intro

To get started with this model, follow the following steps:

Place ProximityPromptScript in StarterPlayerScripts.
Set one of your ProximityPrompt instances to have a Style of Custom.²
Expand the Default BillboardGui that is a child of ProximityPromptScript. This is the default prompt UI. Feel free to look around. Don’t remove or rename any elements though - this risks breaking the script. If you want to hide something, make the element fully transparent.
As a test, modify the background color of the PromptFrame.
Press Play You should now see the ProximityPrompt you set to have a Style of Custom
with a different background color.

And there you go! Customize away.³ Once again do NOT remove any of these elements from the prompt - the script will break on removal of most of them. Adding elements is fine⁴ - make sure the names don’t conflict with existing ones though ‍

Theming

If you would like to make any prompts in your experience have a different theme, duplicate the Default BillboardGui and rename it to the name of your theme. On the ProximityPrompt object, add a Theme attribute of type String that matches this theme’s name. The script will prefer the BillboardGui object with a matching name over the default

FAQs

Q: How do I get the default UI back
A: If you need to grab the default prompt again for whatever reason, I have it uploaded here for easy cloning: Default Proximity Prompt - Roblox

Q: The circular progress bar isn’t showing – where’d it go
A: Does your ProximityPrompt have a HoldDuration of 0? HoldDuration must be set to a value > 0 for the progress bar to show.

Q: Whats the difference between ButtonText/ButtonImage/ButtonTextImage
A: They are used for different input modes
- Gamepad inputs use ButtonTextImage, with the image set to an icon corresponding to the input.
- Touch inputs use ButtonImage, with the image set to an icon of a pointer.
- Keyboard inputs use ButtonImage along with either ButtonText or ButtonTextImage, depending on what the KeyboardKeyCode in each prompt is set to. If it’s something like a Shift key, it will use ButtonTextImage to display an ⇧, and the ButtonImage is used to display the keyboard key outline. If it’s a key that can be rendered just using text, it will use ButtonText.

Excited to see what y’all make
~ Bitwise (@BitwiseAndrea)

_{¹ The main changes from the script are some element renaming, swapping out a few Frames for ImageLabels to support image backgrounds, and (mostly) fixing an inconsistency between the code sample and the behavior of the default ProximityPrompt UI.}
_{² Custom is what indicates to the ProximityPromptScript to provide alternative UI to the default. ProximityPromptStyle}
_{³ Hate having to move UI elements into PlayerGui to see preview them? Check out my UI Previewer plugin. https://www.roblox.com/catalog/library/UI-Previewer}
_{⁴ Any child of the PromptFrame, ActionText, or ObjectText will be tweened out with it’s parent. Children of other elements (like the InputFrame or any stuff around the Button) aren’t currently supported, but if theres a strong use case, it can be added!}

Check it out here

If you have any feature requests or feedback, please share in the comments

ValiantWind · February 11, 2022, 7:12am

Wow! This looks amazing! I can’t wait to try this out!

Dev_Simphony · February 11, 2022, 7:25am

Looks pretty cool!! I myself was never really a fan of the proximity prompt because of the looks of it. I always made my own custom prompt script so I got the look I wanted. But now that I can customizing it is easily I might just check it out.

Dan_foodz · February 11, 2022, 4:55pm

This looks cool, Keep up the great work!

heisIlan · February 11, 2022, 5:12pm

Awesome!

I’m working on an UNDERTALE themed game and I use a lot of proximity prompts and I was searching for an efficient way of editing them, this is absolutely perfect!

It looks easy to use and I’m sure it will help a lot of peoples including me.

Keep up the good work!

Foxxive · February 11, 2022, 5:25pm

absolutely amazing! i am going to enjoy playing around with this!

Eotecc · February 11, 2022, 11:06pm

Looks cool! Will try this out!

vvv331 · March 12, 2022, 7:06pm

I’m surprised this is barely mentioned, because it does let you do lots of things with it

pyxfluff · March 31, 2022, 8:06pm

Thank you for all of your helpful resources!

mekboy21 · August 22, 2022, 10:14am

I know it’s late to revive a topic like this, but I have to say thank you, @BitwiseAndrea, this is so much easier and I have used it to create custom proximity prompts for my game!

SomeFedoraGuy · September 14, 2022, 10:01am

Thank you for the amazing resource! I didn’t use it but I took some methods to create my own!

Bitterman1021 · September 23, 2022, 12:54am

Hello! Great resource! I did come across an issue that I am unsure of how to fix. I edited the default style to look like this:

But when I try it in-game it does this for some reason:

Just kinda flickers for a second and then it disappears.

Explorer:

Everything except what’s circled in red is fully transparent.

Sorry for the trouble

2jammers · September 23, 2022, 1:02am

Great job! It really brings the prompt to life, rather than the boring modern style.

TeamDreams123 · September 24, 2022, 8:13am

Definitely downloading this, it really looks helpful!

Nabilekes · October 2, 2022, 6:55pm

not working for me. Does anyone have a video tutorial on this?

IceCreamPickels · October 14, 2022, 2:03am

how would i be able to do advance customization?

RenanMSV · October 29, 2022, 5:29am

For some reason it sometimes doesnt scale correctly. The function updateUIFromPrompt sometimes make text appear out of the proximity box.

Step to reproduce: Set object text to something large.

But for small texts it works perfectly!

Also If I manually make a copy of a default ProximityPrompt generated by Roblox it has different naming and different childs layout from the default prompt you provide.

BitwiseAndrea · October 30, 2022, 9:32pm

The one from Roblox and mine differ because recently I updated the Roblox one to work with automatic size And i’m working on making a v2 of this to handle that. Just need a bit of free time. Once i finish that your problem should be solved.

francis_70 · November 1, 2022, 2:43pm

It doesn’t work…

PosFind · November 2, 2022, 11:02am

this has been happening ever since the new font update… really restricting because i can’t use special fonts in my custom proximityprompts anymore.