Clarification on documentation for SYNC_STAGE

[chengemily]

Clarification on documentation for SYNC_STAGE

[shakty]

Hi,

This is a feature not used often, since levels have been introduced, so the API needs some refactor and the doc is a bit outdated.

To begin with pull the latest nodegame-client, or install latest dev, otherwise an error will be raised.

Say you have a stage with three steps, you can do the following:

In player.js:

    stager.extendStep('step1', {
        stepRule: stepRules.SOLO,
    });

    stager.extendStep('step2', {
        stepRule: stepRules.SOLO,
    });

    stager.extendStep('step3', {
        stepRule: stepRules.WAIT,
    });

In logic.js

    stager.extendStep('step1', {
        stepRule: stepRules.OTHERS_SYNC_STAGE,
        cb: function() {
            // Prevents to go to next step, instead goes to next stage.
            node.game.breakStage(true);
        }
    });

It is a bit cumbersome, but it will work.

[shakty]

I have updated the doc, it should be clearer now. There is a warning that the API is in refactor and it may change in the next release.

[shakty]

Can I close?

[chengemily]

Great! Thank you! It works.