ProximityPrompt

顯示已棄用項目

*此內容是使用 AI（Beta 測試版）翻譯，可能含有錯誤。若要以英文檢視此頁面，請按一下這裡。

ProximityPrompt 實例讓您提示玩家與 3D 世界中的對象互動，例如打開門或拿起物道具。當 ProximityPrompt 、BasePart

提示由三個主要元素組成，每個元素都可以由注意到的屬性控制。預設 UI 可以被交換為您自己的自訂外觀，如在 Style 中所述。


<tbody>
  <tr>
    <td><code>Class.ProximityPrompt.ObjectText|ObjectText</code></td>
    <td>一個可選的名稱以與對象互動。</td>

    <td />
  </tr>

  <tr>
    <td><code>Class.ProximityPrompt.ActionText|ActionText</code></td>
    <td>一個可選的動作名稱顯示給玩家。</td>
    <td>互動</td>
  </tr>

  <tr>
    <td><code>Class.ProximityPrompt.KeyboardKeyCode|KeyboardKeyCode</code></td>
    <td>會啟動提示的鍵盤按鍵。</td>
    <td>E</td>
  </tr>

  <tr>
    <td><code>Class.ProximityPrompt.GamepadKeyCode|GamepadKeyCode</code></td>
    <td>會啟動提示的遊戲控制器按鈕。</td>
    <td>按鈕X</td>
  </tr>
</tbody>

屬性	說明	預設

您可以連接到接近提示事件，例如在 ProximityPrompt 對象上或在全球通過 ProximityPromptService 。 ProximityPromptService 允許您管理所有接近提示行為從一個地點，防止任何需要重複代碼的體驗。

有關接近提示的更多資訊，請參閱接近提示指南。

範例程式碼

Using a Proximity Prompt with a Seat

local proximityPrompt = script.Parent
local seat = proximityPrompt.Parent.Seat

seat:GetPropertyChangedSignal("Occupant"):Connect(function()
	if seat.Occupant then
		proximityPrompt.Enabled = false
	else
		proximityPrompt.Enabled = true
	end
end)

proximityPrompt.Triggered:Connect(function(player)
	seat:Sit(player.Character.Humanoid)
end)

Generating a Custom Proximity Prompt

local UserInputService = game:GetService("UserInputService")
local ProximityPromptService = game:GetService("ProximityPromptService")
local TweenService = game:GetService("TweenService")
local TextService = game:GetService("TextService")
local Players = game:GetService("Players")

local LocalPlayer = Players.LocalPlayer

local PlayerGui = LocalPlayer:WaitForChild("PlayerGui")

local GamepadButtonImage = {
	[Enum.KeyCode.ButtonX] = "rbxasset://textures/ui/Controls/xboxX.png",
	[Enum.KeyCode.ButtonY] = "rbxasset://textures/ui/Controls/xboxY.png",
	[Enum.KeyCode.ButtonA] = "rbxasset://textures/ui/Controls/xboxA.png",
	[Enum.KeyCode.ButtonB] = "rbxasset://textures/ui/Controls/xboxB.png",
	[Enum.KeyCode.DPadLeft] = "rbxasset://textures/ui/Controls/dpadLeft.png",
	[Enum.KeyCode.DPadRight] = "rbxasset://textures/ui/Controls/dpadRight.png",
	[Enum.KeyCode.DPadUp] = "rbxasset://textures/ui/Controls/dpadUp.png",
	[Enum.KeyCode.DPadDown] = "rbxasset://textures/ui/Controls/dpadDown.png",
	[Enum.KeyCode.ButtonSelect] = "rbxasset://textures/ui/Controls/xboxView.png",
	[Enum.KeyCode.ButtonStart] = "rbxasset://textures/ui/Controls/xboxmenu.png",
	[Enum.KeyCode.ButtonL1] = "rbxasset://textures/ui/Controls/xboxLB.png",
	[Enum.KeyCode.ButtonR1] = "rbxasset://textures/ui/Controls/xboxRB.png",
	[Enum.KeyCode.ButtonL2] = "rbxasset://textures/ui/Controls/xboxLT.png",
	[Enum.KeyCode.ButtonR2] = "rbxasset://textures/ui/Controls/xboxRT.png",
	[Enum.KeyCode.ButtonL3] = "rbxasset://textures/ui/Controls/xboxLS.png",
	[Enum.KeyCode.ButtonR3] = "rbxasset://textures/ui/Controls/xboxRS.png",
	[Enum.KeyCode.Thumbstick1] = "rbxasset://textures/ui/Controls/xboxLSDirectional.png",
	[Enum.KeyCode.Thumbstick2] = "rbxasset://textures/ui/Controls/xboxRSDirectional.png",
}

