ContextActionService

方法

BindAction(actionName : string,functionToBind : function,createTouchButton : bool,inputTypes : Tuple):void
将用户输入绑定到给予动作处理函数的动作。
BindActionAtPriority(actionName : string,functionToBind : function,createTouchButton : bool,priorityLevel : number,inputTypes : Tuple):void
行为像 BindAction 但还允许优先级被分配到覆盖输入类型的边界动作(从高到低)。
BindActivate(userInputTypeForActivation : Enum.UserInputType,keyCodesForActivation : Tuple):void
使用特定 Enum.UserInputType 与 Tool.Activation 和 1> Class.ClickDetector1> 事件触发。
GetAllBoundActionInfo():Dictionary
获取有关所有绑定操作的信息表（键是通过 BindAction 传递的名称，值是由 GetBoundActionInfo 调用时的表）。
GetBoundActionInfo(actionName : string):Dictionary
获取有关命名为 BindAction 的界定操作的信息表。
GetCurrentLocalToolIcon():string
返回 BackpackItem.TextureId 的一个 Tool 当前 equipped 通过 2>Class.Player2> 。
SetDescription(actionName : string,description : string):void
给予一个带有触摸按钮的关联动作的名称，设置动作的描述。
SetImage(actionName : string,image : string):void
如果 actionName 键包含一个绑定操动作，那么 image 将作为触摸按钮的图像设置。
SetPosition(actionName : string,position : UDim2):void
给予一个带有触摸按钮的关联动作的名称，将按钮的位置设置在 ContextButtonFrame 中。
SetTitle(actionName : string,title : string):void
根据具有触摸按钮的关联动作的名称，设置显示在按钮上的文本。
UnbindAction(actionName : string):void
从输入中解除输入的命名。
UnbindActivate(userInputTypeForActivation : Enum.UserInputType,keyCodeForActivation : Enum.KeyCode):void
使用特定 Enum.UserInputType 从触发 Tool.Activation 时使用 1> Class.KeyCode1> 。
UnbindAllActions():void
移除所有绑定的函数。所有的操作名将不再存在。所有的触摸按钮将被移除。
GetButton(actionName : string):Instance
暂停
调用一个 ImageButton 的 Class.ContextActionService:BindAction()|bound 操作，该操作有一个触摸输入按钮。

活动

LocalToolEquipped(toolEquipped : Instance):RBXScriptSignal
当当前玩家装备一个 Tool 时触发。
LocalToolUnequipped(toolUnequipped : Instance):RBXScriptSignal
当前玩家卸下一个 Tool 时触发。

属性

方法

BindAction

void

在给予用户输入处理功能时，为其输入表示一个操作。当匹配的输

下面的代码示例显示了一个 Sound 可以被 played 而键 ( H ) 游戏手柄按钮或触摸屏幕按钮是按下。


local ContextActionService = game:GetService("ContextActionService")

-- 汽车喇叭声
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

-- 当玩家坐在车辆上时：
ContextActionService:BindAction("HonkHorn", handleAction, true, Enum.KeyCode.H, Enum.KeyCode.ButtonY)

-- 当玩家离开时：
ContextActionService:UnbindAction("HonkHorn")

动作处理器参数

动作处理器使用以下参数调用：


<tr>
  <td>1</td>
  <td><code>字符串</code></td>
  <td>与 BindAction 传入的同一个字符串</td>
</tr>

<tr>
  <td>2</td>
  <td><code>枚列.UserInputState</code></td>
  <td>输入状态(开始、更改、结束或取消)\*</td>
</tr>

<tr>
  <td>3</td>
  <td><code>输入对象</code></td>
  <td>一个包含输入信息的对象（根据输入类型不同）</td>
</tr>

类型

描述

※这允许一个函数同时处理多个操作，如有需要。*取消是发生在有进行中的输入和另一个操作的边界，或是在进行中边界发生的操作的后，或是在进行中边界发生的操作的后，或是在进行中边界发生的操作的后，或是在进行中边界发生的操作的后，或是在进行中边界发生的操作的后，或是在进行中边界发生的操作的后，或是在进行中边界发生的操作的后，或是在进行中

动作绑定堆

行为绑定

触摸按钮

