ContextActionService

Binden Sie eine Aktion an die Eingabe des Benutzers, gegeben eine Aktion-Handlingsfunktion.Wenn eine passende Eingabe ausgeführt wird, wird die Aktion-Handler-Funktion mit den im Folgenden aufgelisteten Argumenten aufgerufen.Gültige Eingabeelemente umfassen die gefolgte Profile: Enum.KeyCode, Enum.UserInputType oder Enum.PlayerActions.Rufe diese Funktion auf, wenn ein Spieler den Kontext betritt , in dem eine Aktion ausgeführt werden kann.Wenn der Spieler den Kontext verlässt, rufe UnbindAction mit demselben actionName an.Du kannst die Aktion-Handlungsfunktion einer Aktion manuell aufrufen, indem du CallFunction verwendest.

Das Codebeispiel unten zeigt, wie ein Sound kann played werden, während ein Schlüssel ( H ), Spielpad-Taste oder Touchscreen-Taste gedrückt wird.

local ContextActionService = game:GetService("ContextActionService")

-- Ein Autohorngeräusch
local honkSound = Instance.new("Sound", workspace)
honkSound.Looped = true
honkSound.SoundId = "rbxassetid://9120386436"

local function handleAction(actionName, inputState, inputObject)
	if actionName == "HonkHorn" then
		if inputState == Enum.UserInputState.Begin then
			honkSound:Play()
		else
			honkSound:Pause()
		end
	end
end

-- Wenn der Spieler im Fahrzeug sitzt:
ContextActionService:BindAction("HonkHorn", handleAction, true, Enum.KeyCode.H, Enum.KeyCode.ButtonY)

-- Wenn der Spieler herauskommt:
ContextActionService:UnbindAction("HonkHorn")

Aktion-Handler-Parameter

Die Aktion-Handler-Funktionen werden mit den folgenden Parametern aufgerufen:

<th>Typ</th>

  <th>Beschreibung</th>
</tr>

<tr>
  <td>1</td>

  <td><code>string</code></td>

  <td>Der gleiche String, der ursprünglich an BindAction† übergeben wurde</td>
</tr>

<tr>
  <td>2</td>

  <td><code>Enum.UserInputState</code></td>

  <td>Der Zustand der Eingabe (Beginnen, Ändern, Beenden oder Abbrechen)*</td>
</tr>

<tr>
  <td>3</td>

  <td><code>Eingabeelement</code></td>

  <td>Ein Objekt, das Informationen über die Eingabe enthält (je nach UserInputType unterschiedlich)</td>
</tr>

† Dies ermöglicht es einer Funktion, mehrere Aktionen gleichzeitig zu bearbeiten, wenn nötig.:* Abbruch wird gesendet, wenn irgendeine Eingabe im Gange ist und eine andere Aktion über die im Gange befindliche Eingabe gebunden ist, oder wenn die im Gange befindliche Bindungsaktion unbound war.

Aktionen-Bindungen-Stack

Aktionen-Bindungen verhalten sich wie ein Stapel: Wenn zwei Aktionen mit demselben Benutzereingabe gebunden sind, wird der neuest gebundene Aktion-Handler verwendet.Wenn ein Aktionshändler Enum.ContextActionResult.Pass zurückgibt, wird der nächste am häufigsten gebundene Aktionshändler angerufen, und so weiter, bis ein Handler die Eingabe sinkt (durch die Rückgabe von nil oder Enum.ContextActionResult.Sink ).Wenn UnbindAction aufgerufen wird, wird der Aktionshändler aus dem Stapel entfernt.Dieses Stapelverhalten kann mit BindActionAtPriority überschrieben werden, wo ein zusätzlicher Prioritäten参数 nach createTouchButton die Reihenfolge überstellen kann, in der Aktionen gebunden sind (höher vor niedriger).

BerührungsButtons