local KeyboardButtonImage = {
	[Enum.KeyCode.Backspace] = "rbxasset://textures/ui/Controls/backspace.png",
	[Enum.KeyCode.Return] = "rbxasset://textures/ui/Controls/return.png",
	[Enum.KeyCode.LeftShift] = "rbxasset://textures/ui/Controls/shift.png",
	[Enum.KeyCode.RightShift] = "rbxasset://textures/ui/Controls/shift.png",
	[Enum.KeyCode.Tab] = "rbxasset://textures/ui/Controls/tab.png",
}

local KeyboardButtonIconMapping = {
	["'"] = "rbxasset://textures/ui/Controls/apostrophe.png",
	[","] = "rbxasset://textures/ui/Controls/comma.png",
	["`"] = "rbxasset://textures/ui/Controls/graveaccent.png",
	["."] = "rbxasset://textures/ui/Controls/period.png",
	[" "] = "rbxasset://textures/ui/Controls/spacebar.png",
}

local KeyCodeToTextMapping = {
	[Enum.KeyCode.LeftControl] = "Ctrl",
	[Enum.KeyCode.RightControl] = "Ctrl",
	[Enum.KeyCode.LeftAlt] = "Alt",
	[Enum.KeyCode.RightAlt] = "Alt",
	[Enum.KeyCode.F1] = "F1",
	[Enum.KeyCode.F2] = "F2",
	[Enum.KeyCode.F3] = "F3",
	[Enum.KeyCode.F4] = "F4",
	[Enum.KeyCode.F5] = "F5",
	[Enum.KeyCode.F6] = "F6",
	[Enum.KeyCode.F7] = "F7",
	[Enum.KeyCode.F8] = "F8",
	[Enum.KeyCode.F9] = "F9",
	[Enum.KeyCode.F10] = "F10",
	[Enum.KeyCode.F11] = "F11",
	[Enum.KeyCode.F12] = "F12",
}

local function getScreenGui()
	local screenGui = PlayerGui:FindFirstChild("ProximityPrompts")
	if screenGui == nil then
		screenGui = Instance.new("ScreenGui")
		screenGui.Name = "ProximityPrompts"
		screenGui.ResetOnSpawn = false
		screenGui.Parent = PlayerGui
	end
	return screenGui
end

local function createProgressBarGradient(parent, leftSide)
	local frame = Instance.new("Frame")
	frame.Size = UDim2.fromScale(0.5, 1)
	frame.Position = UDim2.fromScale(leftSide and 0 or 0.5, 0)
	frame.BackgroundTransparency = 1
	frame.ClipsDescendants = true
	frame.Parent = parent

	local image = Instance.new("ImageLabel")
	image.BackgroundTransparency = 1
	image.Size = UDim2.fromScale(2, 1)
	image.Position = UDim2.fromScale(leftSide and 0 or -1, 0)
	image.Image = "rbxasset://textures/ui/Controls/RadialFill.png"
	image.Parent = frame

	local gradient = Instance.new("UIGradient")
	gradient.Transparency = NumberSequence.new({
		NumberSequenceKeypoint.new(0, 0),
		NumberSequenceKeypoint.new(0.4999, 0),
		NumberSequenceKeypoint.new(0.5, 1),
		NumberSequenceKeypoint.new(1, 1),
	})
	gradient.Rotation = leftSide and 180 or 0
	gradient.Parent = image

	return gradient
end

local function createCircularProgressBar()
	local bar = Instance.new("Frame")
	bar.Name = "CircularProgressBar"
	bar.Size = UDim2.fromOffset(58, 58)
	bar.AnchorPoint = Vector2.new(0.5, 0.5)
	bar.Position = UDim2.fromScale(0.5, 0.5)
	bar.BackgroundTransparency = 1

	local gradient1 = createProgressBarGradient(bar, true)
	local gradient2 = createProgressBarGradient(bar, false)

	local progress = Instance.new("NumberValue")
	progress.Name = "Progress"
	progress.Parent = bar
	progress.Changed:Connect(function(value)
		local angle = math.clamp(value * 360, 0, 360)
		gradient1.Rotation = math.clamp(angle, 180, 360)
		gradient2.Rotation = math.clamp(angle, 0, 180)
	end)

	return bar
