Skip to main content

ExpressivePrompts

Customizable UI that replaces the default for ProximityPrompt instances.

Below are the config entries:

-- 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

Functions​

Init​

</>
ExpressivePrompts.Init() → ()

Initializes ExpressivePrompts. Call only one time.

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes ExpressivePrompts. Call only one time.",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 325,
                "path": "src/Packages/_Index/miagobble_expressive-prompts@1.1.0/expressive-prompts/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ExpressivePrompts",
    "desc": "Customizable UI that replaces the default for ProximityPrompt instances.\n\nBelow are the config entries:\n\n```\n-- Since v1.0.0\nConfig.BackgroundTransparency number -- The background transparency\nConfig.BackgroundColor Color3 -- The background color\nConfig.TextColor Color3 -- The text and icon color\nConfig.SubTextColor Color3 -- The sub text color\nConfig.CornerRadius number -- The corner radius on the main background\nConfig.MainSizeSpringSpeed number -- The spring speed for the main size animation\nConfig.MainSizeSpringDampening number -- The spring dampening for the main size animation\nConfig.MainRotationSpringSpeed number -- The spring speed for the main rotation animation\nConfig.MainRotationSpringDampening number -- The spring dampening for the main rotation animation\nConfig.MainRotationStrength number -- How far the main frame can rotate\nConfig.AspectRatioSpringSpeed number -- The spring speed for the aspect ratio animation\nConfig.AspectRatioSpringDampening number -- The spring dampening for the aspect ratio animation\nConfig.ProgressBarYScale number -- The Y scale (0-1) of the progress bar size\nConfig.ProgressBarColor -- The color of the progress bar\nConfig.ProgressBarTransparency number -- The transparency of the progress bar\nConfig.ShowShimmer boolean -- Whether the shimmer effect plays when the prompt appears\nConfig.GuiOffsetSpringSpeed number -- The spring speed for the BillboardGui animation\nConfig.GuiOffsetSpringDampening number -- The spring dampening for the BillboardGui animation\n\n-- Since v1.1.0\nConfig.PromptHeight number -- The offset height for the prompt\nConfig.PromptWidth number -- The offset width for the prompt\nConfig.TextPaddingLeft number -- The offset padding left to the text\nConfig.ActionTextSize number -- The text size of the action text\nConfig.ObjectTextSize number -- The text size of the object text\nConfig.ActionTextFont Enum.Font -- The text font of the action text\nConfig.ObjectTextFont Enum.Font -- The text font of the object text\nConfig.ActionTextYOffset number -- The Y offset separating the text labels\nConfig.MiddlePadding number -- The middle padding offset between elements\nConfig.AppearSoundId string -- The sound id for the appear sound\nConfig.ClickSoundId string -- The sound id for the click sound\nConfig.HoldSoundId string -- The sound id for the hold sound\nConfig.TriggerSoundId string -- The sound id for the hold trigger sound\nConfig.SoundVolume number -- The volume of the prompt sounds\n```",
    "source": {
        "line": 46,
        "path": "src/Packages/_Index/miagobble_expressive-prompts@1.1.0/expressive-prompts/init.luau"
    }
}