Zusätzlich zu Eingabetypen steuert der dritte Parameter dieser Funktion, ob ein Button für TouchEnabled erstellt wird.Bei der Schöpfungdes ersten Berührungsknopfes wird ein ScreenGui namens "ContextActionGui" zum PlayerGui hinzugefügt.Innerhalb des ScreenGui wird ein Frame namens "ContextButtonFrame" hinzugefügt, der aufgerufen wird.Es ist in diesem Rahmen, in dem ImageButtons für gebundene Aktionen gesponsort werden; du kannst GetButton verwenden, um solche Schaltflächen für die Anpassung zu erhalten.

Parameter

Rückgaben

local ContextActionService = game:GetService("ContextActionService")

local ACTION_RELOAD = "Reload"

local tool = script.Parent

local function handleAction(actionName, inputState, _inputObject)
	if actionName == ACTION_RELOAD and inputState == Enum.UserInputState.Begin then
		print("Reloading!")
	end
end

tool.Equipped:Connect(function()
	ContextActionService:BindAction(ACTION_RELOAD, handleAction, true, Enum.KeyCode.R)
end)

tool.Unequipped:Connect(function()
	ContextActionService:UnbindAction(ACTION_RELOAD)
end)

local ContextActionService = game:GetService("ContextActionService")

local function handleAction(actionName, inputState, inputObj)
	if inputState == Enum.UserInputState.Begin then
		print("Handling action: " .. actionName)
		print(inputObj.UserInputType)
	end

	-- Since this function does not return anything, this handler will
	-- "sink" the input and no other action handlers will be called after
	-- this one.
end

ContextActionService:BindAction("BoundAction", handleAction, false, Enum.KeyCode.F)

local ContextActionService = game:GetService("ContextActionService")

-- Define an action handler for FirstAction
local function actionHandlerOne(actionName, inputState, _inputObj)
	if inputState == Enum.UserInputState.Begin then
		print("Action Handler One: " .. actionName)
	end
	-- This action handler returns nil, so it is assumed that
	-- it properly handles the action.
end

