Methods

actionEvent(actionID, value) → {Signal}

Parameters:

Returns:

Type: Signal

Example

Report action events as they occur.

var actionNamesForID = {};
var actionNames = Controller.getActionNames();
for (var i = 0, length = actionNames.length; i < length; i++) {
    actionNamesForID[Controller.findAction(actionNames[i])] = actionNames[i];
}

function onActionEvent(action, value) {
    print("onActionEvent() : " + action + " ( " + actionNamesForID[action] + " ) ; " + value);
}

Controller.actionEvent.connect(onActionEvent);

Script.scriptEnding.connect(function () {
    Controller.actionEvent.disconnect(onActionEvent);
});

captureActionEvents()

Example

Disable avatar translation and rotation for a short period.

Script.setTimeout(function () {
    Controller.captureActionEvents();
}, 5000);

Script.setTimeout(function () {
    Controller.releaseActionEvents();
}, 10000);

captureEntityClickEvents()

Example

Disable entity click events for a short period.

Entities.mousePressOnEntity.connect(function (entityID, event) {
    print("Clicked on entity: " + entityID);
});

Script.setTimeout(function () {
    Controller.captureEntityClickEvents();
}, 5000);

Script.setTimeout(function () {
    Controller.releaseEntityClickEvents();
}, 10000);

captureJoystick(joystickID)

Parameters:

Deprecated:

• This function no longer has any effect.

captureKeyEvents(event)

Parameters:

Example

Disable left and right strafing.

var STRAFE_LEFT = { "key": 16777234, isShifted: true };
var STRAFE_RIGHT = { "key": 16777236, isShifted: true };

Controller.captureKeyEvents(STRAFE_LEFT);
Controller.captureKeyEvents(STRAFE_RIGHT);

Script.scriptEnding.connect(function () {
    Controller.releaseKeyEvents(STRAFE_LEFT);
    Controller.releaseKeyEvents(STRAFE_RIGHT);
});

captureMouseEvents()

Example

Disable Controller.Hardware.Keyboard mouse events for a short period.

var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
var mapping = Controller.newMapping(MAPPING_NAME);
mapping.from(Controller.Hardware.Keyboard.MouseX).to(function (x) {
    print("Mouse x = " + x);
});
mapping.from(Controller.Hardware.Keyboard.MouseY).to(function (y) {
    print("Mouse y = " + y);
});
Controller.enableMapping(MAPPING_NAME);
Script.scriptEnding.connect(function () {
    Controller.disableMapping(MAPPING_NAME);
});

Script.setTimeout(function () {
    Controller.captureMouseEvents();
}, 5000);

Script.setTimeout(function () {
    Controller.releaseMouseEvents();
}, 10000);

captureTouchEvents()

captureWheelEvents()

disableMapping(mappingName)

Parameters:

enableMapping(mappingName, enable)

Parameters:

findAction(actionName) → {number}

Parameters:

Returns:

Type: number

Example

Get the ID of the "TranslateY" action. Compare with the property value.

var actionID = Controller.findAction("TranslateY");
print("Action ID = " + actionID);  // 1
print("Property value = " + Controller.Actions.TranslateY);  // 537001728 or similar value.

findDevice(deviceName) → {number}

Parameters:

Returns:

Type: number

Example

Get the ID of the Oculus Touch.

var deviceID = Controller.findDevice("OculusTouch");
print("Device ID = " + deviceID);

getActionNames() → {Array.<string>}

Returns:

Type: Array.<string>

Example

Get the names of all actions.

var actionNames = Controller.getActionNames();
print("Action names: " + JSON.stringify(actionNames));
// ["TranslateX","TranslateY","TranslateZ","Roll", ...

getActions() → {Controller.Actions}

Returns:

Type: Controller.Actions

getActionValue(actionID) → {number}

Parameters:

Returns:

Type: number

Example

Periodically report the value of the "TranslateX" action.

var actionID = Controller.findAction("TranslateX");

function reportValue() {
    print(Controller.getActionValue(actionID));
}
reportTimer = Script.setInterval(reportValue, 1000);

getAllActions() → {Array.<Action>}

Deprecated:

• This function no longer works.

Returns:

Type: Array.<Action>

getAvailableInputs(deviceID) → {Array.<NamedPair>}

Parameters:

Deprecated:

• This function no longer works.

Returns:

Type: Array.<NamedPair>

getAxisValue(source) → {number}

Parameters:

Returns:

Type: number

getAxisValue(source, deviceopt) → {number}

Parameters:

Deprecated:

• This function no longer works.

Returns:

Type: number

