ContextActionService

方法

BindAction(actionName : string,functionToBind : function,createTouchButton : boolean,inputTypes : Tuple):()
ユーザーの入力をアクション処理機能にバインドして、アクションを実行する。
BindActionAtPriority(actionName : string,functionToBind : function,createTouchButton : boolean,priorityLevel : number,inputTypes : Tuple):()
BindAction のように振る舞いますが、重複する入力タイプのバインドアクションに優先順位を割り当てることもできます (上から下へ)。
BindActivate(userInputTypeForActivation : Enum.UserInputType,keyCodesForActivation : Tuple):()
特定の Enum.KeyCode を使用して、Enum.UserInputType と Tool.Activation イベントをトリガーするために、ClickDetector をバインドします。
GetAllBoundActionInfo():Dictionary
すべてのバインドアクション (キーはに渡された名前、値はで呼び出されたときのテーブル) に関する情報のテーブルを取得します (キーはで呼び出されるときの値です)。
GetBoundActionInfo(actionName : string):Dictionary
バインドされたアクションの名前が最初にパスされた情報のテーブルを取得するBindAction。
GetCurrentLocalToolIcon():string
現在 BackpackItem.TextureId に戻す Tool の equipped によって Player 。
SetDescription(actionName : string,description : string):()
タッチボタンでバインドされたアクションの名前を指定して、アクションの説明を設定します。
SetImage(actionName : string,image : string):()
actionName キーにバインドアクションが含まれている場合、image はタッチボタンの操作像として設定されます。
SetPosition(actionName : string,position : UDim2):()
タッチボタンでバインドされたアクションの名前を指定して、コンテキストボタンフレーム内のボタンの位置を設定します。
SetTitle(actionName : string,title : string):()
タッチボタンでバインドされたアクションの名前を指定すると、ボタンに表示されるテキストを設定します。
UnbindAction(actionName : string):()
名前を指定されたアクションをバインド解除します。
UnbindActivate(userInputTypeForActivation : Enum.UserInputType,keyCodeForActivation : Enum.KeyCode):()
バインド中に Enum.KeyCode を特定の Enum.UserInputType で解除して、Tool.Activation をトリガーするときにバインドする ContextActionService:BindActivate() と一致させる。
UnbindAllActions():()
バインドされたすべての機能を削除します。アクション名は残りません。すべてのタッチボタンが削除されます。
GetButton(actionName : string):Instance
イールド
タッチ入力ボタンが作成された ImageButton アクションの bound を取得します。

イベント

LocalToolEquipped(toolEquipped : Instance):RBXScriptSignal
現在のプレイヤーが Tool を装備するときに発火します。
LocalToolUnequipped(toolUnequipped : Instance):RBXScriptSignal
現在のプレイヤーが Tool を装備解除するときに発火します。

プロパティ

方法

BindAction

()

アクションを処理機能に渡されたユーザー入力にバインドします。一致する入力が実行されると、以下の引数でアクション処理機能が呼び出されます。有効な入力の列挙アイテムには、フォロー中の内容が含まれます：Enum.KeyCode、Enum.UserInputType または Enum.PlayerActions 。プレイヤーがコンテキストにアクションを実行できる状態に入ると、この関数を呼び出します。プレイヤーがコンテキストを離れると、同じ UnbindAction で actionName を呼び出します。CallFunction を使用して、アクションのアクション処理関数を手動で呼び出すことができます。

以下のコードサンプルでは、キー ( H )、ゲームパッドボタン、またはタッチスクリーンボタンを押している間に Sound がどのように played になるかを示しています。


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

アクションハンドラーパラメータ

アクションハンドラーの機能は、次のパラメータで呼び出されます：


<th>種類</th>

  <th>説明</th>
</tr>

<tr>
  <td>1</td>

  <td><code>文字列</code></td>

  <td>元々 BindAction に渡された同じ文字列†</td>
</tr>

<tr>
  <td>2</td>

  <td><code>Enum.UserInput状態</code></td>

  <td>入力の状態(開始、変更、終了またはキャンセル)*</td>
</tr>

<tr>
  <td>3</td>

  <td><code>入力オブジェクト</code></td>

  <td>入力に関する情報を含むオブジェクト (UserInputType によって変わる)</td>
</tr>

† 必要に応じて、1つの機能が複数のアクションを一度に処理できるようにします。*キャンセルは、一部の入力が進行中であり、他のアクションが進行中の入力にバインドされているか、進行中のバインドアクションが unbound である場合に送信されます。

アクションバインドスタック

アクションバインドはスタックのように動作します：2つのアクションが同じユーザー入力にバインドされている場合、最も最近バインドされたアクションハンドラーが使用されます。アクションハンドラーが Enum.ContextActionResult.Pass を返すと、次に最も最近にバインドされたアクションハンドラーが呼び出され、その後、ハンドラーが入力をシンクするまで続きます (nil または Enum.ContextActionResult.Sink を返すなど)。When UnbindAction が呼ばれると、アクションハンドラーはスタックから削除されます。このスタック動作は、BindActionAtPriority でオーバーライドでき、createTouchButton の後の追加の優先度パラメータで、アクションのバインド順序が上書きされる可能性があります (上から下へ)。

