ProximityPrompt

Veraltete anzeigen

*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.

Die ProximityPrompt -Instanz lässt dich Spieler auffordern, mit einem Objekt in der 3D-Welt zu interagieren, wie z. B. eine Tür zu öffnen oder ein Artikelaufzuheben.Ein ProximityPrompt Objekt funktioniert, wenn es einem BasePart , Attachment oder Model (mit PrimaryPart festlegen) im Arbeitsbereich zugewiesen wird.Wenn sich der Charakter des Spieler:innähert, erscheint eine Benutzeroberfläche, die ihn nach Eingabe fragt.

Fragen bestehen aus drei primären Elementen, von denen jedes durch die angegebenen Eigenschaften gesteuert werden kann.Die Standard-UI kann durch Ihr eigenes benutzerdefiniertes Aussehen ersetzt werden, wie in Style beschrieben.


<td>Beschreibung</td>

    <td>Standardmäßig</td>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>Class.ProximityPrompt.ObjectText|ObjectText</code></td><td>Ein optioneller Name für das zu interagierende Objekt.</td>

    <td />
  </tr>

  <tr>
    <td><code>Class.ProximityPrompt.ActionText|Aktiontext</code></td>

    <td>Ein optioneller Aktionsname, der dem Spieler:inangezeigt wird.</td>

    <td>Interagieren</td>
  </tr>

  <tr>
    <td><code>Klasse.ProximityPrompt.KeyboardKeyCode|KeyboardKeyCode</code></td>

    <td>Die Tastaturtaste, die die Eingabeaufforderung auslöst.</td>

    <td>E</td>
  </tr>

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

    <td>Die Spielpad-Taste, die die Eingabeaufforderung auslöst.</td>

    <td>SchaltflächeX</td>
  </tr>
</tbody>

Eigenschaft

Du kannst dich mit Näherungsaufforderungsereignissen verbinden, entweder auf dem ProximityPrompt Objekt selbst oder global durch ProximityPromptService .Die ProximityPromptService ermöglicht es Ihnen, das gesamte Verhalten der Näherungsfenster von einem Ort aus zu verwalten, wodurch jede Notwendigkeit von duplizierten Codes in Ihrer Erlebnisvermieden wird.

Für weitere Informationen zu Näherungsaufforderungen siehe den Näherungsaufforderungen-Leitfaden.

Code-Beispiele

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)

Zusammenfassung

Eigenschaften

ActionText:string
Parallel lesen
Der vom Benutzer angezeigte Aktionstext.
AutoLocalize:boolean
Parallel lesen
Ob die Eingabeaufforderung und lokalisiert wird, entsprechend der > .
ClickablePrompt:boolean
Parallel lesen
Ob die Aufforderung durch Klicken/Tippen auf die Aufforderungs-UI aktiviert werden kann.
Enabled:boolean
Parallel lesen
Ob diese Aufforderung angezeigt werden soll.
Exclusivity:Enum.ProximityPromptExclusivity
Parallel lesen
Wird verwendet, um anzupassen, welche Eingabeaufforderungen gleichzeitig angezeigt werden können.
GamepadKeyCode:Enum.KeyCode
Parallel lesen
Die Spielpad-Taste, die der Spieler drücken sollte, um die Eingabeaufforderung auszulösen.
HoldDuration:number
Parallel lesen
Die Dauer, in Sekunden, die der Spieler halten muss, um die Schaltfläche/Taste gedrückt zu halten, um die Aufforderung auszulösen.
KeyboardKeyCode:Enum.KeyCode
Parallel lesen
Der Schlüssel, den der Spieler drücken sollte, um die Aufforderung auszulösen.
MaxActivationDistance:number
Parallel lesen
Die maximale Entfernung, die ein Spielers character von der ProximityPrompt für die Anzeige der Aufforderung entfernt sein kann.
ObjectText:string
Parallel lesen
Eine optionale Eigenschaft, die den Objektnamentext anzeigt, der dem Benutzer angezeigt wird.
RequiresLineOfSight:boolean
Parallel lesen
Ob die Eingabeaufforderung ausgeblendet wird, wenn der Weg zwischen dem Spieler:in's Camera und dem Objekt an den ProximityPrompt blockiert wird.
RootLocalizationTable:LocalizationTable
Parallel lesen
Ein Verweis auf ein LocalizationTable , das verwendet werden soll, um die automatische Lokalisierung auf diese Eingabe anzuwenden ProximityPrompt.ActionText und ProximityPrompt.ObjectText .
Style:Enum.ProximityPromptStyle
Parallel lesen
Der Stil der Benutzeroberfläche des Prompts.
UIOffset:Vector2
Parallel lesen
Der Pixelflussversatz, der auf die UI des Prompts angewendet wird.

Alles Geerbte von Instance anzeigen

Alles Geerbte von Object anzeigen

Methoden

