reckfellENGINE

Input

Синглтон для обработки входных данных.

На этой странице
class InputReckfellSharp

Синглтон для обработки входных данных.

Синглтон Input обрабатывает нажатия клавиш, кнопки мыши и движение, геймпады и действия ввода. Действия и их события можно задать на вкладке Input Map в Project > Настройки проекта или с помощью класса InputMap. Примечание: Методы Input отражают глобальное состояние ввода и не зависят от Control.AcceptEvent или Viewport.SetInputAsHandled, поскольку эти методы имеют дело только со способом распространения ввода в EntityTree.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Свойства6

EmulateMouseFromTouchСвойство
# EmulateMouseFromTouch
C#
public static bool EmulateMouseFromTouch { get; set; }

Если true, отправляет события ввода мыши при нажатии или пролистывании на сенсорном экране. См. также ProjectSettings.input_devices/pointing/emulate_mouse_from_touch.

EmulateTouchFromMouseСвойство
# EmulateTouchFromMouse
C#
public static bool EmulateTouchFromMouse { get; set; }

Если true, отправляет события сенсорного ввода при щелчке или перетаскивании мыши. См. также ProjectSettings.input_devices/pointing/emulate_touch_from_mouse.

IgnoreJoypadOnUnfocusedApplicationСвойство
# IgnoreJoypadOnUnfocusedApplication
C#
public static bool IgnoreJoypadOnUnfocusedApplication { get; set; }

Если true, ввод с геймпада (включая датчики движения) и изменения светодиодной индикации будут игнорироваться, а вибрация геймпада будет прекращена, когда приложение не находится в фокусе.

MouseModeСвойство
# MouseMode
C#
public static Input.MouseModeEnum MouseMode { get; set; }

Управляет режимом мыши.

SingletonСвойство
# Singleton
C#
public static InputInstance Singleton { get; }
UseAccumulatedInputСвойство
# UseAccumulatedInput
C#
public static bool UseAccumulatedInput { get; set; }

Включает объединение совместимых событий до доставки, например суммирование перемещения нескольких событий мыши. Не объединяет произвольные типы событий и не гарантирует один вызов каждого обработчика за кадр. При false объединение отключено, но agile_event_flushing может сохранять очередь. Изменение свойства не сбрасывает уже накопленные события.

Методы86

ActionPressvoid
# ActionPress
C#
public static void ActionPress(StringName action, float strength = 1f);

Программно переводит существующее действие в нажатое состояние с силой, ограниченной диапазоном 0–1. Влияет на опрос Input, но не отправляет InputEvent в дерево и не вызывает _Input() сам по себе. Для синтетического события используйте ParseInputEvent(); завершайте программное удержание через ActionRelease().

Параметры
ИмяТипПо умолчанию
actionStringName—
strengthfloat1f
ActionReleasevoid
# ActionRelease
C#
public static void ActionRelease(StringName action);

Выпускает указанный элемент ввода, если действие в настоящее время нажатие.

Параметры
ИмяТипПо умолчанию
actionStringName—
AddJoyMappingvoid
# AddJoyMapping
C#
public static void AddJoyMapping(string mapping, bool updateExisting = false);

Добавляет в базу данных и факультативно обновляет уже подключенные устройства новую запись картографирования (в формате SDL). Примечание: Смотрите. Документация SDL для получения дополнительной информации о формате картирования регулятора SDL.

Параметры
ИмяТипПо умолчанию
mappingstring—
updateExistingboolfalse
ClearJoyMotionSensorsCalibrationvoid
# ClearJoyMotionSensorsCalibration
C#
public static void ClearJoyMotionSensorsCalibration(int device);

Очищает информацию о калибровке датчиков движения указанного геймпада, если таковые имеются и были ли они откалиброваны. См. Input.StartJoyMotionSensorsCalibration для примера использования датчиков движения и калибровки геймпада в играх. Примечание: Эта функция поддерживается только в Windows, Linux, macOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
FlushBufferedEventsvoid
# FlushBufferedEvents
C#
public static void FlushBufferedEvents();

Последовательно доставляет события из очереди Input. Может синхронно вызвать обработчики ввода до возврата из метода. Движок также вызывает сброс в своём цикле; явный вызов нужен для контролируемого порядка, а не для универсального ускорения. При пустой очереди не повторяет прошлые события. Не считывает заново физические устройства и не измеряет задержку до дисплея.

GetAccelerometerVector3
# GetAccelerometer
C#
public static Vector3 GetAccelerometer();

Возвращает ускорение в м/с² акселерометрического датчика устройства, если он есть. В противном случае метод возвращает Vector3.Zero. Обратите внимание, что этот метод возвращает пустой Vector3 при запуске из редактора, даже если на вашем устройстве есть акселерометр. Вам необходимо экспортировать свой проект на поддерживаемое устройство, чтобы считать значения с акселерометра. Примечание: Этот метод работает только на Android и iOS. На других платформах он всегда возвращает Vector3.Zero. Примечание: Для Android необходимо включить ProjectSettings.input_devices/sensors/enable_accelerometer.

Возвращает Vector3
GetActionRawStrengthfloat
# GetActionRawStrength
C#
public static float GetActionRawStrength(StringName action, bool exactMatch = false);

Возвращает стоимость между 0.0 и 1.0 В большинстве случаев, вы должны использовать Input.GetActionStrength вместо этого. Если exact_match это false, он игнорирует дополнительные входные изменения для InputEventKey и InputEventMouseButton события и направление InputEventJoypadMotion события.

Параметры
ИмяТипПо умолчанию
actionStringName—
exactMatchboolfalse
Возвращает float
GetActionStrengthfloat
# GetActionStrength
C#
public static float GetActionStrength(StringName action, bool exactMatch = false);

Возвращает стоимость между 0.0 и 1.0 В радужной пачке, например, дальше от оси (аналоговые палочки или спусковые устройства L2, R2) находится от мертвой зоны, чем ближе значение будет к 1.0. Если действие отображается до органа управления, не имеющего оси, подобной клавиатуре, то возвращенное значение будет следующим: 0.0 или 1.0. Если exact_match это false, он игнорирует дополнительные входные изменения для InputEventKey и InputEventMouseButton события и направление InputEventJoypadMotion события.

Параметры
ИмяТипПо умолчанию
actionStringName—
exactMatchboolfalse
Возвращает float
GetAxisfloat
# GetAxis
C#
public static float GetAxis(StringName negativeAction, StringName positiveAction);

Возвращает силу положительного действия минус силу отрицательного. Использует GetActionStrength, поэтому отличается от круговой обработки двух осей в GetVector.

Параметры
ИмяТипПо умолчанию
negativeActionStringName—
positiveActionStringName—
negativeAction

Имя существующего действия отрицательного направления.

positiveAction

Имя существующего действия положительного направления.

Возвращает float

Обычно значение от -1 до 1; ноль может означать отсутствие ввода или взаимную компенсацию двух направлений.

GetConnectedJoypadsReckfell.Collections.Array<int>
# GetConnectedJoypads
C#
public static Reckfell.Collections.Array<int> GetConnectedJoypads();

Возвращает ID устройств, помеченных подключёнными. Не предполагайте, что первый ID равен 0 или сохраняет назначение игроку после переподключения.