タッチボタン

入力タイプに加えて、この関数の第 3 パラメータは、ボタンが TouchEnabled 装置用に作成されるかどうかを制御します。最初のタッチボタンの作作品に際して、 ContextActionGui という名前のがに追加されます。ScreenGui の内部には、Frame と呼ばれる「コンテキストボタンフレーム」が追加されます。バインドアクションが親になるのは、このフレームです; を使用して、カスタマイズのためにそのボタンを回収できます。

パラメータ

actionName: string

実行中のアクションを表す文字列 (例: "HonkHorn" または "OpenDoor")。

既定値: ""

functionToBind: function

バインド入力がトリガーされたときに次のパラメータで呼び出されるアクション処理関数、string (actionName)、Enum.UserInputState および InputObject。

既定値: ""

createTouchButton: boolean

タッチ入力デバイスのアクションに対する GUI ボタンを作成するかどうか。

既定値: ""

inputTypes: Tuple

バインドするアクションに対する入力を表す Enum.KeyCode または Enum.UserInputType の数の任意。

既定値: ""

戻り値

()

コードサンプル

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

()

BindActionAtPriority は BindAction のように動作しますが、バインドアクションに優先順位が割り当てられることも許可します。複数のアクションが同じ入力にバインドされている場合、アクションのバインド順序に関係なく、優先度の高い機能が呼び出されます。言い換えれば、この機能は BindAction の通常の「スタック」操作作を上書きします。

パラメータ

actionName: string

実行中のアクションを表す文字列 (例: "HonkHorn" または "OpenDoor")。

既定値: ""

functionToBind: function

バインド入力がトリガーされたときに次のパラメータで呼び出されるアクション処理関数、string (actionName)、Enum.UserInputState および InputObject。

既定値: ""

createTouchButton: boolean

タッチ入力デバイスのアクションに対する GUI ボタンを作成するかどうか。

既定値: ""

priorityLevel: number

アクションがバインドされる優先度レベル（低いものよりも高い）。

既定値: ""

inputTypes: Tuple

バインドするアクションに対する入力を表す Enum.KeyCode または Enum.UserInputType の数字の任意の数。

既定値: ""

戻り値

()

コードサンプル

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

()

バインド a Enum.KeyCode は、Enum.UserInputType で使用でき、ClickDetector イベント、Tools 、および GuiButtons を有効にすることができます。指定されたキー/ボタンが押されると、マウスに送信されたイベントが発動します。これにより、Tool.Activated イベントが発動し、Tool.ManualActivationOnly が真に設定されていない場合があります。ゲームパッド入力の場合、この機能は ButtonR2 Enum.KeyCode をバインドするためにデフォルトの制御スクリプトによって呼び出されます。

指定された Enum.UserInputType は有効であるために Keyboard または Gamepad1 を介して Gamepad8 を通過する必要があることに注意してください。

パラメータ

userInputTypeForActivation: Enum.UserInputType

ゲームパッド8を通じてキーボードまたはゲームパッド1である必要があります。

既定値: ""

keyCodesForActivation: Tuple

既定値: ""

戻り値

()

GetAllBoundActionInfo

GetAllBoundActioninfo は、すべてのアクションの名前 (元々はに送信されたもの) をアクション名そのもので呼び出されたときに返されるテーブルにマップするテーブルを返します。この機能を使用すると、現在バインドされているすべてのアクションを調べることができます。優先度レベルやスタックオーダーをデバッグするときに便利です。

戻り値

GetBoundActionInfo

GetBoundActionInfo は、名前を指定されたバインドアクションを記述する次のキーを持つテーブルを返します。すべてのアクションについて一度に同じ情報を取得するには、GetAllBoundActionInfo を使用します。


<th>種類</th>

  <th>説明</th>
</tr>

<tr>
  <td><code>スタックオーダー</code></td>  <td>番号</td>

  <td>
    スタック上のアクションのインデックス (増加) を説明する
  </td>
</tr>

<tr>
  <td><code>優先度レベル</code> \*</td>   <td>数</td>

  <td>
    アクションの <code>Class.ContextActionService:BindActionAtPriority()|priority</code> レベルを説明す操作
  </td>
</tr>

<tr>
  <td><code>createTouchButton</code></td>  <td>ブール</td>

  <td>
    タッチボタンが <code>Class.UserInputService.TouchEnabled|TouchEnabled</code> デバイスで作成されるべきかどうかを説明します
  </td>
</tr>

<tr>
  <td><code>入力タイプ</code></td>  <td>テーブル</td>

  <td>
    このアクションがトリガーされるために <code>Class.ContextActionService:BindAction()|BindAction</code> に渡された入力タイプ
  </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 です。

† 関連するメソッドが指定されたアクションに呼ばれなかった場合、このフィールドは nil になることを示します。

パラメータ

actionName: string

既定値: ""

戻り値