end

local function createPrompt(prompt, inputType, gui)
	local tweensForButtonHoldBegin = {}
	local tweensForButtonHoldEnd = {}
	local tweensForFadeOut = {}
	local tweensForFadeIn = {}
	local tweenInfoInFullDuration = TweenInfo.new(
		prompt.HoldDuration,
		Enum.EasingStyle.Linear,
		Enum.EasingDirection.Out
	)
	local tweenInfoOutHalfSecond = TweenInfo.new(0.5, Enum.EasingStyle.Quad, Enum.EasingDirection.Out)
	local tweenInfoFast = TweenInfo.new(0.2, Enum.EasingStyle.Quad, Enum.EasingDirection.Out)
	local tweenInfoQuick = TweenInfo.new(0.06, Enum.EasingStyle.Linear, Enum.EasingDirection.Out)

	local promptUI = Instance.new("BillboardGui")
	promptUI.Name = "Prompt"
	promptUI.AlwaysOnTop = true

	local frame = Instance.new("Frame")
	frame.Size = UDim2.fromScale(0.5, 1)
	frame.BackgroundTransparency = 1
	frame.BackgroundColor3 = Color3.new(0.07, 0.07, 0.07)
	frame.Parent = promptUI

	local roundedCorner = Instance.new("UICorner")
	roundedCorner.Parent = frame

	local inputFrame = Instance.new("Frame")
	inputFrame.Name = "InputFrame"
	inputFrame.Size = UDim2.fromScale(1, 1)
	inputFrame.BackgroundTransparency = 1
	inputFrame.SizeConstraint = Enum.SizeConstraint.RelativeYY
	inputFrame.Parent = frame

	local resizeableInputFrame = Instance.new("Frame")
	resizeableInputFrame.Size = UDim2.fromScale(1, 1)
	resizeableInputFrame.Position = UDim2.fromScale(0.5, 0.5)
	resizeableInputFrame.AnchorPoint = Vector2.new(0.5, 0.5)
	resizeableInputFrame.BackgroundTransparency = 1
	resizeableInputFrame.Parent = inputFrame

	local inputFrameScaler = Instance.new("UIScale")
	inputFrameScaler.Parent = resizeableInputFrame

	local inputFrameScaleFactor = inputType == Enum.ProximityPromptInputType.Touch and 1.6 or 1.33
	table.insert(
		tweensForButtonHoldBegin,
		TweenService:Create(inputFrameScaler, tweenInfoFast, { Scale = inputFrameScaleFactor })
	)
	table.insert(tweensForButtonHoldEnd, TweenService:Create(inputFrameScaler, tweenInfoFast, { Scale = 1 }))

	local actionText = Instance.new("TextLabel")
	actionText.Name = "ActionText"
	actionText.Size = UDim2.fromScale(1, 1)
	actionText.Font = Enum.Font.GothamMedium
	actionText.TextSize = 19
	actionText.BackgroundTransparency = 1
	actionText.TextTransparency = 1
	actionText.TextColor3 = Color3.new(1, 1, 1)
	actionText.TextXAlignment = Enum.TextXAlignment.Left
	actionText.Parent = frame
	table.insert(tweensForButtonHoldBegin, TweenService:Create(actionText, tweenInfoFast, { TextTransparency = 1 }))
	table.insert(tweensForButtonHoldEnd, TweenService:Create(actionText, tweenInfoFast, { TextTransparency = 0 }))
	table.insert(tweensForFadeOut, TweenService:Create(actionText, tweenInfoFast, { TextTransparency = 1 }))
	table.insert(tweensForFadeIn, TweenService:Create(actionText, tweenInfoFast, { TextTransparency = 0 }))

	local objectText = Instance.new("TextLabel")
	objectText.Name = "ObjectText"
	objectText.Size = UDim2.fromScale(1, 1)
	objectText.Font = Enum.Font.GothamMedium
	objectText.TextSize = 14
	objectText.BackgroundTransparency = 1
	objectText.TextTransparency = 1
	objectText.TextColor3 = Color3.new(0.7, 0.7, 0.7)
	objectText.TextXAlignment = Enum.TextXAlignment.Left
	objectText.Parent = frame

	table.insert(tweensForButtonHoldBegin, TweenService:Create(objectText, tweenInfoFast, { TextTransparency = 1 }))
	table.insert(tweensForButtonHoldEnd, TweenService:Create(objectText, tweenInfoFast, { TextTransparency = 0 }))
	table.insert(tweensForFadeOut, TweenService:Create(objectText, tweenInfoFast, { TextTransparency = 1 }))
	table.insert(tweensForFadeIn, TweenService:Create(objectText, tweenInfoFast, { TextTransparency = 0 }))

	table.insert(
		tweensForButtonHoldBegin,
		TweenService:Create(frame, tweenInfoFast, { Size = UDim2.fromScale(0.5, 1), BackgroundTransparency = 1 })
	)
	table.insert(
		tweensForButtonHoldEnd,
		TweenService:Create(frame, tweenInfoFast, { Size = UDim2.fromScale(1, 1), BackgroundTransparency = 0.2 })
	)
	table.insert(
		tweensForFadeOut,
		TweenService:Create(frame, tweenInfoFast, { Size = UDim2.fromScale(0.5, 1), BackgroundTransparency = 1 })
	)
	table.insert(
		tweensForFadeIn,
		TweenService:Create(frame, tweenInfoFast, { Size = UDim2.fromScale(1, 1), BackgroundTransparency = 0.2 })
	)

	local roundFrame = Instance.new("Frame")
	roundFrame.Name = "RoundFrame"
	roundFrame.Size = UDim2.fromOffset(48, 48)

	roundFrame.AnchorPoint = Vector2.new(0.5, 0.5)
	roundFrame.Position = UDim2.fromScale(0.5, 0.5)
	roundFrame.BackgroundTransparency = 1
	roundFrame.Parent = resizeableInputFrame

	local roundedFrameCorner = Instance.new("UICorner")
	roundedFrameCorner.CornerRadius = UDim.new(0.5, 0)
	roundedFrameCorner.Parent = roundFrame

	table.insert(tweensForFadeOut, TweenService:Create(roundFrame, tweenInfoQuick, { BackgroundTransparency = 1 }))
	table.insert(tweensForFadeIn, TweenService:Create(roundFrame, tweenInfoQuick, { BackgroundTransparency = 0.5 }))

	if inputType == Enum.ProximityPromptInputType.Gamepad then
		if GamepadButtonImage[prompt.GamepadKeyCode] then
			local icon = Instance.new("ImageLabel")
			icon.Name = "ButtonImage"
			icon.AnchorPoint = Vector2.new(0.5, 0.5)
			icon.Size = UDim2.fromOffset(24, 24)
			icon.Position = UDim2.fromScale(0.5, 0.5)
			icon.BackgroundTransparency = 1
			icon.ImageTransparency = 1
			icon.Image = GamepadButtonImage[prompt.GamepadKeyCode]
			icon.Parent = resizeableInputFrame
			table.insert(tweensForFadeOut, TweenService:Create(icon, tweenInfoQuick, { ImageTransparency = 1 }))
			table.insert(tweensForFadeIn, TweenService:Create(icon, tweenInfoQuick, { ImageTransparency = 0 }))
		end
	elseif inputType == Enum.ProximityPromptInputType.Touch then
		local buttonImage = Instance.new("ImageLabel")
		buttonImage.Name = "ButtonImage"
		buttonImage.BackgroundTransparency = 1
		buttonImage.ImageTransparency = 1
		buttonImage.Size = UDim2.fromOffset(25, 31)
		buttonImage.AnchorPoint = Vector2.new(0.5, 0.5)
		buttonImage.Position = UDim2.fromScale(0.5, 0.5)
		buttonImage.Image = "rbxasset://textures/ui/Controls/TouchTapIcon.png"
		buttonImage.Parent = resizeableInputFrame

		table.insert(tweensForFadeOut, TweenService:Create(buttonImage, tweenInfoQuick, { ImageTransparency = 1 }))
		table.insert(tweensForFadeIn, TweenService:Create(buttonImage, tweenInfoQuick, { ImageTransparency = 0 }))
	else
		local buttonImage = Instance.new("ImageLabel")
		buttonImage.Name = "ButtonImage"
		buttonImage.BackgroundTransparency = 1
		buttonImage.ImageTransparency = 1
		buttonImage.Size = UDim2.fromOffset(28, 30)
		buttonImage.AnchorPoint = Vector2.new(0.5, 0.5)
		buttonImage.Position = UDim2.fromScale(0.5, 0.5)
		buttonImage.Image = "rbxasset://textures/ui/Controls/key_single.png"
		buttonImage.Parent = resizeableInputFrame
		table.insert(tweensForFadeOut, TweenService:Create(buttonImage, tweenInfoQuick, { ImageTransparency = 1 }))
		table.insert(tweensForFadeIn, TweenService:Create(buttonImage, tweenInfoQuick, { ImageTransparency = 0 }))

		local buttonTextString = UserInputService:GetStringForKeyCode(prompt.KeyboardKeyCode)

		local buttonTextImage = KeyboardButtonImage[prompt.KeyboardKeyCode]
		if buttonTextImage == nil then
			buttonTextImage = KeyboardButtonIconMapping[buttonTextString]
		end

		if buttonTextImage == nil then
			local keyCodeMappedText = KeyCodeToTextMapping[prompt.KeyboardKeyCode]
			if keyCodeMappedText then
				buttonTextString = keyCodeMappedText
			end
		end

		if buttonTextImage then
			local icon = Instance.new("ImageLabel")
			icon.Name = "ButtonImage"
			icon.AnchorPoint = Vector2.new(0.5, 0.5)
			icon.Size = UDim2.fromOffset(36, 36)
			icon.Position = UDim2.fromScale(0.5, 0.5)
			icon.BackgroundTransparency = 1
			icon.ImageTransparency = 1
			icon.Image = buttonTextImage
			icon.Parent = resizeableInputFrame
			table.insert(tweensForFadeOut, TweenService:Create(icon, tweenInfoQuick, { ImageTransparency = 1 }))
			table.insert(tweensForFadeIn, TweenService:Create(icon, tweenInfoQuick, { ImageTransparency = 0 }))
		elseif buttonTextString ~= nil and buttonTextString ~= "" then
			local buttonText = Instance.new("TextLabel")
			buttonText.Name = "ButtonText"
			buttonText.Position = UDim2.fromOffset(0, -1)
			buttonText.Size = UDim2.fromScale(1, 1)
			buttonText.Font = Enum.Font.GothamMedium
			buttonText.TextSize = 14
			if string.len(buttonTextString) > 2 then
				buttonText.TextSize = 12
			end
			buttonText.BackgroundTransparency = 1
			buttonText.TextTransparency = 1
			buttonText.TextColor3 = Color3.new(1, 1, 1)
			buttonText.TextXAlignment = Enum.TextXAlignment.Center
			buttonText.Text = buttonTextString
			buttonText.Parent = resizeableInputFrame
			table.insert(tweensForFadeOut, TweenService:Create(buttonText, tweenInfoQuick, { TextTransparency = 1 }))
			table.insert(tweensForFadeIn, TweenService:Create(buttonText, tweenInfoQuick, { TextTransparency = 0 }))
		else
			error(
				"ProximityPrompt '"
					.. prompt.Name
					.. "' has an unsupported keycode for rendering UI: "
					.. tostring(prompt.KeyboardKeyCode)
			)
		end
	end

	if inputType == Enum.ProximityPromptInputType.Touch or prompt.ClickablePrompt then
		local button = Instance.new("TextButton")
		button.BackgroundTransparency = 1
		button.TextTransparency = 1
		button.Size = UDim2.fromScale(1, 1)
		button.Parent = promptUI

		local buttonDown = false

		button.InputBegan:Connect(function(input)
			if
				(
					input.UserInputType == Enum.UserInputType.Touch
					or input.UserInputType == Enum.UserInputType.MouseButton1
				) and input.UserInputState ~= Enum.UserInputState.Change
			then
				prompt:InputHoldBegin()
				buttonDown = true
			end
		end)
		button.InputEnded:Connect(function(input)
			if
				input.UserInputType == Enum.UserInputType.Touch
				or input.UserInputType == Enum.UserInputType.MouseButton1
			then
				if buttonDown then
					buttonDown = false
					prompt:InputHoldEnd()
				end
			end
		end)

		promptUI.Active = true
	end

	if prompt.HoldDuration > 0 then
		local circleBar = createCircularProgressBar()
		circleBar.Parent = resizeableInputFrame
		table.insert(
			tweensForButtonHoldBegin,
			TweenService:Create(circleBar.Progress, tweenInfoInFullDuration, { Value = 1 })
		)
		table.insert(
			tweensForButtonHoldEnd,
			TweenService:Create(circleBar.Progress, tweenInfoOutHalfSecond, { Value = 0 })
		)
	end

	local holdBeganConnection
	local holdEndedConnection
	local triggeredConnection
	local triggerEndedConnection

	if prompt.HoldDuration > 0 then
		holdBeganConnection = prompt.PromptButtonHoldBegan:Connect(function()
			for _, tween in ipairs(tweensForButtonHoldBegin) do
				tween:Play()
			end
		end)

		holdEndedConnection = prompt.PromptButtonHoldEnded:Connect(function()
			for _, tween in ipairs(tweensForButtonHoldEnd) do
				tween:Play()
			end
		end)
	end

	triggeredConnection = prompt.Triggered:Connect(function()
		for _, tween in ipairs(tweensForFadeOut) do
			tween:Play()
		end
	end)

	triggerEndedConnection = prompt.TriggerEnded:Connect(function()
		for _, tween in ipairs(tweensForFadeIn) do
			tween:Play()
		end
	end)

	local function updateUIFromPrompt()
		-- todo: Use AutomaticSize instead of GetTextSize when that feature becomes available
		local actionTextSize = TextService:GetTextSize(
			prompt.ActionText,
			19,
			Enum.Font.GothamMedium,
			Vector2.new(1000, 1000)
		)
		local objectTextSize = TextService:GetTextSize(
			prompt.ObjectText,
			14,
			Enum.Font.GothamMedium,
			Vector2.new(1000, 1000)
		)
		local maxTextWidth = math.max(actionTextSize.X, objectTextSize.X)
		local promptHeight = 72
		local promptWidth = 72
		local textPaddingLeft = 72

		if
			(prompt.ActionText ~= nil and prompt.ActionText ~= "")
			or (prompt.ObjectText ~= nil and prompt.ObjectText ~= "")
		then
			promptWidth = maxTextWidth + textPaddingLeft + 24
		end

		local actionTextYOffset = 0
		if prompt.ObjectText ~= nil and prompt.ObjectText ~= "" then
			actionTextYOffset = 9
		end
		actionText.Position = UDim2.new(0.5, textPaddingLeft - promptWidth / 2, 0, actionTextYOffset)
		objectText.Position = UDim2.new(0.5, textPaddingLeft - promptWidth / 2, 0, -10)

		actionText.Text = prompt.ActionText
		objectText.Text = prompt.ObjectText
		actionText.AutoLocalize = prompt.AutoLocalize
		actionText.RootLocalizationTable = prompt.RootLocalizationTable

		objectText.AutoLocalize = prompt.AutoLocalize
		objectText.RootLocalizationTable = prompt.RootLocalizationTable

		promptUI.Size = UDim2.fromOffset(promptWidth, promptHeight)
		promptUI.SizeOffset = Vector2.new(
			prompt.UIOffset.X / promptUI.Size.Width.Offset,
			prompt.UIOffset.Y / promptUI.Size.Height.Offset
		)
	end

	local changedConnection = prompt.Changed:Connect(updateUIFromPrompt)
	updateUIFromPrompt()

	promptUI.Adornee = prompt.Parent
	promptUI.Parent = gui

	for _, tween in ipairs(tweensForFadeIn) do
		tween:Play()
	end

	local function cleanup()
		if holdBeganConnection then
			holdBeganConnection:Disconnect()
		end

		if holdEndedConnection then
			holdEndedConnection:Disconnect()
		end

		triggeredConnection:Disconnect()
		triggerEndedConnection:Disconnect()
		changedConnection:Disconnect()

		for _, tween in ipairs(tweensForFadeOut) do
			tween:Play()
		end

		task.wait(0.2)

		promptUI.Parent = nil
	end

	return cleanup