Возвращает Reckfell.Collections.Array<int>

Массив текущих подключённых ID; может быть пустым. Синтетическое событие оси само по себе не подтверждает подключение физического устройства.

GetCurrentCursorShapeInput.CursorShape
# GetCurrentCursorShape
C#
public static Input.CursorShape GetCurrentCursorShape();

Возвращает текущую назначенную форму курсора.

Возвращает Input.CursorShape
GetDeviceOrientationQuaternion
# GetDeviceOrientation
C#
public static Quaternion GetDeviceOrientation();

Возвращает направление устройства как Quaternion, с использованием синтеза датчиков аппаратного уровня для получения стабильных, не дрейфующих результатов. Если устройство не поддерживает зондирование ориентации, метод возвращается. Quaternion.Identity. Вернутый кватерион представляет собой вращение от рамы координат устройства до мировой системы координат. В портретном режиме система координат устройства: X право, Y вверх, Z в сторону зрителя. Примечание: Этот метод работает только на Android и iOS. Quaternion.Identity. Примечание: Для Андроида, ProjectSettings.input_devices/sensors/enable_device_orientation Должен быть включён.

Возвращает Quaternion
GetGravityVector3
# GetGravity
C#
public static Vector3 GetGravity();

Возвращает силу тяжести (gravity) в м/с² акселерометрического датчика устройства, если он есть. В противном случае метод возвращает Vector3.Zero. Примечание: Этот метод работает только на Android и iOS. На других платформах он всегда возвращает Vector3.Zero. Примечание: Для Android необходимо включить ProjectSettings.input_devices/sensors/enable_gravity.

Возвращает Vector3
GetGyroscopeVector3
# GetGyroscope
C#
public static Vector3 GetGyroscope();

Возвращает скорость вращения в рад/с вокруг осей X, Y и Z устройства датчика гироскопа, если устройство имеет таковой. В противном случае метод возвращает Vector3.Zero. Примечание: Этот метод работает только на Android и iOS. На других платформах он всегда возвращает Vector3.Zero. Примечание: Для Android ProjectSettings.input_devices/sensors/enable_gyroscope должен быть включен.

Возвращает Vector3
GetJoyAccelerometerVector3
# GetJoyAccelerometer
C#
public static Vector3 GetJoyAccelerometer(int device);

Возвращает ускорение, включая силу тяжести, в м/с2 датчика акселерометра джойстика, если он есть и в настоящее время включен. Vector3.ZeroСм. также Input.GetJoyGravity и Input.SetJoyMotionSensorsEnabled. Для радужной пасты, находящейся перед вами, возвращенные оси определяются следующим образом: +X ... -Х: слева... справа; +Y ... - Y: снизу... сверху; +Z ... - Z: дальше... ближе. Значение части тяжести измеряется как вектор с длиной 9.8 Вдали от центра Земли, что является отрицательным значением Y. Примечание: Эта функция поддерживается только на Windows, Linux, acOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает Vector3
GetJoyAxisfloat
# GetJoyAxis
C#
public static float GetJoyAxis(int device, JoyAxis axis);

Читает сохранённое значение физической оси конкретного устройства. Не применяет мёртвую зону Input Map и не доказывает, что устройство сейчас подключено.

Параметры
ИмяТипПо умолчанию
deviceint—
axisJoyAxis—
device

Текущий ID контроллера, не номер игрока. Для списка подключённых устройств используйте GetConnectedJoypads.

axis

Ось JoyAxis, например LeftX. Направление и назначение проверяйте на целевом устройстве.

Возвращает float

Сохранённое значение оси; при отсутствии записи возвращает 0. Ноль не является проверкой подключения.

GetJoyGravityVector3
# GetJoyGravity
C#
public static Vector3 GetJoyGravity(int device);

Возвращает гравитацию в м/с2 датчика акселерометра джойстика, если он есть и в настоящее время включен. Vector3.ZeroСм. также Input.GetJoyAccelerometer и Input.SetJoyMotionSensorsEnabled. Для радужной пасты, находящейся перед вами, возвращенные оси определяются следующим образом: +X ... -Х: слева... справа; +Y ... - Y: снизу... сверху; +Z ... - Z: дальше... ближе. Значение части тяжести измеряется как вектор с длиной 9.8 Вдали от центра Земли, что является отрицательным значением Y. Примечание: Эта функция поддерживается только на Windows, Linux, acOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает Vector3
GetJoyGuidstring
# GetJoyGuid
C#
public static string GetJoyGuid(int device);

Возвращает совместимый с SDL прибор GUID на платформах, которые используют реминг Gamepad, например. 030000004c050000c405000000010000Reckfell использует внутренние карты SDL, дополняемые картами с участием общины, для определения имен игровых струнок и карт на основе этого GUID.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает string
GetJoyGyroscopeVector3
# GetJoyGyroscope
C#
public static Vector3 GetJoyGyroscope(int device);

Читает калиброванную угловую скорость гироскопа. Перед использованием проверяйте подключение, поддержку датчиков, включение и состояние калибровки.

Параметры
ИмяТипПо умолчанию
deviceint—
device

ID контроллера с подготовленными датчиками.

Возвращает Vector3

Vector3 в радианах в секунду. При отсутствующих данных или игнорировании ввода возвращает ноль; ноль не доказывает неподвижность или отсутствие дрейфа.

GetJoyInfoReckfell.Collections.Dictionary
# GetJoyInfo
C#
public static Reckfell.Collections.Dictionary GetJoyInfo(int device);

Возвращает словарь, содержащий дополнительную информацию о устройстве с конкретной платформой, например имя сырой геймпад из OS или паром Input указатель. На Windows, Linux, acOS и iOS словарь содержит следующие поля: raw_name:: название контроллера, исходящее от OS, перед переименованием в базу данных контроллера. vendor_id:: Идентификационный номер устройства USB-продавца. product_id: Идентификационный номер устройства USB. serial_number: Серийный номер устройства. Этот ключ не будет присутствовать, если серийный номер отсутствует. Словарь может также включать следующие поля в выбранных платформах: steam_input_index:: Пар Input Идентификатор gampad (только Windows, Linux и acOS). Если устройство не является паром Input Этого ключа не будет. xinput_index: Индекс регулятора в системе XInput (только Windows). Этот ключ не будет присутствовать для устройств, не управляемых XInpot. Примечание: Вернутый словарь всегда пуст в Android и Web.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает Reckfell.Collections.Dictionary
GetJoyMotionSensorsCalibrationReckfell.Collections.Dictionary
# GetJoyMotionSensorsCalibration
C#
public static Reckfell.Collections.Dictionary GetJoyMotionSensorsCalibration(int device);

Возвращает информацию о калибровке датчиков движения указанного джойстика в виде Reckfell.Collections.Dictionary, если таковые имеются и если они были откалиброваны; в противном случае возвращает пустой Reckfell.Collections.Dictionary. Словарь содержит следующие поля: gyroscope_offset: среднее смещение значений гироскопа относительно Vector2.Zero в рад/с. См. Input.StartJoyMotionSensorsCalibration для примера использования датчиков движения и калибровки джойстика в ваших играх. Примечание: Эта функция поддерживается только в Windows, Linux, macOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает Reckfell.Collections.Dictionary
GetJoyMotionSensorsRatefloat
# GetJoyMotionSensorsRate
C#
public static float GetJoyMotionSensorsRate(int device);