getButtonValue(source, deviceopt) → {number}

Parameters:

Deprecated:

• This function no longer works.

Returns:

Type: number

getDeviceName(deviceID) → {string}

Parameters:

Returns:

Type: string

Example

Get the name of the Oculus Touch controller from its ID.

var deviceID = Controller.findDevice("OculusTouch");
print("Device ID = " + deviceID);

var deviceName = Controller.getDeviceName(deviceID);
print("Device name = " + deviceName);

getDeviceNames() → {Array.<string>}

Returns:

Type: Array.<string>

Example

Get the names of all currently available controller devices.

var deviceNames = Controller.getDeviceNames();
print(JSON.stringify(deviceNames));
// ["Standard","Keyboard","LeapMotion","OculusTouch","Application","Actions"] or similar.

getHardware() → {Controller.Hardware}

Returns:

Type: Controller.Hardware

getInputRecorderSaveDirectory() → {string}

Returns:

Type: string

getPoseValue(source) → {Pose}

Parameters:

Returns:

Type: Pose

getPoseValue(source, deviceopt) → {Pose}

Parameters:

Deprecated:

• This function no longer works.

Returns:

Type: Pose

getRecommendedHUDRect() → {Rect}

Returns:

Type: Rect

getStandard() → {Controller.Standard}

Returns:

Type: Controller.Standard

getValue(source) → {number}

Parameters:

Returns:

Type: number

Example

Report the Standard and Vive right trigger values.

var triggerValue = Controller.getValue(Controller.Standard.RT);
print("Trigger value: " + triggerValue);

if (Controller.Hardware.Vive) {
    triggerValue = Controller.getValue(Controller.Hardware.Vive.RT);
    print("Vive trigger value: " + triggerValue);
} else {
    print("No Vive present");
}

getViewportDimensions() → {Vec2}

Returns:

Type: Vec2

hardwareChanged() → {Signal}

Returns:

Type: Signal

inputEvent(action, value) → {Signal}

Parameters:

Returns:

Type: Signal

Example

Report input events as they occur.

var inputNamesForID = {};
for (var property in Controller.Standard) {
    inputNamesForID[Controller.Standard[property]] = "Controller.Standard." + property;
}

function onInputEvent(input, value) {
    print("onInputEvent() : " + input + " ( " + inputNamesForID[input] + " ) ; " + value);
}

Controller.inputEvent.connect(onInputEvent);

Script.scriptEnding.connect(function () {
    Controller.inputEvent.disconnect(onInputEvent);
});

keyPressEvent(event) → {Signal}

Parameters:

Returns:

Type: Signal

Example

Report the KeyEvent details for each key press.

Controller.keyPressEvent.connect(function (event) {
    print(JSON.stringify(event));
});

keyReleaseEvent(event) → {Signal}

Parameters:

Returns:

Type: Signal

loadInputRecording(file)

Parameters:

loadMapping(jsonURL) → {MappingObject}

Parameters:

To Do:

• Implement this function. It currently does not load the mapping from the file; it just returns null.

Returns:

Type: MappingObject

mouseDoublePressEvent(event) → {Signal}

Parameters:

Returns:

Type: Signal

mouseMoveEvent(event) → {Signal}

Parameters:

Returns:

Type: Signal

Example

Report the MouseEvent details for each mouse move.

Controller.mouseMoveEvent.connect(function (event) {
    print(JSON.stringify(event));
});

mousePressEvent(event) → {Signal}

Parameters:

Returns:

Type: Signal

mouseReleaseEvent(event) → {Signal}

Parameters:

Returns:

Type: Signal

newMapping(mappingName) → {MappingObject}

Parameters:

Returns:

Type: MappingObject

Example

Create a simple mapping that makes the right trigger move your avatar up.

var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
var mapping = Controller.newMapping(MAPPING_NAME);

mapping.from(Controller.Standard.RT).to(Controller.Actions.TranslateY);
Controller.enableMapping(MAPPING_NAME);

Script.scriptEnding.connect(function () {
    Controller.disableMapping(MAPPING_NAME);
});

parseMapping(jsonString) → {MappingObject}

Parameters:

Returns:

Type: MappingObject

Example

Create a simple mapping that makes the right trigger move your avatar up.

var mappingJSON = {
    "name": "com.highfidelity.controllers.example.jsonMapping",
    "channels": [
        { "from": "Standard.RT", "to": "Actions.TranslateY" }
    ]
};

var mapping = Controller.parseMapping(JSON.stringify(mappingJSON));
mapping.enable();

Script.scriptEnding.connect(function () {
    mapping.disable();
});

