ProximityPrompt

Hiển Thị Bản Đã Lỗi Thời

*Nội dung này được dịch bằng AI (Beta) và có thể có lỗi. Để xem trang này bằng tiếng Anh, hãy nhấp vào đây.

Ví dụ, ProximityPrompt instance cho phép bạn yêu cầu người chơi tương tác với một đối tượng trong thế giới 3D, chẳng hạn như mở cửa hoặc nhặt một vật phẩm.Một đối tượng A hoạt động khi được gán cho một , hoặc (với cài đặtđược đặt) trong không gian làm việc.Khi nhân vật của người chơi tiếp cận, một giao diện người dùng xuất hiện để yêu cầu họ nhập.

Lời nhắc bao gồm ba thành phần chính, mỗi thành phần có thể được kiểm soát bởi các thuộc tính đã ghi nhận.Giao diện mặc định có thể được thay thế cho trang phục tùy chỉnh riêng của bạn như được mô tả trong Style .

<td>Mô tả</td>



    <td>Mặc định</td>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>Class.ProximityPrompt.ObjectText|ObjectText</code> ></td><td>Một tên bắt buộc cho đối tượng đang tương tác.</td>



    <td />

  </tr>



  <tr>

    <td><code>Class.ProximityPrompt.ActionText|ActionText khi nào</code></td>



    <td>Một tên hành động tùy chọn được hiển thị cho người chơi.</td>



    <td>Tương tác</td>

  </tr>



  <tr>

    <td><code>Class.ProximityPrompt.KeyboardKeyCode|KeyboardKeyCode</code></td>



    <td>Phím bàn phím sẽ kích hoạt lời nhắc.</td>



    <td>E</td>

  </tr>



  <tr>

    <td><code>Class.ProximityPrompt.GamepadKeyCode|GamepadKeyCode</code></td>



    <td>Nút gamepad sẽ kích hoạt lời nhắc.</td>



    <td>Cái nútX</td>

  </tr>

</tbody>
Tài sản

Bạn có thể kết nối với sự kiện thông báo cảm biến gần trên chính đối tượng ProximityPrompt hoặc toàn cầu thông qua ProximityPromptService .The ProximityPromptService cho phép bạn quản lý tất cả các hành vi thông báo cảm biến từ một vị trí, ngăn chặn bất kỳ nhu cầu có các mã trùng lặp trong trải nghiệm của bạn.

Để biết thêm thông tin về lời nhắc cảm biến, hãy xem hướng dẫn Lời nhắc cảm biến.

Mẫu mã

In the example below, a user must interact with a chair to sit in it. Paste this into a Script that is a child of a ProximityPrompt, which is itself a sibling of a Seat object named Seat.

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)

The example below generates a custom ProximityPrompt UI similar to the default style, which you may use as a starting point. It should be used in a LocalScript.

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

The example below illustrates a prompt that requires the user to hold the button down in order to heal their character. This should be used in a Script that is a child of a ProximityPrompt.

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)

Tóm Tắt

Thuộc Tính

Xem tất cả các mục kế thừa từ Instance
Xem tất cả các mục kế thừa từ Object

Phương Pháp

  • InputHoldBegin():()

    Bắn một tín hiệu cho thấy người dùng đã bắt đầu nhấn nút GUI thông báo.

  • InputHoldEnd():()

    Bắn một tín hiệu chỉ ra rằng người dùng đã kết thúc nhấn nút GUI thông báo.

Xem tất cả các mục kế thừa từ Instance
Xem tất cả các mục kế thừa từ Object

Sự Kiện

Xem tất cả các mục kế thừa từ Instance
Xem tất cả các mục kế thừa từ Object

Thuộc Tính

ActionText

string
Đọc Song Song

Thuộc tính này xác định văn bản hành động được hiển thị cho người dùng.

AutoLocalize

boolean
Đọc Song Song

Thuộc tính này xác định xem lời nhắc của ProximityPrompt.ActionText và ProximityPrompt.ObjectText sẽ được dịch theo cách thức ProximityPrompt.RootLocalizationTable .Khi được đặt thành true, bản địa hóa sẽ được áp dụng.

ClickablePrompt

boolean
Đọc Song Song

Tính chất này xác định xem lời nhắc có thể được kích hoạt bằng cách nhấp/nhấn vào giao diện người dùng của lời nhắc hay không.Khi được đặt thành false, thông báo không thể được kích hoạt bằng cách nhấp/nhấn ngoại trừ trên thiết bị di động.

Enabled

boolean
Đọc Song Song

Thuộc tính này cho thấy liệu có nên hiển thị ProximityPrompt này hay không.

Exclusivity

Enum.ProximityPromptExclusivity
Đọc Song Song

Tính năng này được sử dụng để tùy chỉnh các lời nhắc có thể được hiển thị cùng một lúc.

GamepadKeyCode

Enum.KeyCode
Đọc Song Song

Thuộc tính này xác định nút gamepad mà người chơi nên nhấn để kích hoạt ProximityPrompt . Mặc định là ButtonX .

HoldDuration

number
Đọc Song Song

Tính chất này chỉ thời gian, bằng giây, mà người chơi phải giữ nút/phím để kích hoạt lời nhắc.

KeyboardKeyCode

Enum.KeyCode
Đọc Song Song

Thuộc tính này xác định phím mà người chơi nên nhấn để kích hoạt ProximityPrompt . Mặc định là E .

MaxActivationDistance

number
Đọc Song Song