Возвращает частоту срабатывания датчика движения геймпада в Гц, если геймпад оснащен датчиками движения и они в данный момент включены. См. также Input.SetJoyMotionSensorsEnabled. Примечание: Эта функция поддерживается только в Windows, Linux, macOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает float
GetJoyNamestring
# GetJoyName
C#
public static string GetJoyName(int device);

Возвращает название джойста в указанном индексе устройства, например. PS4 Controller. " Reckfell " использует База данных контроллеров игр SDL чтобы определить имена геймпадов.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает string
GetJoyNumTouchpadsint
# GetJoyNumTouchpads
C#
public static int GetJoyNumTouchpads(int device);

В противном случае метод возвращает количество тачдадов на заданном джойстаде. 0. Примечание: Эта функция поддерживается только на Windows, Linux, acOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает int
GetJoyTouchpadFingerPositionVector2
# GetJoyTouchpadFingerPosition
C#
public static Vector2 GetJoyTouchpadFingerPosition(int device, int finger, int touchpad = 0);

Возвращает положение указанного пальца на указанном тротуаре на джойстике. Значения X и Y, если указанный палец касается указанного пальца, находятся в диапазоне от 0.0 в адрес 1.0, с (0.0, 0.0) отражая левый верхний угол тачдада и (1.0, 1.0) отражает нижний правый угол. Если джойста не имеет указанного тачдада или указанный палец сейчас не касается пальца, этот метод возвращается. Vector2(-1.0, -1.0). Примечание: Эта функция поддерживается только на Windows, Linux, acOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
fingerint—
touchpadint0
Возвращает Vector2
GetJoyTouchpadFingerPressurefloat
# GetJoyTouchpadFingerPressure
C#
public static float GetJoyTouchpadFingerPressure(int device, int finger, int touchpad = 0);

Возвращает давление указанного пальца на указанный тротуар на джойстике. Значение возврата, если указанный палец касается указанного пальца, находится в диапазоне от 0.0 в адрес 1.0. Если джойста не имеет указанного тачдада или указанный палец сейчас не касается пальца, этот метод возвращается. -1.0. Примечание: Эта функция поддерживается только на Windows, Linux, acOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
fingerint—
touchpadint0
Возвращает float
GetJoyTouchpadFingersint[]
# GetJoyTouchpadFingers
C#
public static int[] GetJoyTouchpadFingers(int device, int touchpad = 0);

Возвращает набор идентифицирующих пальцев, которые в настоящее время касаются указанной пальцем пальцы на джойстаде. Если в радужной пачке нет указанного пальца или нет пальцев, то этот метод возвращает пустой массив. Примечание: Чтобы получить положение пальца пальца пальца, используйте Input.GetJoyTouchpadFingerPosition. Примечание: Эта функция поддерживается только на Windows, Linux, acOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
touchpadint0
Возвращает int[]
GetJoyVibrationDurationfloat
# GetJoyVibrationDuration
C#
public static float GetJoyVibrationDuration(int device);

Возвращает длительность текущего эффекта вибрации в секундах. Примечание: Этот метод возвращает то же значение, которое было передано в Input.StartJoyVibration, и это значение не изменяется после окончания вибрации джойстика, оно сбрасывается только после вызова Input.StopJoyVibration. Если вы хотите проверить, продолжает ли вибрировать джойстик, используйте вместо этого Input.IsJoyVibrating.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает float
GetJoyVibrationRemainingDurationfloat
# GetJoyVibrationRemainingDuration
C#
public static float GetJoyVibrationRemainingDuration(int device);

Возвращает оставшуюся продолжительность текущего вибрационного эффекта в секундах.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает float
GetJoyVibrationStrengthVector2
# GetJoyVibrationStrength
C#
public static Vector2 GetJoyVibrationStrength(int device);

Возвращает силу вибрации джойстика: x — сила слабого двигателя, а y — сила сильного двигателя. Примечание: Этот метод возвращает те же значения, которые были переданы в Input.StartJoyVibration, и эти значения не изменяются, когда вибрация джойстика заканчивается, они сбрасываются только после вызова Input.StopJoyVibration. Если вы хотите проверить, продолжает ли вибрировать джойстик, используйте вместо этого Input.IsJoyVibrating.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает Vector2
GetLastMouseScreenVelocityVector2
# GetLastMouseScreenVelocity
C#
public static Vector2 GetLastMouseScreenVelocity();

Возвращает последнюю скорость мыши в координатах экрана. Чтобы обеспечить точную и свободную от дрожания скорость, скорость мыши вычисляется только каждые 0,1 с. Поэтому скорость мыши будет отставать от движений мыши.

Возвращает Vector2
GetLastMouseVelocityVector2
# GetLastMouseVelocity
C#
public static Vector2 GetLastMouseVelocity();

Возвращает последнюю скорость мыши. Чтобы обеспечить точную и свободную от дрожания скорость, скорость мыши вычисляется только каждые 0,1 с. Поэтому скорость мыши будет отставать от движений мыши.

Возвращает Vector2
GetMagnetometerVector3
# GetMagnetometer
C#
public static Vector3 GetMagnetometer();

Возвращает напряженность магнитного поля в микротеслах для всех осей датчика магнитометра устройства, если он есть. В противном случае метод возвращает Vector3.Zero. Примечание: Этот метод работает только на Android и iOS. На других платформах он всегда возвращает Vector3.Zero. Примечание: Для Android необходимо включить ProjectSettings.input_devices/sensors/enable_magnetometer.

Возвращает Vector3
GetMouseButtonMaskMouseButtonMask
# GetMouseButtonMask
C#
public static MouseButtonMask GetMouseButtonMask();

Возвращает кнопки мыши как битовую маску. Если одновременно нажато несколько кнопок мыши, биты суммируются. Эквивалентно DisplayServer.MouseGetButtonState.

Возвращает MouseButtonMask
GetMouseModeInput.MouseModeEnum
# GetMouseMode
C#
public static Input.MouseModeEnum GetMouseMode();
Возвращает Input.MouseModeEnum
GetVectorVector2
# GetVector
C#
public static Vector2 GetVector(StringName negativeX, StringName positiveX, StringName negativeY, StringName positiveY, float deadzone = -1f);

Строит вектор из необработанных сил четырёх действий, применяет круговую мёртвую зону и ограничивает длину единицей. Сохраняет аналоговую величину; не нормализуйте результат безусловно, если нужна неполная скорость.

Параметры
ИмяТипПо умолчанию
negativeXStringName—
positiveXStringName—
negativeYStringName—
positiveYStringName—
deadzonefloat-1f
negativeX

Действие отрицательного направления X, например влево.

positiveX

Действие положительного направления X, например вправо.

negativeY

Действие отрицательного направления Y; в типичной схеме 2D — вверх.

positiveY

Действие положительного направления Y; в типичной схеме 2D — вниз.

deadzone

Круговая мёртвая зона. Отрицательное значение берёт среднее четырёх зон действий. Для явного порога используйте проверенное конечное число от 0 включительно до 1 не включительно.

Возвращает Vector2