end

local function onLoad()
	ProximityPromptService.PromptShown:Connect(function(prompt, inputType)
		if prompt.Style == Enum.ProximityPromptStyle.Default then
			return
		end

		local gui = getScreenGui()

		local cleanupFunction = createPrompt(prompt, inputType, gui)

		prompt.PromptHidden:Wait()

		cleanupFunction()
	end)
end

onLoad()

Healing Proximity Prompt

local RunService = game:GetService("RunService")

local prompt = script.Parent

local playersHealing = {}

RunService.Stepped:Connect(function(_currentTime, deltaTime)
	for player, _value in pairs(playersHealing) do
		local humanoid = player.Character:FindFirstChildWhichIsA("Humanoid")
		if humanoid then
			humanoid.Health = humanoid.Health + 30 * deltaTime
		end
	end
end)

prompt.Triggered:Connect(function(player)
	playersHealing[player] = true
end)

prompt.TriggerEnded:Connect(function(player)
	playersHealing[player] = nil
end)

概要

屬性

ActionText:string
平行讀取
顯示給使用者的行動文字。
AutoLocalize:bool
平行讀取
提示的 ProximityPrompt.ActionText 和 ProximityPrompt.ObjectText 將在 ProximityPrompt.RootLocalizationTable 中按階地本地化。
ClickablePrompt:bool
平行讀取
提示是否可以通過點擊提示 UI 啟動。
Enabled:bool
平行讀取
是否顯示此提示。
Exclusivity:Enum.ProximityPromptExclusivity
平行讀取
用於自訂哪些提示可以顯示。
GamepadKeyCode:Enum.KeyCode
平行讀取
玩家應該按下遊戲控制器按鈕來啟動提示。
HoldDuration:number
平行讀取
玩家必須按住按鈕/鍵才能夠觸發提示。
KeyboardKeyCode:Enum.KeyCode
平行讀取
玩家應該按的鍵來啟動提示。
MaxActivationDistance:number
平行讀取
玩家的 character 最大距離可以從提示顯示的 ProximityPrompt 來顯示。
ObjectText:string
平行讀取
一個可選項，用於決定顯示給使用者的對象名稱文字。
RequiresLineOfSight:bool
平行讀取
是否隱藏提示，取決於路徑在玩家的 Camera 和對象之間的關係是否受到阻擋。
RootLocalizationTable:LocalizationTable
平行讀取
一個引用 LocalizationTable 以應用自動本地化到此提示的 ProximityPrompt.ActionText 和 ProximityPrompt.ObjectText 。
Style:Enum.ProximityPromptStyle
平行讀取
提示的 UI 風格。
UIOffset:Vector2
平行讀取
適用於提示的使用者介面的像素Offset。

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目

