Finch Logo

Documentation

FinchVR - script

Namespace: Finch

Inherited from UnityEngine.MonoBehaviour

Description

Initializes Finch controllers in corresponding to the settings mode of operation. Provides Finch Unity API. Raise FinchVR.OnFinchUpdate event. There is data update at the WaitForEndOfFrame time. After FinchControllerElement.ButtonZero has been pressed more than 1 second, corresponding Finch controller arm is being calibrated.

Fields

Modificator Type Name Description
static readonly FinchController LeftController Left FinchController
static readonly FinchController RightController Right FinchController
static readonly PlayerState State Keeps last update frame controller data

Properties

Modificator Type Name Description
static FinchController MainController Main hand FinchController
static FinchController OptionalController Off-hand FinchController

Events

Modificator Type Name Description
static OnFinchUpdateEvent OnFinchUpdate Is raised every Finch controller data update at the WaitForEndOfFrame time

Methods

Modificator Return type Name Arguments Description
static FinchController GetFinchController FinchChirality chirality Returns certain chirality FinchController
static FinchNodesState GetNodesState - Returns nodes state: connected nodes list, data correctness, etc
static float GetBatteryCharge FinchNodeType nodeType Returns node charge level from 0 to 100
static void Calibrate FinchChirality chirality Calibrates certain chirality arm with FinchSettings.RecenterMode
static void Recenter FinchChirality chirality Recenters certain chirality arm with FinchSettings.RecenterMode
static void HapticPulse FinchNodeType type, uint millisecond Sends vibration signal to the node. There will be vibration in certain milliseconds time, but not more than 2500 ms
static void HapticPulse FinchNodeType type, params VibrationPackage[] millisecond Sends instructions pack for vibration engine to the node. Every next instruction will be work after previous one end