Вектор с длиной 0–1. При зоне 0,2 raw-вектор (0,3; 0,4) дал (0,225; 0,3); (1; 1) ограничился единичной длиной. Это не два независимо обработанных GetAxis.

HasJoyLightbool
# HasJoyLight
C#
public static bool HasJoyLight(int device);

Проверяет зарегистрированную возможность подсветки выбранного устройства. Подключение и поддержка других функций проверяются отдельно; наличие API не гарантирует функцию у любого контроллера.

Параметры
ИмяТипПо умолчанию
deviceint—
device

Текущий ID устройства из GetConnectedJoypads, не номер игрока.

Возвращает bool

true при зарегистрированной поддержке; false при отсутствии возможности или неизвестном ID. Отказ для неизвестного ID выполнен в проверке.

HasJoyMotionSensorsbool
# HasJoyMotionSensors
C#
public static bool HasJoyMotionSensors(int device);

Проверяет зарегистрированную возможность датчиков движения выбранного устройства. Подключение и поддержка других функций проверяются отдельно; наличие API не гарантирует функцию у любого контроллера.

Параметры
ИмяТипПо умолчанию
deviceint—
device

Текущий ID устройства из GetConnectedJoypads, не номер игрока.

Возвращает bool

true при зарегистрированной поддержке; false при отсутствии возможности или неизвестном ID. Отказ для неизвестного ID выполнен в проверке.

HasJoyVibrationbool
# HasJoyVibration
C#
public static bool HasJoyVibration(int device);

Проверяет зарегистрированную возможность вибрации выбранного устройства. Подключение и поддержка других функций проверяются отдельно; наличие API не гарантирует функцию у любого контроллера.

Параметры
ИмяТипПо умолчанию
deviceint—
device

Текущий ID устройства из GetConnectedJoypads, не номер игрока.

Возвращает bool

true при зарегистрированной поддержке; false при отсутствии возможности или неизвестном ID. Отказ для неизвестного ID выполнен в проверке.

IsActionJustPressedbool
# IsActionJustPressed
C#
public static bool IsActionJustPressed(StringName action, bool exactMatch = false);

Возвращает true в кадре или физическом такте начала нажатия действия. Несколько чтений в одном такте могут вернуть true; метод не является очередью событий. Если нужно разрешить интерфейсу забрать событие раньше игры, обрабатывайте его в _UnhandledInput().

Параметры
ИмяТипПо умолчанию
actionStringName—
exactMatchboolfalse
Возвращает bool
IsActionJustPressedByEventbool
# IsActionJustPressedByEvent
C#
public static bool IsActionJustPressedByEvent(StringName action, InputEvent @event, bool exactMatch = false);

Returns (Возврат) true когда пользователь * начал* нажатие события действия в текущей кадрах или физике, и первое событие, которое спровоцировало действие пресс в текущей кнопке/физике, было: event. Оно только вернется true на раме или кнопке, которую пользователь нажал на кнопку. Это полезно для кода, который должен работать только один раз при нажатии действия, и действие обрабатывается во время обработки входных данных (например. Entity._Input). Если exact_match это false, он игнорирует дополнительные входные изменения для InputEventKey и InputEventMouseButton события и направление InputEventJoypadMotion события. Примечание: Возвращение true , не означает, что действие нажимается. true все равно будет возвращена, чтобы не пропустить вход. Примечание: Из-за призрака клавиатуры, Input.IsActionJustPressed может вернуться false даже если один из ключей действия нажат. Input примеры в документации для дополнительной информации.

Параметры
ИмяТипПо умолчанию
actionStringName—
eventInputEvent—
exactMatchboolfalse
Возвращает bool
IsActionJustReleasedbool
# IsActionJustReleased
C#
public static bool IsActionJustReleased(StringName action, bool exactMatch = false);

Возвращает true, когда пользователь прекращает нажатие на событие действия в текущем кадре или такте физики. Возвращает true только в том кадре или такте, когда пользователь отпускает кнопку. Примечание: Возвращение true не означает, что действие ещё не нажато. Действие можно быстро отпустить и снова нажать, и true всё равно будет возвращено, чтобы не пропустить ввод. Если exact_match равен false, он игнорирует дополнительные модификаторы ввода для событий InputEventKey и InputEventMouseButton, а также направление для событий InputEventJoypadMotion. Примечание: Во время обработки входных данных (например, Entity._Input) используйте InputEvent.IsActionReleased для запроса состояния действия текущего события. См. также Input.IsActionJustReleasedByEvent.

Параметры
ИмяТипПо умолчанию
actionStringName—
exactMatchboolfalse
Возвращает bool
IsActionJustReleasedByEventbool
# IsActionJustReleasedByEvent
C#
public static bool IsActionJustReleasedByEvent(StringName action, InputEvent @event, bool exactMatch = false);

Возвращает true, когда пользователь прекращает нажатие кнопки действия в текущем кадре или такте физики, и первым событием, вызвавшим отпускание кнопки в текущем кадре/такте физики, было event. Возвращает true только в том кадре или такте, когда пользователь отпускает кнопку. Это полезно, когда действие обрабатывается во время обработки ввода (например, Entity._Input). Примечание: Возврат true не означает, что действие ещё не нажато. Действие можно быстро отпустить и снова нажать, и true всё равно будет возвращён, чтобы не пропустить ввод. Если exact_match равен false, он игнорирует дополнительные модификаторы ввода для событий InputEventKey и InputEventMouseButton, а также направление для событий InputEventJoypadMotion.

Параметры
ИмяТипПо умолчанию
actionStringName—
eventInputEvent—
exactMatchboolfalse
Возвращает bool
IsActionPressedbool
# IsActionPressed
C#
public static bool IsActionPressed(StringName action, bool exactMatch = false);

Сообщает, удерживается ли действие Input Map. Это опрос состояния, а не обработка одного события; вызов не расходует нажатие. Для однократной реакции используйте IsActionJustPressed() или событие в _UnhandledInput(). Принятое интерфейсом событие не блокирует этот опрос автоматически.

Параметры
ИмяТипПо умолчанию
actionStringName—
exactMatchboolfalse
Возвращает bool
IsAnythingPressedbool
# IsAnythingPressed
C#
public static bool IsAnythingPressed();

Возвращает true, если нажато какое-либо действие, клавиша, кнопка джойстика или кнопка мыши. Это также вернет true, если какое-либо действие имитируется через код путем вызова Input.ActionPress.

Возвращает bool
IsEmulatingMouseFromTouchbool
# IsEmulatingMouseFromTouch
C#
public static bool IsEmulatingMouseFromTouch();
Возвращает bool
IsEmulatingTouchFromMousebool
# IsEmulatingTouchFromMouse
C#
public static bool IsEmulatingTouchFromMouse();
Возвращает bool
IsIgnoringJoypadOnUnfocusedApplicationbool
# IsIgnoringJoypadOnUnfocusedApplication
C#
public static bool IsIgnoringJoypadOnUnfocusedApplication();
Возвращает bool
IsJoyButtonPressedbool
# IsJoyButtonPressed
C#
public static bool IsJoyButtonPressed(int device, JoyButton button);

Возвращает true, если вы нажимаете кнопку джойстика по индексу button. Примечание: Если вы хотите проверить, была ли только что нажата кнопка джойстика, используйте систему действий ввода Reckfell с помощью Input.IsActionJustPressed или используйте метод Entity._Input следующим образом:

C#
public override void _Input(InputEvent @event)
{
    if (@event is InputEventJoypadButton eventButton && eventButton.Pressed && eventButton.ButtonIndex == JoyButton.A)
    {
        // Your code here.
    }
}
Параметры
ИмяТипПо умолчанию
deviceint—
buttonJoyButton—
Возвращает bool
IsJoyKnownbool
# IsJoyKnown
C#
public static bool IsJoyKnown(int device);

Возвращает true, если система знает указанное устройство. Это означает, что она устанавливает все индексы кнопок и осей. Неизвестные джойстики не должны соответствовать этим константам, но вы все равно можете извлекать из них события.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает bool
IsJoyMotionSensorsAutoCalibrationEnabledbool
# IsJoyMotionSensorsAutoCalibrationEnabled
C#
public static bool IsJoyMotionSensorsAutoCalibrationEnabled(int device);

Returns (Возврат) true если автоматическая калибровка включена на датчиках движения джойстика. Автоматическая калибровка допускается по умолчанию. См. также Input.SetJoyMotionSensorsAutoCalibrationEnabled. Примечание: Эта функция поддерживается только на Windows, Linux, acOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает bool
IsJoyMotionSensorsCalibratedbool
# IsJoyMotionSensorsCalibrated
C#
public static bool IsJoyMotionSensorsCalibrated(int device);

Читает флаг завершённой/заданной калибровки. Это не оценка качества неподвижности: StopJoyMotionSensorsCalibration выставляет флаг после завершения процедуры.

Параметры
ИмяТипПо умолчанию
deviceint—
device

ID устройства, состояние которого проверяется.

Возвращает bool

Текущее значение флага; false при отсутствии данных датчиков. Даже true требует проверки дрейфа на реальном устройстве.

IsJoyMotionSensorsCalibratingbool
# IsJoyMotionSensorsCalibrating
C#
public static bool IsJoyMotionSensorsCalibrating(int device);

Returns (Возврат) true если датчики движения джойста в настоящее время калибруются вручную. Смотрите. Input.StartJoyMotionSensorsCalibration для примера о том, как использовать датчики движения и калибровку в ваших играх. Примечание: Эта функция поддерживается только на Windows, Linux, acOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает bool
IsJoyMotionSensorsEnabledbool
# IsJoyMotionSensorsEnabled
C#
public static bool IsJoyMotionSensorsEnabled(int device);

Returns (Возврат) true если в требуемом джойстике есть датчики движения (гироскоп и/или акселерометр) и они включены. См. также Input.SetJoyMotionSensorsEnabled и Input.HasJoyMotionSensors. Смотрите. Input.StartJoyMotionSensorsCalibration для примера о том, как использовать датчики движения и калибровку в ваших играх. Примечание: Эта функция поддерживается только на Windows, Linux, acOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает bool
IsJoyVibratingbool
# IsJoyVibrating
C#
public static bool IsJoyVibrating(int device);

Возвращает true, если джойстик продолжает вибрировать после вызова Input.StartJoyVibration. В отличие от Input.GetJoyVibrationStrength и Input.GetJoyVibrationDuration, этот метод возвращает false после того, как вибрация джойстика прекращается.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает bool
IsKeyLabelPressedbool
# IsKeyLabelPressed
C#
public static bool IsKeyLabelPressed(Key keycode);

Возвращает true, если вы нажимаете клавишу с напечатанным на ней keycode. Вы можете передать константу Key или любой код символа Unicode. Примечание: Если вы хотите проверить, была ли только что нажата клавиша, используя её метку, используйте систему действий ввода Reckfell с помощью Input.IsActionJustPressed или используйте метод Entity._Input следующим образом:

C#
public override void _Input(InputEvent @event)
{
    if (@event is InputEventKey eventKey && !eventKey.IsEcho() && eventKey.Pressed && eventKey.KeyLabel == Key.Space)
    {
        // Your code here.
    }
}
Параметры
ИмяТипПо умолчанию
keycodeKey—
Возвращает bool
IsKeyPressedbool
# IsKeyPressed
C#
public static bool IsKeyPressed(Key keycode);

Returns (Возврат) true Если вы нажимаете латинский ключ в текущей компоновке клавиатуры. Вы можете пройти Key Постоянно. Input.IsKeyPressed рекомендуется только пересчитать Input.IsPhysicalKeyPressed Это гарантирует, что ключи будут вести себя так, как ожидалось, в зависимости от конфигурации клавиатуры пользователя, поскольку клавиши клавиш обычно зависят от компоновки клавиш в неигровых приложениях. Input.IsPhysicalKeyPressed. Примечание: Из-за призрака клавиатуры, Input.IsKeyPressed может вернуться false даже если один из ключей действия нажат. Input примеры в документации для дополнительной информации. Примечание: Если вы хотите проверить, был ли ключ нажат с помощью его кода, используйте систему ввода данных Reckfell с Input.IsActionJustPressed или использовать Entity._Input Вместо этого:

C#
public override void _Input(InputEvent @event)
{
    if (@event is InputEventKey eventKey && !eventKey.IsEcho() && eventKey.Pressed && eventKey.Keycode == Key.Space)
    {
        // Your code here.
    }
}
Параметры
ИмяТипПо умолчанию
keycodeKey—
Возвращает bool
IsMouseButtonPressedbool
# IsMouseButtonPressed
C#
public static bool IsMouseButtonPressed(MouseButton button);

Возвращает true, если вы нажимаете кнопку мыши, указанную в MouseButton. Примечание: Если вы хотите проверить, была ли только что нажата кнопка мыши, используйте систему действий ввода Reckfell с помощью Input.IsActionJustPressed или используйте метод Entity._Input следующим образом:

C#
public override void _Input(InputEvent @event)
{
    if (@event is InputEventMouseButton eventMouseButton && eventMouseButton.Pressed && eventMouseButton.ButtonIndex == MouseButton.Left)
    {
        // Your code here.
    }
}
Параметры
ИмяТипПо умолчанию
buttonMouseButton—
Возвращает bool
IsPhysicalKeyPressedbool
# IsPhysicalKeyPressed
C#
public static bool IsPhysicalKeyPressed(Key keycode);

Returns (Возврат) true Если вы нажимаете ключ в физическом месте на клавиатуре 101/102-ключ США QWERTY. Вы можете пройти через кнопку. Key Постоянно. Input.IsPhysicalKeyPressed рекомендуется пересчитать Input.IsKeyPressed для игровых действий, как это будет делать Input.IsPhysicalKeyPressed также обеспечит, чтобы ключи верхнего ряда работали на любой компоновке клавиатуры. Input.IsPhysicalKeyPressed. Примечание: Из-за призрака клавиатуры, Input.IsPhysicalKeyPressed может вернуться false даже если один из ключей действия нажат. Input примеры в документации для дополнительной информации. Примечание: Если вы хотите проверить, был ли ключ нажат с помощью его физического кода, используйте систему ввода данных Reckfell с Input.IsActionJustPressed или использовать Entity._Input Вместо этого:

C#
public override void _Input(InputEvent @event)
{
    if (@event is InputEventKey eventKey && !eventKey.IsEcho() && eventKey.Pressed && eventKey.PhysicalKeycode == Key.Space)
    {
        // Your code here.
    }
}
Параметры
ИмяТипПо умолчанию
keycodeKey—
Возвращает bool
IsUsingAccumulatedInputbool
# IsUsingAccumulatedInput
C#
public static bool IsUsingAccumulatedInput();

Читает флаг UseAccumulatedInput. Не сообщает, пуста ли очередь событий или какова физическая задержка ввода.

Возвращает bool

Текущее значение флага объединения событий. false не означает отсутствия любой буферизации.

ParseInputEventvoid
# ParseInputEvent
C#
public static void ParseInputEvent(InputEvent @event);

Подает InputEvent в игру. Может использоваться для искусственного запуска событий ввода из кода. Также генерирует вызовы Entity._Input.

C#
var cancelEvent = new InputEventAction();
cancelEvent.Action = "ui_cancel";
cancelEvent.Pressed = true;
Input.ParseInputEvent(cancelEvent);

Примечание: Звонок на эту функцию не влияет на операционную систему. InputEventMouseMotion не будет двигать OS курсор мыши в указанное положение (использование) Input.WarpMouse вместо этого) и отправке InputEventKey Не будет болтать между активными окнами.

Параметры
ИмяТипПо умолчанию
eventInputEvent—
RemoveJoyMappingvoid
# RemoveJoyMapping
C#
public static void RemoveJoyMapping(string guid);

Удаляет все сопоставления из внутренней базы данных, которые соответствуют данному GUID. Все подключенные в данный момент джойпады, которые используют этот GUID, станут не сопоставленными. На Андроид Reckfell будет сопоставлен с внутренним резервным сопоставлением.

Параметры
ИмяТипПо умолчанию
guidstring—
SetAccelerometervoid
# SetAccelerometer
C#
public static void SetAccelerometer(Vector3 value);

Устанавливает значение ускорения акселерометрического датчика. Может использоваться для отладки на устройствах без аппаратного датчика, например, в редакторе на ПК. Примечание: Это значение может быть немедленно перезаписано значением аппаратного датчика на Android и iOS.

Параметры
ИмяТипПо умолчанию
valueVector3—
SetCustomMouseCursorvoid
# SetCustomMouseCursor
C#
public static void SetCustomMouseCursor(Resource image, Input.CursorShape shape = Input.CursorShape.Arrow, Vector2? hotspot = default);

Устанавливает изображение выбранного системного слота курсора. Пустой ресурс сбрасывает слот к системному виду. Не выбирает форму для каждого Control и не делает скрытый/захваченный курсор видимым. При Engine.IsEditorHint вызов пропускается.

Параметры
ИмяТипПо умолчанию
imageResource—
shapeInput.CursorShapeInput.CursorShape.Arrow
hotspotVector2?default
image

Image или Texture2D с изображением. Общий предел — 256×256; целевые платформы проверяйте отдельно. Используйте прозрачность и импорт без потерь. Пустой ресурс нужен для сброса, а не пустой Image.

shape

Слот CursorShape, по умолчанию Arrow. Замена Ibeam не меняет изображение Arrow.

hotspot

Точка клика внутри изображения, по умолчанию (0, 0). Используйте конечные координаты существующего пикселя; обвязка CursorTheme отклоняет отрицательные и граничные значения.

SetDefaultCursorShapevoid
# SetDefaultCursorShape
C#
public static void SetDefaultCursorShape(Input.CursorShape shape = Input.CursorShape.Arrow);

Устанавливает форму курсора по умолчанию для использования в области просмотра вместо Input.CursorShape.Arrow. Примечание: Если вы хотите изменить форму курсора по умолчанию для узлов Control, используйте вместо этого Control.MouseDefaultCursorShape. Примечание: Этот метод генерирует InputEventMouseMotion для немедленного обновления курсора.

Параметры
ИмяТипПо умолчанию
shapeInput.CursorShapeInput.CursorShape.Arrow
SetDeviceOrientationvoid
# SetDeviceOrientation
C#
public static void SetDeviceOrientation(Quaternion value);

Устанавливает кватер ориентации устройства. Может использоваться для отладки устройств без датчика аппаратных средств, например в редакторе на ПК. Примечание: Это значение может быть немедленно перезаписано значением датчика аппаратных средств на Android и iOS.

Параметры
ИмяТипПо умолчанию
valueQuaternion—
SetEmulateMouseFromTouchvoid
# SetEmulateMouseFromTouch
C#
public static void SetEmulateMouseFromTouch(bool enable);
Параметры
ИмяТипПо умолчанию
enablebool—
SetEmulateTouchFromMousevoid
# SetEmulateTouchFromMouse
C#
public static void SetEmulateTouchFromMouse(bool enable);
Параметры
ИмяТипПо умолчанию
enablebool—
SetGravityvoid
# SetGravity
C#
public static void SetGravity(Vector3 value);

Устанавливает значение силы тяжести (gravity) акселерометрического датчика. Может использоваться для отладки на устройствах без аппаратного датчика, например, в редакторе на ПК. Примечание: Это значение может быть немедленно перезаписано значением аппаратного датчика на Android и iOS.

Параметры
ИмяТипПо умолчанию
valueVector3—
SetGyroscopevoid
# SetGyroscope
C#
public static void SetGyroscope(Vector3 value);

Устанавливает значение скорости вращения датчика гироскопа. Может использоваться для отладки на устройствах без аппаратного датчика, например в редакторе на ПК. Примечание: Это значение может быть немедленно перезаписано значением аппаратного датчика на Android и iOS.

Параметры
ИмяТипПо умолчанию
valueVector3—
SetIgnoreJoypadOnUnfocusedApplicationvoid
# SetIgnoreJoypadOnUnfocusedApplication
C#
public static void SetIgnoreJoypadOnUnfocusedApplication(bool enable);
Параметры
ИмяТипПо умолчанию
enablebool—
SetJoyLightvoid
# SetJoyLight
C#
public static void SetJoyLight(int device, Color color);

Устанавливает цвет светодиода джойстика (если он есть). См. также Input.HasJoyLight. Примечание: Получить цвет подсветки джойстика невозможно. Если вам необходимо знать назначенный цвет, сохраните его отдельно. Примечание: Эта функция поддерживается только в Windows, Linux, macOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
colorColor—
SetJoyMotionSensorsAutoCalibrationEnabledvoid
# SetJoyMotionSensorsAutoCalibrationEnabled
C#
public static void SetJoyMotionSensorsAutoCalibrationEnabled(int device, bool enable);

Включает или отключает автоматическую калибровку гироскопа джойста. Автоматическая калибровка допускается по умолчанию, так что большинство игр не должны называть это или выполнять любую калибровку. В процессе работы калибровка гироскопа постоянно совершенствуется всякий раз, когда обнаруживается, что джойстик удерживается неподвижно, что постепенно смягчает коррекцию. Это устраняет необходимость специальной калибровки в большинстве игр и соответствует калибровочному дрейфу, например от регулятора нагревания во время игры. Если автоматическая калибровка отключена, последние калиброванные значения остаются в силе. Примечание: Эта функция поддерживается только на Windows, Linux, acOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
enablebool—
SetJoyMotionSensorsCalibrationvoid
# SetJoyMotionSensorsCalibration
C#
public static void SetJoyMotionSensorsCalibration(int device, Reckfell.Collections.Dictionary calibrationInfo);