InputHoldBegin():()
Feuert ein Signal ab, das anzeigt, dass der Benutzer begonnen hat, die schnelle GUI-Taste zu drücken.
InputHoldEnd():()
Feuert ein Signal ab, das darauf hinweist, dass der Benutzer die schnelle GUI-Taste gedrückt hat, beendet.

Alles Geerbte von Instance anzeigen

Alles Geerbte von Object anzeigen

Ereignisse

PromptButtonHoldBegan(playerWhoTriggered : Player):RBXScriptSignal
Ausgelöst, wenn ein Spieler beginnt, die key /Taste gedrückt zu halten, die mit einem Prompt verbunden ist, der keine Null hat ProximityPrompt.HoldDuration.
PromptButtonHoldEnded(playerWhoTriggered : Player):RBXScriptSignal
Löst aus, wenn der Spieler beim Drücken der Taste auf einem Eingabeaufforderung mit einem Nicht-Null ProximityPrompt.HoldDuration beendet.
PromptHidden():RBXScriptSignal
Wird ausgelöst, wenn die Eingabeaufforderung verschwindet.
PromptShown(inputType : Enum.ProximityPromptInputType):RBXScriptSignal
Wird ausgelöst, wenn die prompt sichtbar wird.
TriggerEnded(playerWhoTriggered : Player):RBXScriptSignal
Löst aus, wenn key/Button freigegeben wird, für längere Ereignisse, bei denen der Benutzer den Knopf gedrückt halten muss.
Triggered(playerWhoTriggered : Player):RBXScriptSignal
Ausgelöst, wenn die Aufforderung key/Button gedrückt wird oder nach einer bestimmten Zeit, in der der Button gehalten wird, wenn ProximityPrompt.HoldDuration verwendet wird.

Alles Geerbte von Instance anzeigen

Alles Geerbte von Object anzeigen

Eigenschaften

ActionText

string

Parallel lesen

Diese Eigenschaft legt den Aktionstext fest, der dem Benutzer angezeigt wird.

AutoLocalize

boolean

Parallel lesen

Diese Eigenschaft bestimmt, ob die Eingabeaufforderung und lokalisiert wird, gemäß der > .Wenn auf wahr gesetzt, wird die Lokalisierung angewendet.

ClickablePrompt

boolean

Parallel lesen

Diese Eigenschaft legt fest, ob die Aufforderung durch Klicken/Tippen auf die Aufforderungs-UI aktiviert werden kann.Wenn auf false gesetzt, kann die Aufforderung nicht durch Klicken/Tippen aktiviert werden, außer auf dem Mobilgerät.

Enabled

boolean

Parallel lesen

Diese Eigenschaft zeigt an, ob oder diese ProximityPrompt angezeigt werden sollen.

Exclusivity

Enum.ProximityPromptExclusivity

Parallel lesen

Diese Eigenschaft wird verwendet, um anzupassen, welche Eingabeaufforderungen gleichzeitig angezeigt werden können.

GamepadKeyCode

Enum.KeyCode

Parallel lesen

Diese Eigenschaft legt fest, welche Gamepad-Taste der Spieler drücken soll, um den ProximityPrompt auszulösen. Standard ist ButtonX .

HoldDuration

number

Parallel lesen

Diese Eigenschaft gibt die Dauer an, in Sekunden, die der Spieler halten muss, um die Schaltfläche/Taste gedrückt zu halten, um die Aufforderung auszulösen.

KeyboardKeyCode

Enum.KeyCode

Parallel lesen

Diese Eigenschaft legt die Taste fest, die der Spieler drücken soll, um die ProximityPrompt auszulösen. Standard ist E .

MaxActivationDistance

number

Parallel lesen

Diese Eigenschaft legt die maximale Entfernung fest, von der ein Spieler character von der ProximityPrompt für die sofortige Anzeige entfernt sein kann.

ObjectText

string

Parallel lesen

Diese optionale Eigenschaft legt den optionalen Objektnamenstext fest, der dem Benutzer angezeigt wird.

RequiresLineOfSight

boolean

Parallel lesen

Diese Eigenschaft zeigt an, ob die Eingabeaufforderung ausgeblendet wird, wenn der Weg zwischen dem Spieler:in's Camera und dem Objekt an den ProximityPrompt behindert wird.Wenn dies wahr ist, wird diese Aufforderung nur angezeigt, wenn es einen klaren Weg von der Kamera zum Objekt gibt.

Der Eltern Part oder Model des Prompts wird von dieser überprüfenausgeschlossen.

RootLocalizationTable

LocalizationTable

Parallel lesen

Diese Eigenschaft dient als Referenz für die LocalizationTable verwendet, um die automatische Lokalisierung auf die Eingabeaufforderung ProximityPrompt.ActionText und ProximityPrompt.ObjectText anzuwenden.Damit dies angewendet werden kann, muss ProximityPrompt.AutoLocalize festlegenwerden.