releaseActionEvents()

releaseEntityClickEvents()

releaseJoystick(joystickID)

Parameters:

Deprecated:

• This function no longer has any effect.

releaseKeyEvents(event)

Parameters:

releaseMouseEvents()

releaseTouchEvents()

releaseWheelEvents()

saveInputRecording()

setVPadEnabled(enable)

Parameters:

setVPadExtraBottomMargin(margin)

Parameters:

setVPadHidden(hidden)

Parameters:

startInputPlayback()

Example

Play back a controller recording.

var file = Window.browse("Select Recording", Controller.getInputRecorderSaveDirectory());
if (file !== null) {
    print("Play recording: " + file);
    Controller.loadInputRecording("file:///" + file);
    Controller.startInputPlayback();

    // Stop playback after 20s.
    Script.setTimeout(function () {
        print("Stop playing recording");
        Controller.stopInputPlayback();
    }, 20000);
}

startInputRecording()

Example

Make a controller recording.

// Delay start of recording for 2s.
Script.setTimeout(function () {
    print("Start input recording");
    Controller.startInputRecording();
}, 2000);

// Make a 10s recording.
Script.setTimeout(function () {
    print("Stop input recording");
    Controller.stopInputRecording();
    Controller.saveInputRecording();
    print("Input recording saved in: " + Controller.getInputRecorderSaveDirectory());
}, 12000);

stopInputPlayback()

stopInputRecording()

touchBeginEvent(event) → {Signal}

Parameters:

Returns:

Type: Signal

Example

Report the TouchEvent details when a touch event starts.

Controller.touchBeginEvent.connect(function (event) {
    print(JSON.stringify(event));
});

touchEndEvent(event) → {Signal}

Parameters:

Returns:

Type: Signal

touchUpdateEvent(event) → {Signal}

Parameters:

Returns:

Type: Signal

triggerHapticPulse(strength, duration, hand)

Parameters:

Example

Trigger a haptic pulse on the right hand.

var HAPTIC_STRENGTH = 0.5;
var HAPTIC_DURATION = 10;
var RIGHT_HAND = 1;
Controller.triggerHapticPulse(HAPTIC_STRENGTH, HAPTIC_DURATION, RIGHT_HAND);

triggerHapticPulseOnDevice(deviceID, strength, duration, hand)

Parameters:

Example

Trigger a haptic pulse on an Oculus Touch controller.

var HAPTIC_STRENGTH = 0.5;
var deviceID = Controller.findDevice("OculusTouch");
var HAPTIC_DURATION = 10;
var RIGHT_HAND = 1;
Controller.triggerHapticPulseOnDevice(deviceID, HAPTIC_STRENGTH, HAPTIC_DURATION, RIGHT_HAND);

triggerShortHapticPulse(strength, hand)

Parameters:

triggerShortHapticPulseOnDevice(deviceID, strength, hand)

Parameters:

wheelEvent(event) → {Signal}

Parameters:

Returns:

Type: Signal

Example

Report the WheelEvent details for each wheel rotation.

Controller.wheelEvent.connect(function (event) {
    print(JSON.stringify(event));
});
     

Type Definitions

Actions

Hand

Type:

• number

Hardware

Example

List all the currently available Controller.Hardware properties.

function printProperties(string, item) {
    print(string);
    for (var key in item) {
        if (item.hasOwnProperty(key)) {
            printProperties(string + "." + key, item[key]);
        }
    }
}

printProperties("Controller.Hardware", Controller.Hardware);
 

Hardware-Application

Hardware-Keyboard

To Do:

• Currently, the mouse wheel in an ordinary mouse generates left/right wheel events instead of up/down.

Hardware-OculusTouch

Hardware-Vive

MappingJSON

Type:

• object

Properties:

Example

A simple mapping JSON that makes the right trigger move your avatar up after a dead zone.

{
    "name": "com.highfidelity.controllers.example.jsonMapping",
    "channels": [
        { 
            "from": "Standard.RT", 
            "filters": { "type": "deadZone", "min": 0.05 },
            "to": "Actions.TranslateY"
        }
    ]
}

MappingJSONAxis

Type:

• object

Properties:

Example

An axis using the keyboard's left and right keys.

{ "makeAxis" : [
        ["Keyboard.Left"],
        ["Keyboard.Right"]
    ]
}

MappingJSONFilter

Type:

• object

Properties:

Example

A hysteresis filter.

{ 
    "type": "hysteresis", 
    "min": 0.85, 
    "max": 0.9
}

MappingJSONRoute

Type:

• object

Properties:

Standard