方法

InputHoldBegin():void
發射一個信號，表示使用者開始按提示按鈕。
InputHoldEnd():void
發射一個信號，表示使用者已結束按提示GUI按鈕。

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目

活動

PromptButtonHoldBegan(playerWhoTriggered : Player):RBXScriptSignal
啟動時，如果玩家開始按住 key /按鈕連接到有非零 ProximityPrompt.HoldDuration 的提示，則會啟動。
PromptButtonHoldEnded(playerWhoTriggered : Player):RBXScriptSignal
玩家按住按鈕時，會在提示上的按鈕上按住，ProximityPrompt.HoldDuration。
PromptHidden():RBXScriptSignal
提示變得隱藏時會觸發。
PromptShown(inputType : Enum.ProximityPromptInputType):RBXScriptSignal
在 prompt 變得可見時触發。
TriggerEnded(playerWhoTriggered : Player):RBXScriptSignal
發生在 key /按鈕釋放時，在用戶需要按住按鈕的情況下，為了更長的事件而發生。
Triggered(playerWhoTriggered : Player):RBXScriptSignal
啟動時，提示 key /按鈕或按鈕按住時間指定後，如果 ProximityPrompt.HoldDuration 是使用。

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目

屬性

ActionText

string

平行讀取

此屬性決定顯示給使用者的行動文字。

