overte/scripts/system/help.js

"use strict";

//
//  help.js
//  scripts/system/
//
//  Created by Howard Stearns on 2 Nov 2016
//  Copyright 2016 High Fidelity, Inc.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
/* globals Tablet, Toolbars, Script, HMD, Controller, Menu */

(function() { // BEGIN LOCAL_SCOPE

    var button;
    var buttonName = "HELP";
    var toolBar = null;
    var tablet = null;
    if (Settings.getValue("HUDUIEnabled")) {
        toolBar = Toolbars.getToolbar("com.highfidelity.interface.toolbar.system");
        button = toolBar.addButton({
            objectName: buttonName,
            imageURL: Script.resolvePath("assets/images/tools/help.svg"),
            visible: true,
            alpha: 0.9
        });
    } else {
        tablet = Tablet.getTablet("com.highfidelity.interface.tablet.system");
        button = tablet.addButton({
            icon: "icons/tablet-icons/help-i.svg",
            text: buttonName
        });
    }
    var enabled = false;
    function onClicked() {
        // Similar logic to Application::showHelp()
        var defaultTab = "kbm";
        var handControllerName = "vive";
        if (HMD.active) {
            if ("Vive" in Controller.Hardware) {
                defaultTab = "handControllers";
                handControllerName = "vive";
            } else if ("OculusTouch" in Controller.Hardware) {
                defaultTab = "handControllers";
                handControllerName = "oculus";
            }
        } else if ("SDL2" in Controller.Hardware) {
            defaultTab = "gamepad";
        }

        if (enabled) {
            Menu.closeInfoView('InfoView_html/help.html');
            enabled = !enabled;
            button.editProperties({isActive: enabled});
        } else {
            Menu.triggerOption('Help...');
            enabled = !enabled;
            button.editProperties({isActive: enabled});
        }
    }

    button.clicked.connect(onClicked);

    var POLL_RATE = 500;
    var interval = Script.setInterval(function () {
        var visible = Menu.isInfoViewVisible('InfoView_html/help.html');
        if (visible !== enabled) {
            enabled = visible;
            button.editProperties({isActive: enabled});
        }
    }, POLL_RATE);

    Script.scriptEnding.connect(function () {
        button.clicked.disconnect(onClicked);
        Script.clearInterval(interval);
        if (tablet) {
            tablet.removeButton(button);
        }
        if (toolBar) {
            toolBar.removeButton(buttonName);
        }
    });

}()); // END LOCAL_SCOPE