Entwickler können dies festlegen, um eine Lokalisierungstabelle überall im DataModel zu referenzieren.Es ist nicht erforderlich, ein Kind von LocalizationService zu sein.Wenn keine Übersetzung in der referenzierten Tabelle verfügbar ist, sucht sie nach einer Übersetzung im Eltern der dieses Tabelle, wenn es sich auch um eine Lokalisierungstabelle handelt, und so weiter.

Style

Enum.ProximityPromptStyle

Parallel lesen

Diese Eigenschaft gibt den Stil der Eingabeaufforderung an. Wenn sie auf Benutzerdefiniert gesetzt ist, wird keine Standard-Benutzeroberfläche bereitgestellt.

Die bereitgestellte UI kann für eine benutzerdefinierte UI ausgetauscht werden.Um dies zu tun, stelle den Stil auf Benutzerdefiniert ein.Dann höre auf die ProximityPrompt.PromptShown- und ProximityPrompt.PromptHidden-Ereignisse in einem LocalScript, wo Entwickler die UI erstellen und abbauen sollten.

Entwickler können auch ProximityPrompt.PromptButtonHoldBegan und ProximityPrompt.PromptButtonHoldEnded verwenden, um die Funktionzu nutzen ProximityPrompt.HoldDuration.

UIOffset

Vector2

Parallel lesen

Diese Eigenschaft gibt den Pixelfluss an, der auf die Benutzeroberfläche des Prompts angewendet wird.

Alles Geerbte von Instance anzeigen

Alles Geerbte von Object anzeigen

Methoden

InputHoldBegin

()

Diese Funktion löst ein Signal aus, das darauf hinweist, dass der Benutzer begonnen hat, die ProximityPrompt Eingabetaste zu drücken.Es sollte von Entwicklern verwendet werden, die die Eingabe personalisieren und sie aus einem prompten GUI-Button drücken möchten.

Rückgaben

()

InputHoldEnd

()

Ein Gegenpunkt zu ProximityPrompt:InputHoldBegin(), dieser zeigt an, dass der Benutzer mit der prompten GUI-Taste fertig ist.

Rückgaben

()

Alles Geerbte von Instance anzeigen

Alles Geerbte von Object anzeigen

Ereignisse

PromptButtonHoldBegan

Dieses Ereignis wird ausgelöst, wenn ein Spieler beginnt, die key /Taste auf einer Aufforderung mit einer nicht Null ProximityPrompt.HoldDuration zu halten.Eine mögliche Verwendung besteht darin, eine Halte-Fortschrittsleiste zu animieren.

Parameter

playerWhoTriggered: Player

Die Player, die beginnt, die Eingabetaste gedrückt zu halten.

PromptButtonHoldEnded

Dieses Ereignis wird ausgelöst, wenn der Spieler die Taste auf einem Eingabeaufforderung mit einer nicht Null ProximityPrompt.HoldDuration gedrückt hält.Eine mögliche Verwendung besteht darin, eine Halte-Fortschrittsleiste zu animieren.

Parameter

playerWhoTriggered: Player

Der Spieler, der die Eingabe gehalten beendet hat.

PromptHidden

Dieses Ereignis wird ausgelöst, wenn das prompt verborgen wird. Dieses Ereignis wird clientseitig für LocalScripts ausgelöst.

PromptShown

Dieses Ereignis wird ausgelöst, wenn die prompt sichtbar wird. Dieses Ereignis wird clientseitig für LocalScripts ausgelöst.

Parameter

inputType: Enum.ProximityPromptInputType

Die Eingabe, die die Aufforderung auslöst.

TriggerEnded

Dieses Ereignis wird ausgelöst, wenn die key/-Taste freigegeben wird, für längere Ereignisse, bei denen der Benutzer die Taste gedrückt halten muss (z. B.heile einen anderen Spieler im Laufe der Zeit.)

Parameter

playerWhoTriggered: Player

Die Player, die den Schlüssel/Button freigegeben hat, der das Auslöseereignis beendet.

Triggered

Dieses Ereignis wird ausgelöst, wenn die Aufforderung key/Button gedrückt wird oder nach einer bestimmten Zeit, in der der Button gehalten wird, wenn ProximityPrompt.HoldDuration verwendet wird.

Parameter

playerWhoTriggered: Player

Der Player , der die Aufforderung ausgelöst hat.

Alles Geerbte von Instance anzeigen

Alles Geerbte von Object anzeigen

ProximityPrompt

Code-Beispiele

Zusammenfassung

Eigenschaften

Methoden

Ereignisse

Eigenschaften

ActionText

AutoLocalize

ClickablePrompt

Enabled

Exclusivity

GamepadKeyCode

HoldDuration

KeyboardKeyCode

MaxActivationDistance

ObjectText

RequiresLineOfSight

RootLocalizationTable

Style

UIOffset

Methoden

InputHoldBegin

Rückgaben

InputHoldEnd

Rückgaben

Ereignisse

PromptButtonHoldBegan

Parameter

PromptButtonHoldEnded

Parameter

PromptHidden

PromptShown

Parameter

TriggerEnded

Parameter

Triggered

Parameter

Auf dieser Seite