AutoLocalize

bool

平行讀取

此屬性決定提示的 ProximityPrompt.ActionText 和 ProximityPrompt.ObjectText 是否按照 ProximityPrompt.RootLocalizationTable 設定為本地化。設置為 "真" 時，將會應用本地化。

ClickablePrompt

bool

平行讀取

此屬性決定提示是否可以通過點擊提示的 UI 啟動。設為"關閉"時，提示將無法在移動設備上啟動。

Enabled

bool

平行讀取

此屬性表示要顯示或否要顯示此 ProximityPrompt 。

Exclusivity

Enum.ProximityPromptExclusivity

平行讀取

這個屬性可以自訂哪些提示可以在同一時間顯示。

GamepadKeyCode

Enum.KeyCode

平行讀取

這個屬性決定玩家應該按下的遊戲控制器按鈕。預設是 ProximityPrompt。

HoldDuration

number

平行讀取

此屬性指示玩家必須按住按鈕/鍵以啟動提示。

KeyboardKeyCode

Enum.KeyCode

平行讀取

此屬性決定玩家應該按的鍵來啟動 ProximityPrompt 。預設值是 E 。

MaxActivationDistance

number

平行讀取

此屬性確定玩家的 character 可以從 ProximityPrompt 的最大距離，以便提示出現。