Задает информацию о калибровке указанного джойстика. См. также Input.GetJoyMotionSensorsCalibration. См. Input.StartJoyMotionSensorsCalibration для примера использования датчиков движения и калибровки джойстика в играх. Примечание: Эта функция поддерживается только в Windows, Linux, macOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
calibrationInfoReckfell.Collections.Dictionary—
SetJoyMotionSensorsEnabledvoid
# SetJoyMotionSensorsEnabled
C#
public static void SetJoyMotionSensorsEnabled(int device, bool enable);

Просит интерфейс устройства включить или выключить датчики. Не создаёт поддержку у неизвестного ID и не выполняет калибровку автоматически. Не отключайте датчики, которыми продолжает пользоваться другая система.

Параметры
ИмяТипПо умолчанию
deviceint—
enablebool—
device

Текущий ID контроллера с поддержкой датчиков.

enable

true для включения, false для выключения. Проверяйте IsJoyMotionSensorsEnabled отдельно.

SetMagnetometervoid
# SetMagnetometer
C#
public static void SetMagnetometer(Vector3 value);

Устанавливает значение магнитного поля датчика магнитометра. Может использоваться для отладки на устройствах без аппаратного датчика, например в редакторе на ПК. Примечание: Это значение может быть немедленно перезаписано значением аппаратного датчика на Android и iOS.

Параметры
ИмяТипПо умолчанию
valueVector3—
SetMouseModevoid
# SetMouseMode
C#
public static void SetMouseMode(Input.MouseModeEnum mode);
Параметры
ИмяТипПо умолчанию
modeInput.MouseModeEnum—
SetUseAccumulatedInputvoid
# SetUseAccumulatedInput
C#
public static void SetUseAccumulatedInput(bool enable);

Устанавливает тот же флаг, что UseAccumulatedInput. Отключение не доставляет уже накопленные события и не гарантирует немедленную доставку при отдельно включённом agile_event_flushing.

Параметры
ИмяТипПо умолчанию
enablebool—
enable

true — объединять совместимые события; false — не объединять новые. Не меняет отдельную настройку agile_event_flushing.

ShouldIgnoreDevicebool
# ShouldIgnoreDevice
C#
public static bool ShouldIgnoreDevice(int vendorId, int productId);

Вопрос о том, следует ли игнорировать устройство ввода данных. SDL_GAMECONTROLLER_IGNORE_DEVICESСм. Документация SDL для дополнительной информации. Примечание: Некоторые инструменты третьей стороны могут внести свой вклад в список проигнорированных устройств. Например, SteamInput создаёт виртуальные устройства из физических устройств для ремаптации. Чтобы избежать дваждыго обращения с одним и тем же входным устройством, оригинальное устройство добавляется в список проигнорированных устройств.

Параметры
ИмяТипПо умолчанию
vendorIdint—
productIdint—
Возвращает bool
StartJoyMotionSensorsCalibrationvoid
# StartJoyMotionSensorsCalibration
C#
public static void StartJoyMotionSensorsCalibration(int device);

Начинает процесс ручной калибровки гироскопа указанного джойста, если он есть. После правильной калибровки гироскопа джойста (например, лежащего на столе без поворачивания), Input.GetJoyGyroscope возвратит значения, близкие или равные Vector3.Zero когда радостная пачка не будет свернута. Поскольку гироскоп калибруется автоматически по умолчанию (см. Input.SetJoyMotionSensorsAutoCalibrationEnabled), большинство игр не нуждаются в калибровке вручную. Если автоматическая калибровка включена, она задерживается, пока ручная калибровка продолжается, и возобновляется, когда Input.StopJoyMotionSensorsCalibration зовутся. Вот пример того, как использовать гироскоп и гироскоп в ваших играх:

C#
private const float GyroSensitivity = 10.0;

public override void _Ready()
{
    // In this example we only use the first connected joypad (id 0).
    if (!Input.GetConnectedJoypads().Contains(0))
    {
        return;
    }

    if (!Input.HasJoyMotionSensors(0))
    {
        return;
    }

    // We must enable the accelerometer and the gyroscope before using them.
    Input.SetJoyMotionSensorsEnabled(0, true);

    // (Tell the users here that they need to put their joypads on a flat surface and wait for confirmation.)

    // Start the calibration process.
    CalibrateMotion();
}

public override void _Process(double delta)
{
    // Only move the object if the joypad motion sensors are calibrated.
    if (Input.IsJoyMotionSensorsCalibrated(0))
    {
        MoveObject(delta);
    }
}

private async Task CalibrateMotion()
{
    Input.StartJoyMotionSensorsCalibration(0);

    // Wait for some time.
    await ToSignal(GetTree().CreateTimer(1.0), EntityTreeTimer.SignalName.Timeout);

    Input.StopJoyMotionSensorsCalibration(0);
    // The joypad is now calibrated.
}

private void MoveObject(double delta)
{
    Entity3D node = ... ; // Put your object here.
    Vector3 gyro = Input.GetJoyGyroscope(0);
    Vector3 rotation = node.Rotation;
    rotation.X -= -gyro.Y * GyroSensitivity * (float)delta; // Use rotation around the Y axis (yaw) here.
    rotation.Y += -gyro.X * GyroSensitivity * (float)delta; // Use rotation around the X axis (pitch) here.
    node.Rotation = rotation;
}

Примечание: Акселерометр обычно не требует калибровки. Примечание: Эта функция поддерживается только в Windows, Linux, macOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
StartJoyVibrationvoid
# StartJoyVibration
C#
public static void StartJoyVibration(int device, float weakMagnitude, float strongMagnitude, float duration = 0f);

Записывает запрос вибрации для устройства; это не подтверждение движения моторов. Перед вызовом проверяйте подключение, HasJoyVibration и конечность чисел. Для единичного события отправляйте одну команду, а не повторяйте её каждый кадр.

Параметры
ИмяТипПо умолчанию
deviceint—
weakMagnitudefloat—
strongMagnitudefloat—
durationfloat0f
device

ID выбранного подключённого контроллера.

weakMagnitude

Интенсивность слабого мотора 0–1. Учебная обвязка дополнительно отклоняет NaN и бесконечность.

strongMagnitude

Интенсивность сильного мотора 0–1; это отдельный канал, а не длительность.

duration

Длительность в секундах. Задавайте положительное конечное значение. Значение 0 по умолчанию не гарантирует бесконечность: текущий SDL-бэкенд преобразует его в 65 535 мс.

StopJoyMotionSensorsCalibrationvoid
# StopJoyMotionSensorsCalibration
C#
public static void StopJoyMotionSensorsCalibration(int device);

Останавливает процесс ручной калибровки указанных датчиков движения джойстика. Смотрите. Input.StartJoyMotionSensorsCalibration для примера о том, как использовать датчики движения и калибровку в ваших играх. Примечание: Эта функция поддерживается только на Windows, Linux, acOS и iOS.

Параметры
ИмяТипПо умолчанию
deviceint—
StopJoyVibrationvoid
# StopJoyVibration
C#
public static void StopJoyVibration(int device);

Записывает нулевые интенсивности для остановки вибрации выбранного устройства. Не является подтверждением получения команды оборудованием.