除了输入类型外，此函数的第三个参数控制是否按钮作品建为 Class.UserInputService.TouchEnabled|TouchEnabled</

参数

actionName: string

代表要执行的操作的字符串(例如“HonkHorn”或“OpenDoor”)。

functionToBind: function

当触发边界输入时，调用以下参数调用函数：string (actionName)、Enum.UserInputState 和一个输入对象。

createTouchButton: bool

是否创建触摸输入设备上的动作按钮。

inputTypes: Tuple

任意数量的 Enum.KeyCode 或 Enum.UserInputType 代表输入要绑定到操动作。

void

代码示例

ContextActionService Tool Reload

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)

General Action Handler

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)

Stacked Action Handlers

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

void

BindActionAtPriority 像 BindAction 但还允许优先级被分配到边境操动作。如果多个操作被绑定到同一个输入，高级优先级函数仍然会在不同的操作顺序下调用。在其他 words, 此函数会覆盖 BindAction 的默认“堆叠”行为。

参数

actionName: string

代表要执行的操作的字符串(例如“HonkHorn”或“OpenDoor”)。

functionToBind: function

当触发边界输入时，调用以下参数调用函数：string (actionName)、Enum.UserInputState 和一个输入对象。

createTouchButton: bool

是否创建触摸输入设备上的动作按钮。

priorityLevel: number

行动的优先级（高于低于）。

inputTypes: Tuple

任意数量的 Enum.KeyCode 或 Enum.UserInputType 代表输入要绑定到操动作。

void

代码示例

ContextActionService BindAction Priorities

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)

BindActivate

void

注意，指定的 Enum.UserInputType 必须是 Keyboard 或 Gamepad1 通过 1>Gamepad81> 在 4>Gamepad84> 上有效。

参数

userInputTypeForActivation: Enum.UserInputType

必须通过 Gamepad8 的键盘或游戏手柄 1 来进行。

keyCodesForActivation: Tuple

void

GetAllBoundActionInfo

GetAllBindActioninfo 返回一个包含所有操作名称 ( 由原来传送到 BindAction ) 到 GetBoundActionInfo 的表，当使用此函数时，您可以检查所有现有的边界操作。使用此函数，您可以检查所有现有的边界操作。

GetBoundActionInfo

GetBindActionInfo 返回一个包含以下键描述其名称的关联行动的表。要同时为所有行动获取相同的信息，请使用 GetAllBoundActionInfo 。


<tr>
  <td><code>stackOrder</code></td>
  <td>数</td>

  <td>
    描述堆叠中的行动索引(增加)
  </td>
</tr>

<tr>
  <td><code>优先级等级</code> \*</td>
  <td>数</td>

  <td>
    描述<code>Class.ContextActionService:BindActionAtPriority()|优先级</code>级动作
  </td>
</tr>

<tr>
  <td><code>创建触摸按钮</code></td>
  <td>boolean</td>

  <td>
    描述是否在 <code>Class.UserInputService.TouchEnabled|TouchEnabled</code> 设备上创建触摸按钮
  </td>
</tr>

<tr>
  <td><code>输入类型</code></td>
  <td>表</td>

  <td>
    输入类型通过 <code>Class.ContextActionService:BindAction()|BindAction</code> 传递给 Class.ContextActionService:BindAction() 触发
  </td>
</tr>

<tr>
  <td><code>描述</code> ※</td>
  <td>字符串</td>

  <td>
    由 <code>Class.ContextActionService:SetDescription()|SetDescription</code> 设置的动作描述
  </td>
</tr>

<tr>
  <td><code>标题</code> ^</td>
  <td>字符串</td>

  <td>
    通过 <code>Class.ContextActionService:SetTitle()|SetTitle</code> 设置动作集的标题
  </td>
</tr>

<tr>
  <td><code>图像</code> ※</td>
  <td>字符串</td>

  <td>
    由 <code>Class.ContextActionService:SetImage()|SetImage</code> 设置的动作按钮图像
  </td>
</tr>

名称

类型

描述

即使 BindActionAtPriority 未使用，它仍然会包含优先级级别 - 默认为 2000。

※ 表示该方法不会调用，如果与该动作法关联的方法未调用。

参数

actionName: string