ObjectText

string

平行讀取

這個可選項的屬性將用戶所看到的可選項對象名稱文字顯示為可選項。

RequiresLineOfSight

bool

平行讀取

此屬性表示是否隱藏提示，如果 Camera 和對象之間的路徑被擋塞，則提示將不會顯示。如果是，此提示只會顯示在有清晰路徑從相機到對物件之間。

提示的 Part 或 Model 將被排除在此檢查之外。

RootLocalizationTable

LocalizationTable

平行讀取

此屬性為自動本地化應用程式的參考，LocalizationTable 用於在提示的 ProximityPrompt.ActionText 和 ProximityPrompt.ObjectText 中套用自動本地化。若要套用此功能，1>Class.ProximityPrompt.AutoLocalize1> 必須設定。

開發人員可以將此設為 DataModel 中的任何時間的引用表。不需要在 LocalizationService 的子級。如果沒有可用的翻譯在參考表中尋找，它會尋找在上一個表的父級中的翻譯。如果是一個子級，則會在上一個表的先前的表中尋找。

Style

Enum.ProximityPromptStyle

平行讀取

此屬性表示提示的風格。設為「自訂」時，將不提供預設 UI。

提供的 UI 可以被交換為自訂 UI。若要這麼做，請將風格設為「自訂」。然後聽取 Class.ProximityPrompt.PromptShown 和 Class.ProximityPrompt.PromptHidden 事件在 Class.LocalScript 中，在開發人員創建並撕毀 UI 之前。