Параметры
ИмяТипПо умолчанию
deviceint—
device

ID устройства, для которого отправляется остановка.

VibrateHandheld2 перегрузки
# VibrateHandheld · 1/2
C#
public static void VibrateHandheld(int durationMs);

Начинает вибрировать портативное устройство на указанную продолжительность в миллисекундах. amplitude - прочность вибрации в качестве значения между 0.0 и 1.0. В случае установки -1.0, используется сила вибрации устройства по умолчанию. Примечание: Этот метод применяется на Android, iOS и Web. Примечание: Для Андроида, Input.VibrateHandheld :: обеспечение возможности VIBRATE В противном случае, Input.VibrateHandheld не даст никакого эффекта. Примечание: Для iOS указание продолжительности поддерживается только в iOS 13 и позднее. Примечание: Для Интернета амплитуда не может быть изменена. Примечание: Некоторые веб-браузеры, такие как Safari и Firefox для Android, не поддерживают Input.VibrateHandheld. Примечание: Такие параметры устройства, как вибрация включена/выключена, режим "не потревожить" или конкретная хаптимическая обратная связь могут предотвратить Input.VibrateHandheld эффекты.

Параметры
ИмяТипПо умолчанию
durationMsint—
# VibrateHandheld · 2/2
C#
public static void VibrateHandheld(int durationMs = 500, float amplitude = -1f);

Начинает вибрировать портативное устройство на указанную продолжительность в миллисекундах. amplitude - прочность вибрации в качестве значения между 0.0 и 1.0. В случае установки -1.0, используется сила вибрации устройства по умолчанию. Примечание: Этот метод применяется на Android, iOS и Web. Примечание: Для Андроида, Input.VibrateHandheld :: обеспечение возможности VIBRATE В противном случае, Input.VibrateHandheld не даст никакого эффекта. Примечание: Для iOS указание продолжительности поддерживается только в iOS 13 и позднее. Примечание: Для Интернета амплитуда не может быть изменена. Примечание: Некоторые веб-браузеры, такие как Safari и Firefox для Android, не поддерживают Input.VibrateHandheld. Примечание: Такие параметры устройства, как вибрация включена/выключена, режим "не потревожить" или конкретная хаптимическая обратная связь могут предотвратить Input.VibrateHandheld эффекты.

Параметры
ИмяТипПо умолчанию
durationMsint500
amplitudefloat-1f
WarpMousevoid
# WarpMouse
C#
public static void WarpMouse(Vector2 position);

Устанавливает положение мыши к указанному вектору, содержащемуся в пикселях и относительно происхождения в верхнем левом углу текущего фокуса Window Окно для менеджера. Положение мыши сжимается до пределов разрешения экрана или пределов окна игры, если Input.MouseModeEnum установлен следующим образом: Input.MouseModeEnum.Confined или Input.MouseModeEnum.ConfinedHidden. Примечание: Input.WarpMouse Она не влияет на Android, iOS и Web.

Параметры
ИмяТипПо умолчанию
positionVector2—

Сигналы и события1

JoyConnectionChangedСобытие
# JoyConnectionChanged
C#
public static event Input.JoyConnectionChangedEventHandler JoyConnectionChanged;

Издается при подключении или отключении джойстика.

Параметры обработчика
ИмяТипПо умолчанию
devicelong—
connectedbool—

Input.CursorShape

ЗначениеОписание
Arrow = 0

Курсор-стрелка. Стандартный, указывающий курсор по умолчанию.

Bdiagsize = 11

Window пересчитать курсор мыши. Этот курсор является двуглавой стрелкой, которая двигается от нижнего левого к верхнему правому. Она говорит пользователю, что они могут изменить размер окна или панели как горизонтально, так и вертикально.

Busy = 5

Занятый курсор. Указывает, что приложение занято выполнением операции и что оно все еще может использоваться во время операции.

CanDrop = 7

Можно отпустить курсор. Обычно отображается при перетаскивании чего-либо, чтобы указать, что его можно отпустить в текущей позиции.

Cross = 3

Перекрестный курсор. Обычно появляется над областями, в которых можно выполнить операцию рисования или для выделения.

Drag = 6

Курсор перетаскивания. Обычно отображается при перетаскивании чего-либо. Примечание: В Windows отсутствует курсор перетаскивания, поэтому Input.CursorShape.Drag совпадает с Input.CursorShape.Move для этой платформы.

Fdiagsize = 12

Window курсор мыши - двуглавая стрелка, которая идет от верхней левой к нижней правой, противоположная стрелке Input.CursorShape.BdiagsizeОн говорит пользователю, что они могут изменить размер окна или панели как горизонтально, так и вертикально.

Forbidden = 8

Запрещенный курсор. Указывает, что текущее действие запрещено (например, при перетаскивании чего-либо) или что элемент управления в позиции отключен.

Help = 16

Курсор помощи. Обычно вопросительный знак.

Hsize = 10

Курсор мыши для изменения размера по горизонтали. Двунаправленная горизонтальная стрелка. Сообщает пользователю, что он может изменять размер окна или панели по горизонтали.

Hsplit = 15

Горизонтальный разделенный курсор мыши. В Windows это то же самое, что Input.CursorShape.Hsize.

Ibeam = 1

Курсор в виде I-образной линии. Обычно используется для указания того, где появится текстовый курсор при щелчке мыши.

КУРСОР Топоминания

Move = 13

Переместить курсор. Указывает, что что-то можно переместить.

PointingHand = 2

Курсор в виде указывающей руки. Обычно используется для обозначения того, что указатель находится над ссылкой или другим интерактивным элементом.

Vsize = 9

Вертикальное изменение размера курсора мыши. Двунаправленная вертикальная стрелка. Сообщает пользователю, что он может изменять размер окна или панели по вертикали.

КУРСОР

Vsplit = 14

Вертикальный разделенный курсор мыши. В Windows это то же самое, что Input.CursorShape.Vsize.

Wait = 4

Курсор ожидания. Указывает, что приложение занято выполнением операции и что оно не может быть использовано во время операции (например, что-то блокирует его основной поток).

Input.MouseModeEnum

ЗначениеОписание
Captured = 2

Мышь будет спрятана, а ее положение заперто в центре окна менеджера. Примечание: Если вы хотите обработать движение мыши в этом режиме, вам нужно использовать InputEventMouseMotion.Relative или InputEventMouseMotion.ScreenRelative. Примечание: Даже при поимке курсор мыши может нажать на кнопку, если она пересекается с центром окна.

Confined = 3

Ограничивает курсор мыши окном игры и делает его видимым.

ConfinedHidden = 4

Ограничивает курсор мыши окном игры и делает его скрытым.

Hidden = 1

Делает курсор мыши скрытым, если он виден.

Max = 5

Максимальное значение Input.MouseModeEnum.

Visible = 0

Делает курсор мыши видимым, если он скрыт.

Документация Reckfell EngineНаверх ↑
БЫСТРЫЙ ПЕРЕХОДНачало работыEntity и иерархияC# & .NET 10Сцены и префабы
Руководства и полный API Reckfell K
reckfellENGINE
RECKFELL ACCOUNT

Вход в аккаунт

Войдите в аккаунт Reckfell.

Один аккаунт для всей платформы Reckfell.