Oolite Bulletins

Code: Select all

    this.startUp() = function() {
        /* Set true for some logging. */
        this.$logging = false;

        if (missionVariables.your_oxp_snoopers_news) {
            /* Retrieve the snoopers news variable and parse it. */
            this.$newsForSnoopers = JSON.parse(missionVariables.your_oxp_snoopers_news);
        } else {
            this.$newsForSnoopers = {};
        }
    };

    /* NAME
     *   playerWillSaveGame
     *
     * FUNCTION
     *   Player is about to save the game.
     */
    this.playerWillSaveGame = function () {
        /* Stringify the snoopers news variable and store it. */
        missionVariables.your_oxp_snoopers_news = JSON.stringify(this.$newsForSnoopers);
    };

    /* NAME
     *   $sendNewsToSnoopers
     *
     * FUNCTION
     *   Send news to Snoopers (if available).
     *
     * INPUTS
     *   message - news to show
     *   agency - agency to use (optional)
     */
    this.$sendNewsToSnoopers = function (message, agency) {
        var news = {},
        result;

        if (!worldScripts.snoopers) {
            /* Snoopers not installed. */
            return;
        }

        if (!agency || typeof agency !== "number") {
            /* Random agency. [1, 2 or 3] */
            agency = Math.floor(Math.random() * 3.0) + 1;
        }

        news.ID = this.name;
        news.Message = message;
        news.Agency = agency;
        /* Snoopers Documentation on the wiki has a list describing what the result number means.
         * http://wiki.alioth.net/index.php/Snoopers_Doc#Errorcodes
         */
        result = worldScripts.snoopers.insertNews(news);

        if (result < 0) {
            /* Save for later. Snoopers only allows one news item at a time. */
            this.$newsForSnoopers.push(news);

            if (this.$logging) {
                log(this.name, "$sendNewsToSnoopers::Saving news for later.\n" +
                    "* ID: '" + this.name + "'\n" +
                    "* Message: '" + message + "'\n" +
                    "* Agency: " + agency + "\n" +
                    "* result: " + result);
        } else if (result > 0) {
            /* Problem. */
            log(this.name, "$sendNewsToSnoopers::Problem with news.\n" +
                "* ID: '" + this.name + "'\n" +
                "* Message: '" + message + "'\n" +
                "* Agency: " + agency + "\n" +
                "* result: " + result);
        } else {
            /* News inserted. */
            if (this.$logging) {
                log(this.name, "$sendNewsToSnoopers::News inserted.\n" +
                    "* ID: '" + this.name + "'\n" +
                    "* Message: '" + message + "'\n" +
                    "* Agency: " + agency + "\n" +
                    "* result: " + result);
            }
        }
    };

    /* NAME
     *   newsDisplayed
     *
     * FUNCTION
     *   Called by Snoopers when the news item has been displayed.
     *   Check for any more news available and send it.
     */
    this.newsDisplayed = function () {
        var news = this.$newsForSnoopers.shift();

        if (news) {
            /* More news available. Send it to Snoopers. */
            this.$sendNewsToSnoopers(news.Message, news.Agency);
        }
    };