開發人員也可以使用 ProximityPrompt.PromptButtonHoldBegan 和 ProximityPrompt.PromptButtonHoldEnded 來使用 ProximityPrompt.HoldDuration 進度動畫功能。

UIOffset

Vector2

平行讀取

此屬性表示適用於提示的使用者介面的像素 Offset。

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目

方法

InputHoldBegin

void

此功能會導致發出信號，表示使用者開始按 ProximityPrompt 提示按鈕。它應該由開發人員使用，希望自訂提示並從提示 GUI 按鈕按按下。

void

InputHoldEnd

void

Class.ProximityPrompt:InputHoldBegin() 的反面，這表示使用者已經停止按下提示按鈕。

void

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目

活動

PromptButtonHoldBegan

這個事件會在玩家開始按住 key /按鈕在提示上持有非零 ProximityPrompt.HoldDuration 時。一個可能的使用包括動畫持有進度條。

參數

playerWhoTriggered: Player

開始按住提示按鈕的 Player。

PromptButtonHoldEnded

此事件會在玩家按住按鈕在提示上的按鈕使用不零的 ProximityPrompt.HoldDuration 時發生。一個可能的使用包括動畫按住進度條。

參數

playerWhoTriggered: Player

輸入持續時間結束的玩家。

PromptHidden

此事件會在 prompt 變為隱藏時啟動。此事件在客戶端為 LocalScripts 啟動。

PromptShown

此事件會在 prompt 變為可見時發生。此事件是在客戶端發生 LocalScripts 的。

參數

inputType: Enum.ProximityPromptInputType

輸入會觸發提示。

TriggerEnded

此事件會在 key /按鈕釋放時發生，這些需要用戶按住按鈕的長事件（例如治療另一名玩家）。

參數

playerWhoTriggered: Player

釋放鑰匙/按鈕的 Player，結束了發動事件。

Triggered

此事件會在按鈕 key /按鈕被按下或在指定的時間內按下按鈕後，如果 ProximityPrompt.HoldDuration 是使用。

參數

playerWhoTriggered: Player

發出提示的 Player。

檢視繼承自Instance的所有項目

檢視繼承自Object的所有項目

ProximityPrompt

範例程式碼

概要

屬性

方法

活動

屬性

ActionText

AutoLocalize

ClickablePrompt

Enabled

Exclusivity

GamepadKeyCode

HoldDuration

KeyboardKeyCode

MaxActivationDistance

ObjectText

RequiresLineOfSight

RootLocalizationTable

Style

UIOffset

方法

InputHoldBegin

返回

InputHoldEnd

返回

活動

PromptButtonHoldBegan

參數

PromptButtonHoldEnded

參數

PromptHidden

PromptShown

參數

TriggerEnded

參數

Triggered

參數