-- Binding the action FirstAction (it's on the bottom of the stack)
ContextActionService:BindAction("FirstAction", actionHandlerOne, false, Enum.KeyCode.Z, Enum.KeyCode.X, Enum.KeyCode.C)

-- Define an action handler for SecondAction
local function actionHandlerTwo(actionName, inputState, inputObj)
	if inputState == Enum.UserInputState.Begin then
		print("Action Handler Two: " .. actionName)
	end

	if inputObj.KeyCode == Enum.KeyCode.X then
		return Enum.ContextActionResult.Pass
	else
		-- Returning nil implicitly Sinks inputs
		return Enum.ContextActionResult.Sink
	end
end

-- Binding SecondAction over the first action (since it bound more recently, it is on the top of the stack)
-- Note that SecondAction uses the same keys as
ContextActionService:BindAction("SecondAction", actionHandlerTwo, false, Enum.KeyCode.Z, Enum.KeyCode.X)

BindActionAtPriority verhält sich wie BindAction, ermöglicht aber auch, dass der gebundene Aktion eine Priorität zugewiesen wird.Wenn mehrere Aktionen mit demselben Eingang gebunden sind, wird die höhere Prioritätsfunktion unabhängig von der Reihenfolge der Bindung der Aktionen aufgerufen.Mit anderen Worten, diese Funktion überschreibt das normale "Stack"-Verhalten von BindAction.

Parameter

Rückgaben

local ContextActionService = game:GetService("ContextActionService")

local INPUT_KEY1 = Enum.KeyCode.Q
local INPUT_KEY2 = Enum.KeyCode.E

local function handleThrow(actionName: string, inputState: Enum.UserInputState, inputObject: InputObject)
	if inputState ~= Enum.UserInputState.Begin then
		return Enum.ContextActionResult.Pass
	end
	print(`Action [{actionName}] occurred. KeyCode [{inputObject.KeyCode}] pressed.`)

	return Enum.ContextActionResult.Sink
end

local function handlePunch(actionName: string, inputState: Enum.UserInputState, inputObject: InputObject)
	if inputState ~= Enum.UserInputState.Begin then
		return Enum.ContextActionResult.Pass
	end
	print(`Action [{actionName}] occurred. KeyCode [{inputObject.KeyCode}] pressed.`)

	return Enum.ContextActionResult.Sink
end

-- Without specifying priority, the most recently bound action is called first,
-- so pressing INPUT_KEY1 prints "Punch" and then sinks the input.
ContextActionService:BindAction("DefaultThrow", handleThrow, false, INPUT_KEY1)
ContextActionService:BindAction("DefaultPunch", handlePunch, false, INPUT_KEY1)

-- Here we bind both functions in the same order as above, but with explicitly swapped priorities.
-- That is, we give "Throw" a higher priority of 2 so it will be called first,
-- despite "Punch" still being bound more recently.
-- Pressing INPUT_KEY2 prints "Throw" and then sinks the input.
ContextActionService:BindActionAtPriority("PriorityThrow", handleThrow, false, 2, INPUT_KEY2)
ContextActionService:BindActionAtPriority("PriorityPunch", handlePunch, false, 1, INPUT_KEY2)

Binden Sie ein Enum.KeyCode, das mit einem Enum.UserInputType verwendet werden kann, um ClickDetector Ereignisse, Tools und GuiButtons zu aktivieren.Wenn der angegebene Schlüssel/Button gedrückt wird, wird das Mouse.Button1Down Ereignis auf der Maus abgefeuert, die an Tool.Equipped gesendet wurde.Dies wiederum aktiviert das Ereignis Tool.Activated, wenn Tool.ManualActivationOnly nicht auf wahr gesetzt ist.Für die Gamepad-Eingabe wird diese Funktion von den Standard-Steuerskripten aufgerufen, um den ButtonR2 Enum.KeyCode zu binden.

Beachten Sie, dass die Enum.UserInputType angegebene muss Keyboard oder Gamepad1 durch Gamepad8 sein, um gültig zu sein.

Parameter

Rückgaben

GetAllBoundActioninfo gibt eine Tabelle zurück, die alle Namen von Aktionen (die ursprünglich an BindAction übergeben wurden) auf eine Tabelle zurückmappt, die von GetBoundActionInfo zurückgegeben wird, wenn die Aktion mit dem Aktionsnamen selbst aufgerufen wird.Mit dieser Funktion können Sie alle derzeit gebundenen Aktionen inspizieren.Dies ist nützlich, wenn Sie ihre Prioritätsstufen oder Stapelaufträge debuggen.

Rückgaben

GetBoundActionInfo gibt eine Tabelle mit den folgenden Schlüsseln zurück, die eine gebundene Aktion beschreiben, die mit ihrem Namen gegeben wurde.Um die gleichen Informationen für alle Aktionen auf einmal zu erhalten, verwende GetAllBoundActionInfo.

<th>Typ</th>

  <th>Beschreibung</th>
</tr>

<tr>
  <td><code>Stapelordnung</code></td><td>Zahl</td>

  <td>
    Beschreibt den Index der Aktion auf dem Stapel (zunehmend)
  </td>
</tr>

<tr>
  <td><code>prioritätsstufe</code> \*</td><td>zahl</td>

  <td>
    Beschreibt die <code>Class.ContextActionService:BindActionAtPriority()|priority</code> Ebene der Aktion
  </td>
</tr>

<tr>
  <td><code>createTouchButton</code></td><td>bool</td>

  <td>
    Beschreibt, ob ein Touch-Button auf <code>Class.UserInputService.TouchEnabled|TouchEnabled</code> Geräten erstellt werden soll
  </td>
</tr>

<tr>
  <td><code>Eingabetypen</code></td><td>Tabelle</td>

  <td>
    Die Eingabetypen, die an <code>Class.ContextActionService:BindAction()|BindAction</code> übergeben wurden, für die diese Aktion Auslöser
  </td>
</tr>

<tr>
  <td><code>beschreibung</code> †</td><td>zeichen</td>

  <td>
    Die Beschreibung der Aktion, die von <code>Class.ContextActionService:SetDescription()|SetDescription</code> festgelegt wurde
  </td>
</tr>

<tr>
  <td><code>titel</code> †</td><td>sicherheitsstring</td>

  <td>
    Der Titel der Aktion, die von <code>Class.ContextActionService:SetTitle()|SetTitle</code> festgelegt wurde
  </td>
</tr>

<tr>
  <td><code>bild</code> †</td><td>sicherung</td>

  <td>
    Das Bild des Touch buttons der Aktion, das von <code>Class.ContextActionService:SetImage()|SetImage</code> festgelegt wurde
  </td>
</tr>

:* Der Prioritätenlevel wird immer noch enthalten sein, auch wenn BindActionAtPriority nicht verwendet wurde - standardmäßig wird es 2000 sein.

† Zeigt an, dass dieses Feld nil sein wird, wenn die zugeordnete Methode für die angegebene Actionnicht aufgerufen wurde.

Parameter

Rückgaben

GetCurrentLocalToolIcon wird die BackpackItem.TextureId eines Tool derzeit equipped durch die Player oder nil zurückgeben, wenn es kein solches Werkzeug gibt oder der Spieler kein Character hat.

Rückgaben

SetDescription wird die Beschreibung einer Aktion festlegen, die durch BindAction gebunden ist.In einer Liste der verfügbaren Aktionen wäre dies Text, der die angegebene Actionbeschreibt.

Obwohl der Name suggerieren kann, dass diese Methode mit der Familie von Funktionen zusammenhängt, die einen Touch-Button für Aktionen anpassen, die sie erzeugen ( SetTitle , SetImage und SetPosition ), betrifft diese Methode keinen solchen Knopf.Diese Methode legt nur eine Textbeschreibung einer Actionfest und nichts mehr.

Parameter

Rückgaben

local ContextActionService = game:GetService("ContextActionService")

local ACTION_INSPECT = "Inspect"
local INPUT_INSPECT = Enum.KeyCode.E
local IMAGE_INSPECT = "rbxassetid://1826746856" -- Image of a speech bubble with ? in it

local function handleAction(actionName, inputState, _inputObject)
	if actionName == ACTION_INSPECT and inputState == Enum.UserInputState.End then
		print("Inspecting")
	end
end

-- For touch devices, a button is created on-screen automatically via the 3rd parameter
ContextActionService:BindAction(ACTION_INSPECT, handleAction, true, INPUT_INSPECT)
-- We can use these functions to customize the button:
ContextActionService:SetImage(ACTION_INSPECT, IMAGE_INSPECT)
ContextActionService:SetTitle(ACTION_INSPECT, "Look")
ContextActionService:SetDescription(ACTION_INSPECT, "Inspect something.")
ContextActionService:SetPosition(ACTION_INSPECT, UDim2.new(0, 0, 0, 0))
-- We can manipulate the button directly using ContextActionService:GetButton
local imgButton = ContextActionService:GetButton(ACTION_INSPECT)
if imgButton then -- Remember: non-touch devices won't return anything!
	imgButton.ImageColor3 = Color3.new(0.5, 1, 0.5) -- Tint the ImageButton green
end

Diese Methode legt das Bild fest, das auf einem durch BindAction() erstellten Touch-Button angezeigt wird.Speziell legt es die Eigenschaft ImageLabel.Image des ImageLabel innerhalb der ImageButton, die von GetButton zurückgegeben würde, fest.Wenn keine solche gebundene Aktion existiert (z. B.nichts wird durch GetButton zurückgegeben), diese Funktion tut nichts und wirft keine Fehler.

Diese Funktion ist Teil einer Familie von Methoden, die den Touch-Button einer Actionanpassen. Andere in dieser Familie sind SetPosition und SetTitle.

Parameter

Rückgaben

local ContextActionService = game:GetService("ContextActionService")

local ACTION_INSPECT = "Inspect"
local INPUT_INSPECT = Enum.KeyCode.E
local IMAGE_INSPECT = "rbxassetid://1826746856" -- Image of a speech bubble with ? in it

local function handleAction(actionName, inputState, _inputObject)
	if actionName == ACTION_INSPECT and inputState == Enum.UserInputState.End then
		print("Inspecting")
	end
end

-- For touch devices, a button is created on-screen automatically via the 3rd parameter
ContextActionService:BindAction(ACTION_INSPECT, handleAction, true, INPUT_INSPECT)
-- We can use these functions to customize the button:
ContextActionService:SetImage(ACTION_INSPECT, IMAGE_INSPECT)
ContextActionService:SetTitle(ACTION_INSPECT, "Look")
ContextActionService:SetDescription(ACTION_INSPECT, "Inspect something.")
ContextActionService:SetPosition(ACTION_INSPECT, UDim2.new(0, 0, 0, 0))
-- We can manipulate the button directly using ContextActionService:GetButton
local imgButton = ContextActionService:GetButton(ACTION_INSPECT)
if imgButton then -- Remember: non-touch devices won't return anything!
	imgButton.ImageColor3 = Color3.new(0.5, 1, 0.5) -- Tint the ImageButton green
end

Diese Methode legt die Position eines Touch buttons fest, der von BindAction() erstellt wurde.Speziell legt es die Eigenschaft GuiObject.Position des ImageButton, die von GetButton zurückgegeben würde, fest.Wenn keine solche gebundene Aktion existiert (z. B.nichts wird durch GetButton zurückgegeben), diese Funktion tut nichts und wirft keine Fehler.

Diese Funktion ist Teil einer Familie von Methoden, die den Touch-Button einer Actionanpassen. Andere in dieser Familie sind SetImage und SetTitle.

Parameter

Rückgaben

local ContextActionService = game:GetService("ContextActionService")

local ACTION_INSPECT = "Inspect"
local INPUT_INSPECT = Enum.KeyCode.E
local IMAGE_INSPECT = "rbxassetid://1826746856" -- Image of a speech bubble with ? in it

local function handleAction(actionName, inputState, _inputObject)
	if actionName == ACTION_INSPECT and inputState == Enum.UserInputState.End then
		print("Inspecting")
	end
end

-- For touch devices, a button is created on-screen automatically via the 3rd parameter
ContextActionService:BindAction(ACTION_INSPECT, handleAction, true, INPUT_INSPECT)
-- We can use these functions to customize the button:
ContextActionService:SetImage(ACTION_INSPECT, IMAGE_INSPECT)
ContextActionService:SetTitle(ACTION_INSPECT, "Look")
ContextActionService:SetDescription(ACTION_INSPECT, "Inspect something.")
ContextActionService:SetPosition(ACTION_INSPECT, UDim2.new(0, 0, 0, 0))
-- We can manipulate the button directly using ContextActionService:GetButton
local imgButton = ContextActionService:GetButton(ACTION_INSPECT)
if imgButton then -- Remember: non-touch devices won't return anything!
	imgButton.ImageColor3 = Color3.new(0.5, 1, 0.5) -- Tint the ImageButton green
end

SetTitle wird den Text festlegen, der auf einem durch BindAction erstellten Touch-Button angezeigt wird.Speziell legt dies das Eigenschaft TextLabel.Text von einem TextLabel innerhalb der ImageButton, die von GetButton zurückgegeben würde.Wenn keine solche gebundene Aktion existiert (z. B.nichts wird durch GetButton zurückgegeben), diese Funktion tut nichts und wirft keine Fehler.

Diese Funktion ist Teil einer Familie von Methoden, die den Touch-Button einer Actionanpassen. Andere in dieser Familie sind SetImage und SetPosition.

Parameter

Rückgaben

local ContextActionService = game:GetService("ContextActionService")

local ACTION_INSPECT = "Inspect"
local INPUT_INSPECT = Enum.KeyCode.E
local IMAGE_INSPECT = "rbxassetid://1826746856" -- Image of a speech bubble with ? in it

local function handleAction(actionName, inputState, _inputObject)
	if actionName == ACTION_INSPECT and inputState == Enum.UserInputState.End then
		print("Inspecting")
	end
end

-- For touch devices, a button is created on-screen automatically via the 3rd parameter
ContextActionService:BindAction(ACTION_INSPECT, handleAction, true, INPUT_INSPECT)
-- We can use these functions to customize the button:
ContextActionService:SetImage(ACTION_INSPECT, IMAGE_INSPECT)
ContextActionService:SetTitle(ACTION_INSPECT, "Look")
ContextActionService:SetDescription(ACTION_INSPECT, "Inspect something.")
ContextActionService:SetPosition(ACTION_INSPECT, UDim2.new(0, 0, 0, 0))
-- We can manipulate the button directly using ContextActionService:GetButton
local imgButton = ContextActionService:GetButton(ACTION_INSPECT)
if imgButton then -- Remember: non-touch devices won't return anything!
	imgButton.ImageColor3 = Color3.new(0.5, 1, 0.5) -- Tint the ImageButton green
end

UnbindAction wird eine Aktion durch Namen von Benutzereingaben von der Aktion entfernen, so dass die Aktion Handler-Funktion nicht mehr aufgerufen wird.Rufe diese Funktion auf, wenn der Kontext für eine Aktion nicht mehr geltendist, wie das Schließen einer Benutzeroberfläche, das Verlassen eines Autos oder unequipping eines Tool.Siehe BindAction für weitere Informationen darüber, wie gebundene Aktionen funktionieren.

Diese Funktion wirft keinen Fehler, wenn es keine solche Aktion mit dem angegebenen String gibt, die gebunden ist .Mit GetAllBoundActionInfo oder der Registerkarte "Aktionen der Entwicklerkonsole" kannst du herausfinden, welche Aktionen derzeit gebunden sind.

Parameter

Rückgaben

local ContextActionService = game:GetService("ContextActionService")

local ACTION_RELOAD = "Reload"

local tool = script.Parent

local function handleAction(actionName, inputState, _inputObject)
	if actionName == ACTION_RELOAD and inputState == Enum.UserInputState.Begin then
		print("Reloading!")
	end
end

tool.Equipped:Connect(function()
	ContextActionService:BindAction(ACTION_RELOAD, handleAction, true, Enum.KeyCode.R)
end)

tool.Unequipped:Connect(function()
	ContextActionService:UnbindAction(ACTION_RELOAD)
end)

UnbindActivate aktiviert eine Enum.KeyCode mit einer Enum.UserInputType zum Aktivieren einer Tool (oder einer HopperBin ) mit BindActivate .Diese Funktion macht im Wesentlichen die von dieser Funktion durchgeführte Aktion rückgängig.

Parameter

Rückgaben

Entfernt alle gebundenen Funktionen.Es bleiben keine Aktionenamen übrig.Alle Touch-Buttons werden entfernt.Wenn ein Button manuell manipuliert wurde, gibt es keine Garantie, dass er gereinigt wird.

Rückgaben

GetButton gibt die ImageButton zurück, die von BindAction erstellt wurde, wenn ihr dritter Parameter wahr war und das Gerät TouchEnabled ist.Der einzige Parameter für diese Funktion muss genau dem Namen der Aktion entsprechen, die ursprünglich an BindAction gesendet wurde.

Wenn keine solche Aktion gebunden wurde oder wenn ein Button nicht erstellt wurde, gibt diese Funktion nil zurück.

Parameter

Rückgaben

Feuert, wenn der aktuelle Spieler ein Tool ausrüstet.

Parameter

Feuert, wenn der aktuelle Spieler ein Tool ablegt.

Parameter