InputObject
非推奨を表示
*このコンテンツは、ベータ版のAI（人工知能）を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。
インプットオブジェクト は、マウスの移動、タッチ、キープレスなどの単一ユーザーの入力を表します。インプットが開始すると作成されます。
このオブジェクトのプロパティは、UserInputType によって変化します。それぞれの入力種類は、その UserInputState にさまざまな変更を受けます。入力の期間中、入力をさらに説明する他のプロパティが変更される可能性があります(例: Position および Delta )。キーボードとゲームパッドのボタン押しには、KeyCode プロパティセットがありま設定する。
入力の開始時に作成された同じオブジェクトは、入力が終了するまで同じままであり、更新されます。結果として、ユーザーが入力を変更すると、Changed イベントを使用してオブジェクトの変更を追跡できます。これらのオブジェクトをアクティブな入力トラックのリストに配置し、UserInputService.InputBegan のようなイベントによって作成後のオブジェクトと対話することもできます。これは主にタッチイベントに有用で、各タッチポイントには別の入力オブジェクトがあります。
参照してください：
- ContextActionService , がインプットオブジェクトを bound アクションハンドリング機能にパス
- UserInputService , イベントと機能の多くが InputObject を使用する
- GuiObject , ユーザーの入力に関連するイベントを使用する InputObject
コードサンプル
次の例では、タイプに応じて InputBegan からユーザーの入力を処理する多くの使用例の 1つを示しています。
インプットの処理開始
-- インプットビギンイベントを使用するには、ユーザー輸入サービスサービスを使用する必要があります
local UserInputService = game:GetService("UserInputService")
-- さまざまな種類のユーザー入力に対する複数の使用ケースを提供するサンプル機能
UserInputService.InputBegan:Connect(function(input, gameProcessed)
if input.UserInputType == Enum.UserInputType.Keyboard then
print("A key is being pushed down! Key:", input.KeyCode)
elseif input.UserInputType == Enum.UserInputType.MouseButton1 then
print("The left mouse button has been pressed down at", input.Position)
elseif input.UserInputType == Enum.UserInputType.MouseButton2 then
print("The right mouse button has been pressed down at", input.Position)
elseif input.UserInputType == Enum.UserInputType.Touch then
print("A touchscreen input has started at", input.Position)
elseif input.UserInputType == Enum.UserInputType.Gamepad1 then
print("A button is being pressed on a gamepad! Button:", input.KeyCode)
end
if gameProcessed then
print("The game engine internally observed this input!")
else
print("The game engine did not internally observe this input!")
end
end)概要
プロパティ
マウス/ジョイスティック移動の間のデルタを説明する Vector3。
使用された入力の種類を説明する Enum を含みます。
この入力の位置値を説明します。
入力が実行されている状態を説明し、UserInputType に基づいて特定のフローに従って行われます。
実行中の入力の種類 (マウス、キーボード、ゲームパッド、タッチなど) を説明します。
方法
プロパティ
Delta
A Vector3 マウス/ジョイスティック移動の間のデルタ (変更) を説明する。
これは、入力の position と一緒に使用すると、カスタム移動またはカメラスクリプトを作成しているときなど、ユーザーのマウス/ジョイスティックの位置と動作を追跡するのに便利です。Object.Changed イベントまたは UserInputService.InputChanged および GuiObject.InputChanged などのイベントを介してユーザーが入力を変更するときに、トラッキング輸入オブジェクトの変更を考慮します。
左クリックと右クリックに対応する （左クリック）と （右クリック）は、 （マウス入力が終了するときを除き）、 または が更新されることはありません。マウス入力の更新デルタを取得するには、代わりに InputObject コールバックから、または InputChanged から呼び出して、GetMouseDelta() を参照する必要があります。しかし、タッチ入力に対応する InputObjects は、ライフタイム中にすべてのフレームでデルタと位置が更新されます。
参照してください：
コードサンプル
この例では、プレイヤーの FieldOfView() と MouseDeltaSensitivity() が減少する binoculars スクリプトを作成します。プレイヤーが MouseEnabled() を左クリックしたとき。スクリプトはまた、プレイヤーの Camera マウスクリックの世界位置に向かって Vector3 を指します。
プレイヤーが再びマウスクリックをしたとき、プレイヤーのカメラは、プレイヤーがスクリプトでズームした前と同じ視野と Enum.CameraType を持つカスタム CFrame() に戻ります。
プレイヤーが望遠鏡を使用している間、スクリプトはプレイヤーのマウスを画面の中央にロックするように設定し、プレイヤーの MouseBehavior() をロックセンターに設定します。プレイヤーがマウスを移動すると、プレイヤーのカメラが InputObject.Delta 属性によって移動し、マウスの InputChanged() 画面位置の変更を指示する Vector2 を示します。
この例が期待通りに機能するには、LocalScript に配置する必要があります。
望遠鏡スクリプトを作成する
local UserInputService = game:GetService("UserInputService")
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local character = player.CharacterAdded:Wait()
local head = character:WaitForChild("Head", false)
local mouse = player:GetMouse()
local zoomed = false
local camera = game.Workspace.CurrentCamera
local target = nil
local originalProperties = {
FieldOfView = nil,
_CFrame = nil,
MouseBehavior = nil,
MouseDeltaSensitivity = nil,
}
local AngleX, TargetAngleX = 0, 0
local AngleY, TargetAngleY = 0, 0
-- ズームする前にカメラを CFrame と FieldOfView に戻す
local function ResetCamera()
target = nil
camera.CameraType = Enum.CameraType.Custom
camera.CFrame = originalProperties._CFrame
camera.FieldOfView = originalProperties.FieldOfView
UserInputService.MouseBehavior = originalProperties.MouseBehavior
UserInputService.MouseDeltaSensitivity = originalProperties.MouseDeltaSensitivity
end
local function ZoomCamera()
-- スクリプトでカメラを変更できるようにする
camera.CameraType = Enum.CameraType.Scriptable
-- ズーム前にカメラプロパティを保存する
originalProperties._CFrame = camera.CFrame
originalProperties.FieldOfView = camera.FieldOfView
originalProperties.MouseBehavior = UserInputService.MouseBehavior
originalProperties.MouseDeltaSensitivity = UserInputService.MouseDeltaSensitivity
-- カメラをズームする
target = mouse.Hit.Position
local eyesight = head.Position
camera.CFrame = CFrame.new(eyesight, target)
camera.Focus = CFrame.new(target)
camera.FieldOfView = 10
-- マウスをロックして減速させる
UserInputService.MouseBehavior = Enum.MouseBehavior.LockCenter
UserInputService.MouseDeltaSensitivity = 1
-- ズーム角をリセット
AngleX, TargetAngleX = 0, 0
AngleY, TargetAngleY = 0, 0
end
-- カメラズーム/ズーム解除を切り替え
local function MouseClick()
if zoomed then
-- カメラをズーム解除
ResetCamera()
else
-- カメラをズームする
ZoomCamera()
end
zoomed = not zoomed
end
local function MouseMoved(input)
if zoomed then
local sensitivity = 0.6 -- より高いものは、上下を探すのが難しくなります; 0~1 の間のものを推奨します
local smoothness = 0.05 -- 0~1 の間の何かを推奨する
local delta = Vector2.new(input.Delta.x / sensitivity, input.Delta.y / sensitivity) * smoothness
local X = TargetAngleX - delta.y
local Y = TargetAngleY - delta.x
TargetAngleX = (X >= 80 and 80) or (X <= -80 and -80) or X
TargetAngleY = (Y >= 80 and 80) or (Y <= -80 and -80) or Y
AngleX = AngleX + (TargetAngleX - AngleX) * 0.35
AngleY = AngleY + (TargetAngleY - AngleY) * 0.15
camera.CFrame = CFrame.new(head.Position, target)
* CFrame.Angles(0, math.rad(AngleY), 0)
* CFrame.Angles(math.rad(AngleX), 0, 0)
end
end
local function InputBegan(input, _gameProcessedEvent)
if input.UserInputType == Enum.UserInputType.MouseButton1 then
MouseClick()
end
end
local function InputChanged(input, _gameProcessedEvent)
if input.UserInputType == Enum.UserInputType.MouseMovement then
MouseMoved(input)
end
end
if UserInputService.MouseEnabled then
UserInputService.InputBegan:Connect(InputBegan)
UserInputService.InputChanged:Connect(InputChanged)
endKeyCode
使用された入力の種類を説明する Enum.KeyCode 枚数を含みます。キーボードのような入力の種類では、これはどのキーが押されたかを説明します。マウスのような入力の場合、これに追加情報はありません。
枚数
| 名前 |
|---|
参照してください：
コードサンプル
この例では、ナビゲーションゲームパッドのリストと、サポートされている Enum.KeyCodes のリストが取得されます。次に、サポートされる KeyCode リストを順回しし、ボタンX および X キーをゲームパッドを使用してサポートされている場合、ContextActionService を使用して機能にバインドします。
バインディングサポートゲームパッドのキーコード
local UserInputService = game:GetService("UserInputService")
local ContextActionService = game:GetService("ContextActionService")
local function actionHandler(actionName, inputState, inputObject)
if inputState == Enum.UserInputState.Begin then
print("Action Handler: " .. actionName)
print(inputObject)
end
-- この機能は何も返さないので、このハンドラーは
-- 「シンク」入力を保存し、その後他のアクションハンドラーは呼ばれません
-- これ。
end
local navGamepads = UserInputService:GetNavigationGamepads()
for _, gamepad in pairs(navGamepads) do
local supportedKeyCodes = UserInputService:GetSupportedGamepadKeyCodes(gamepad)
for _, keycode in pairs(supportedKeyCodes) do
if keycode == Enum.KeyCode.ButtonX then
ContextActionService:BindAction("SampleAction", actionHandler, false, Enum.KeyCode.ButtonX)
end
if keycode == Enum.KeyCode.X then
ContextActionService:BindAction("SampleAction", actionHandler, false, Enum.KeyCode.X)
end
end
endPosition
このプロパティは、この入力の Vector3 位置値を説明します。
マウスとタッチ入力の場合、これは X と Y コンポーネントで説明されているマウス/タッチの画面位置です。トップバーからの GUI 要素への挿入 (など) は、位置に含まれます。
マウスホイール入力の場合、Z コンポーネントは、ホイールが前方に移動したか (1)、後方に移動したか (-1)、または全く移動しなかったか (0) を説明します。
For Enum.KeyCode 入力の場合、これはプレイヤーの Mouse の位置を示します。
左クリックと右クリックに対応する （左クリック）と （右クリック）は、 （マウス入力が終了するときを除き）、 または が更新されることはありません。マウスの入力に対する更新された位置を取得するには、代わりに InputObject から InputChanged コールバック、または GetMouseLocation() を呼び出す必要があります。しかし、タッチ入力に対応する InputObjects は、ライフタイム中にすべてのフレームでデルタと位置が更新されます。
参照してください also
コードサンプル
次の例では、タイプに応じて InputBegan からユーザーの入力を処理する多くの使用例の 1つを示しています。
インプットの処理開始
-- インプットビギンイベントを使用するには、ユーザー輸入サービスサービスを使用する必要があります
local UserInputService = game:GetService("UserInputService")
-- さまざまな種類のユーザー入力に対する複数の使用ケースを提供するサンプル機能
UserInputService.InputBegan:Connect(function(input, gameProcessed)
if input.UserInputType == Enum.UserInputType.Keyboard then
print("A key is being pushed down! Key:", input.KeyCode)
elseif input.UserInputType == Enum.UserInputType.MouseButton1 then
print("The left mouse button has been pressed down at", input.Position)
elseif input.UserInputType == Enum.UserInputType.MouseButton2 then
print("The right mouse button has been pressed down at", input.Position)
elseif input.UserInputType == Enum.UserInputType.Touch then
print("A touchscreen input has started at", input.Position)
elseif input.UserInputType == Enum.UserInputType.Gamepad1 then
print("A button is being pressed on a gamepad! Button:", input.KeyCode)
end
if gameProcessed then
print("The game engine internally observed this input!")
else
print("The game engine did not internally observe this input!")
end
end)UserInputState
ユーザーインプット状態 は、UserInputType。同じ名前の枚数を使用します、Enum.UserInputState。枚挙ページで、このプロパティの可能なすべての値のリストを見ることができます。
参照してください：
コードサンプル
この例では、ナビゲーションゲームパッドのリストと、サポートされている Enum.KeyCodes のリストが取得されます。次に、サポートされる KeyCode リストを順回しし、ボタンX および X キーをゲームパッドを使用してサポートされている場合、ContextActionService を使用して機能にバインドします。
バインディングサポートゲームパッドのキーコード
local UserInputService = game:GetService("UserInputService")
local ContextActionService = game:GetService("ContextActionService")
local function actionHandler(actionName, inputState, inputObject)
if inputState == Enum.UserInputState.Begin then
print("Action Handler: " .. actionName)
print(inputObject)
end
-- この機能は何も返さないので、このハンドラーは
-- 「シンク」入力を保存し、その後他のアクションハンドラーは呼ばれません
-- これ。
end
local navGamepads = UserInputService:GetNavigationGamepads()
for _, gamepad in pairs(navGamepads) do
local supportedKeyCodes = UserInputService:GetSupportedGamepadKeyCodes(gamepad)
for _, keycode in pairs(supportedKeyCodes) do
if keycode == Enum.KeyCode.ButtonX then
ContextActionService:BindAction("SampleAction", actionHandler, false, Enum.KeyCode.ButtonX)
end
if keycode == Enum.KeyCode.X then
ContextActionService:BindAction("SampleAction", actionHandler, false, Enum.KeyCode.X)
end
end
endUserInputType
ユーザーインプットタイプ は、マウス、キーボード、タッチ、またはゲームパッドの入力など、この InputObject がどのような入力を表現しているかを説明するプロパティです。同じ名前の枚数を使用します、Enum.UserInputType。枚挙ページで、このプロパティの可能なすべての値のリストを見ることができます。
参照してください：
コードサンプル
次の例では、タイプに応じて InputBegan からユーザーの入力を処理する多くの使用例の 1つを示しています。
インプットの処理開始
-- インプットビギンイベントを使用するには、ユーザー輸入サービスサービスを使用する必要があります
local UserInputService = game:GetService("UserInputService")
-- さまざまな種類のユーザー入力に対する複数の使用ケースを提供するサンプル機能
UserInputService.InputBegan:Connect(function(input, gameProcessed)
if input.UserInputType == Enum.UserInputType.Keyboard then
print("A key is being pushed down! Key:", input.KeyCode)
elseif input.UserInputType == Enum.UserInputType.MouseButton1 then
print("The left mouse button has been pressed down at", input.Position)
elseif input.UserInputType == Enum.UserInputType.MouseButton2 then
print("The right mouse button has been pressed down at", input.Position)
elseif input.UserInputType == Enum.UserInputType.Touch then
print("A touchscreen input has started at", input.Position)
elseif input.UserInputType == Enum.UserInputType.Gamepad1 then
print("A button is being pressed on a gamepad! Button:", input.KeyCode)
end
if gameProcessed then
print("The game engine internally observed this input!")
else
print("The game engine did not internally observe this input!")
end
end)