Thuộc tính này xác định khoảng cách tối đa mà character của Người chơi có thể từ ProximityPrompt để yêu cầu xuất hiện.

ObjectText

string
Đọc Song Song

Tính chất bắt buộc này xác định văn bản tên đối tượng bắt buộc được hiển thị cho người dùng.

RequiresLineOfSight

boolean
Đọc Song Song

Thuộc tính này cho thấy liệu lời nhắc có bị ẩn nếu con đường giữa người chơi Camera và đối tượng được gán cho đối tượng ProximityPrompt có bị chặn hay không.Nếu đúng, thông báo này chỉ được hiển thị nếu có một con đường rõ ràng từ máy ảnh đến đối tượng.

cha mẹ Part hoặc Model của lời nhắc sẽ bị loại khỏi kiểm tra này.

RootLocalizationTable

LocalizationTable
Đọc Song Song

Thuộc tính này phục vụ như một tham chiếu đến LocalizationTable được sử dụng để áp dụng lok hóa tự động cho ProximityPrompt.ActionText và ProximityPrompt.ObjectText của yêu cầu.Để áp dụng điều này, ProximityPrompt.AutoLocalize phải được cài đặt.

Các nhà phát triển có thể đặt điều này để tham chiếu đến Bảng Phiên dịch ở bất kỳ đâu trong DataModel.Nó không cần phải là con của LocalizationService .Nếu không có bản dịch nào có sẵn trong bảng tham chiếu, nó sẽ tìm kiếm một bản dịch trong cha của bảng đó, nếu cũng là một Bảng Dịch, và như vậy.

Style

Enum.ProximityPromptStyle
Đọc Song Song

Tính năng này chỉ ra phong cách của lời nhắc. Khi được đặt thành Tùy chỉnh, không có UI mặc định nào sẽ được cung cấp.

Giao diện UI được cung cấp có thể được thay thế bằng một giao diện UI tùy chỉnh.Để làm điều này, hãy đặt Style thành Tùy chỉnh.Sau đó, hãy lắng nghe các sự kiện ProximityPrompt.PromptShown và ProximityPrompt.PromptHidden trong một LocalScript, nơi các nhà phát triển nên tạo và phá bỏ giao diện người dùng.

Các nhà phát triển cũng có thể sử dụng ProximityPrompt.PromptButtonHoldBegan và ProximityPrompt.PromptButtonHoldEnded để sử dụng tính năng tiến trình hoạt hình ProximityPrompt.HoldDuration .

UIOffset

Vector2
Đọc Song Song

Tính chất này chỉ ra khoảng cách pixel được áp dụng cho giao diện người dùng của yêu cầu.

Xem tất cả các mục kế thừa từ Instance
Xem tất cả các mục kế thừa từ Object

Phương Pháp

InputHoldBegin

()

Chức năng này kích hoạt một tín hiệu cho thấy rằng người dùng đã bắt đầu nhấn nút ProximityPrompt nhắc lời.Nó nên được sử dụng bởi các nhà phát triển muốn tùy chỉnh lời nhắc và kích hoạt nó từ một nút GUI nhấn nhanh.


Lợi Nhuận

()

InputHoldEnd

()

Một điểm phản đối đến ProximityPrompt:InputHoldBegin() , tín hiệu này cho thấy người dùng đã kết thúc nhấn nút GUI thông báo.


Lợi Nhuận

()
Xem tất cả các mục kế thừa từ Instance
Xem tất cả các mục kế thừa từ Object

Sự Kiện

PromptButtonHoldBegan

Sự kiện này xảy ra khi một người chơi bắt đầu giữ nút key / trên một lời nhắc với một ProximityPrompt.HoldDuration không bằng không.Một trong những cách sử dụng có thể bao gồm việc hoạt hình tiến trình giữ.

Tham Số

playerWhoTriggered: Player

Người Player bắt đầu giữ nút thông báo.


PromptButtonHoldEnded

Sự kiện này kích hoạt khi người chơi kết thúc giữ nút trên một thông báo với một nút không bằng không ProximityPrompt.HoldDuration .Một trong những cách sử dụng có thể bao gồm việc hoạt hình tiến trình giữ.

Tham Số

playerWhoTriggered: Player

Người chơi đã kết thúc việc giữ nhập.


PromptHidden

Sự kiện này được kích hoạt khi prompt trở nên隐藏. Sự kiện này được kích hoạt bên khách cho LocalScripts .


PromptShown

Sự kiện này được kích hoạt khi prompt trở nên hiển thị. Sự kiện này được kích hoạt bên khách cho LocalScripts .

Tham Số

inputType: Enum.ProximityPromptInputType

Nhập có thể kích hoạt lời nhắc.


TriggerEnded

Sự kiện này được kích hoạt khi nút key/button được phát hành, cho các sự kiện lâu hơn mà người dùng phải giữ nút (ví dụ:chữa lành người chơi khác theo thời gian.)

Tham Số

playerWhoTriggered: Player

Người phát hành Player chìa khóa/ nút, kết thúc sự kiện kích hoạt.


Triggered

Sự kiện này được kích hoạt khi lệnh key/button được nhấn, hoặc sau một thời gian nhất định giữ nút, nếu ProximityPrompt.HoldDuration được sử dụng.

Tham Số

playerWhoTriggered: Player

Người Player ai đã kích hoạt lời nhắc.


Xem tất cả các mục kế thừa từ Instance
Xem tất cả các mục kế thừa từ Object