How to Get Started

To get started on using the turn system, you must download the folder, locate the folder inside src folder, and include the API javascript files in the index.html in the project.

Add the following lines above your scene files in the index.html:

<script type="text/javascript" src="src/TurnSystemAPI/Settings.js"></script>
<script type="text/javascript" src="src/TurnSystemAPI/TurnSystem.js"></script>
<script type="text/javascript" src="src/TurnSystemAPI/UserState.js"></script>
<script type="text/javascript" src="src/TurnSystemAPI/Action.js"></script>

Initialize the TurnSystem in Scene

To initialize the turn system in the scene, you must have following parameters:
 - turntype ('timed', 'conditional', 'priority')
 - max number of player in the game.

Do the following 4 steps to initialize the turn system:

1. Construct the Setting.Builder class:

const settingsBuilder = new Settings.Builder();
settingsBuilder.setTurnType(this.mTurnType);
settingsBuilder.setMaxUsers(this.mMaxPlayers);

2. Set parameters based on turn type (Description in later section)

3. Construct the Setting object using the Setting.Builder object:

const settings = settingsBuilder.build();

4. Construct the TurnSystem object using the Setting object:

this.turnSystem = new TurnSystem(settings);

How to Set Timed Turn-Type

const settingsBuilder = new Settings.Builder();
settingsBuilder.setTurnType('timed');
settingsBuilder.setTurnTime(60);

How to Set Conditional Turn-Type

To set the parameters for conditional turn-type, the developer must provide a conditional function to pass into the Setting.Builder object.
This function must return true to move onto the next player and return false to stay as current player's turn.

Set the conditional function by passing the function into Setting.Builder object:

const settingsBuilder = new Settings.Builder();
settingsBuilder.setTurnType('conditional');
settingsBuilder.setCallbackFunction(conditionalFunction);

Tips: If the user object is extended from UserState, turn isMetCondition to true when condition is made. For condition function, pass a function that return isMetCondition. TurnSystem will reset isMetCondition when condition is true.

How to Set Priority Turn-Type

const settingsBuilder = new Settings.Builder();
settingsBuilder.setTurnType('priority');
settings.builder.setCallbackFunction((usersArr) => userArr.sort());

How to Add and Remove Players

To add players, the developer can self-define a user object that extends from the UserState class and add the user object to the turn system.

const user = new UserState();
this.turnSystem.addUser(user);

To remove a specific player, the developer can get the user object by index inside the TurnSystem storage. The developer should use some self-define parameters to locate specific user and then remove the user from the system by:

const lastPlayer = this.turnSystem.getUserByIndex(this.numPlayers - 1);
this.turnSystem.removeUser(lastPlayer);

How to Switch Turns

To check if it is time to switch turns based on the turn type. Call the function to calculate if it is time to switch turn:

this.turnSystem.calculateNextTurn();