This is a documentation for Board Game Arena: play board games online !

Main game logic: Game.php

From Board Game Arena
Revision as of 16:27, 27 July 2021 by Een (talk | contribs) (→‎Player elimination: Not to be used for zombies)
Jump to navigation Jump to search


Game File Reference


Useful Components

Official

  • Deck: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
  • Draggable: a JS component to manage drag'n'drop actions.
  • Counter: a JS component to manage a counter that can increase/decrease (ex: player's score).
  • ExpandableSection: a JS component to manage a rectangular block of HTML than can be displayed/hidden.
  • Scrollmap: a JS component to manage a scrollable game area (useful when the game area can be infinite. Examples: Saboteur or Takenoko games).
  • Stock: a JS component to manage and display a set of game elements displayed at a position.
  • Zone: a JS component to manage a zone of the board where several game elements can come and leave, but should be well displayed together (See for example: token's places at Can't Stop).

Undocumented component (if somebody knows please help with docs)

  • Wrapper: a JS component to wrap a <div> element around its child, even if these elements are absolute positioned.

Unofficial


Game Development Process


Guides for Common Topics


Miscellaneous Resources

This is the main file for your game logic. Here you initialize the game, persist data, implement the rules and notify the client interface of changes.

File Structure

The details of how the file is structured are described directly with comments in the code skeleton provided to you.

Here is the basic structure:

  • Constructor: where you define global variables.
  • setupNewGame: initial setup of the game. Takes an array of players, indexed by player_id. Structure of each player includes player_name, player_canal, player_avatar, and flags indicating admin/ai/premium/order/language/beginner.
  • getAllDatas: where you retrieve all game data during a complete reload of the game. Returned value must include ['players'][playerId]['score'] for scores to populate when F5 is pressed.
  • getGameProgression: where you compute the game progression indicator. Returns a number indicating percent of progression (0-100)
  • Utility functions: your utility functions.
  • Player actions: the entry points for players actions (more info here).
  • Game state arguments: methods to return additional data on specific game states (more info here).
  • Game state actions: the logic to run when entering a new game state (more info here).
  • zombieTurn: what to do it's the turn of a zombie player.
  • upgradeTableDb: function to migrate database if you change it after release on production.

Accessing player information

Important: In the following methods, be mindful of the difference between the "active" player and the "current" player. The active player is the player whose turn it is - not necessarily the player who sent a request! The current player is the player who sent the request and will see the results returned by your methods: not necessarily the player whose turn it is!


getPlayersNumber()
Returns the number of players playing at the table
Note: doesn't work in setupNewGame (use count($players) instead).
getActivePlayerId()
Get the "active_player", whatever what is the current state type.
Note: it does NOT mean that this player is active right now, because state type could be "game" or "multiplayer"
Note: avoid using this method in a "multiplayer" state because it does not mean anything.
getActivePlayerName()
Get the "active_player" name
Note: avoid using this method in a "multiplayer" state because it does not mean anything.
getPlayerNameById($player_id)
Get the name by id
getPlayerColorById($player_id)
Get the color by id
getPlayerNoById($player_id)
Get 'player_no' (number) by id


loadPlayersBasicInfos()
Get an associative array with generic data about players (ie: not game specific data).
The key of the associative array is the player id. The returned table is cached, so ok to call multiple times without performance concerns.
The content of each value is:
* player_name - the name of the player
* player_color (ex: ff0000) - the color code of the player
* player_no - the position of the player at the start of the game in natural table order, i.e. 1,2,3
getCurrentPlayerId()
Get the "current_player". The current player is the one from which the action originated (the one who sent the request).
Be careful: This is not necessarily the active player!
In general, you shouldn't use this method, unless you are in "multiplayer" state.
Very important: in your setupNewGame and zombieTurn function, you must never use getCurrentPlayerId() or getCurrentPlayerName(), otherwise it will fail with a "Not logged" error message (these actions are triggered from the main site and propagated to the gameserver from a server, not from a browser. As a consequence, there is no current player associated to these actions).
getCurrentPlayerName()
Get the "current_player" name
Be careful using this method (see above).
getCurrentPlayerColor()
Get the "current_player" color
Be careful using this method (see above).
isCurrentPlayerZombie()
Check the "current_player" zombie status. If true, player is zombie, i.e. left or was kicked out of the game.
isSpectator()
Check the "current_player" spectator status. If true, the user accessing the game is a spectator (not part of the game). For this user, the interface should display all public information, and no private information (like a friend sitting at the same table as players and just spectating the game).
getActivePlayerColor()
This function does not seems to exist in API, if you need it here is implementation
     function getActivePlayerColor() {
       $player_id = self::getActivePlayerId();
       $players = self::loadPlayersBasicInfos();
       if (isset($players[$player_id]))
           return $players[$player_id]['player_color'];
       else
           return null;
   }
isPlayerZombie($player_id)
This method does not exists, but if you need it it looks like this
   protected function isPlayerZombie($player_id) {
       $players = self::loadPlayersBasicInfos();
       if (! isset($players[$player_id]))
           throw new feException("Player $player_id is not playing here');
       
       return ($players[$player_id]['player_zombie'] == 1);
   }

Accessing the database

The main game logic should be the only point from which you should access the game database. You access your database using SQL queries with the methods below.

IMPORTANT

BGA uses database transactions. This means that your database changes WON'T BE APPLIED to the database until your request ends normally (web request, not database request). Using transactions is in fact very useful for you; at any time, if your game logic detects that something is wrong (example: a disallowed move), you just have to throw an exception and all changes to the game situation will be removed. This also means that you need not (and in fact cannot) use your own transactions for multiple related database operations.

However there sets of database operation that initite implicit commit (most common mistake is to use "TRUNCATE"), you cannot use these operations during the game, it breaks the unrolling of transactions and will lead to nasty issues (https://mariadb.com/kb/en/sql-statements-that-cause-an-implicit-commit).


DbQuery( $sql )
This is the generic method to access the database.
It can execute any type of SELECT/UPDATE/DELETE/REPLACE/INSERT query on the database.
You should use it for UPDATE/DELETE/REPLACE/INSERT queries. For SELECT queries, the specialized methods below are much better.
getUniqueValueFromDB( $sql )
Returns a unique value from DB or null if no value is found.
$sql must be a SELECT query.
Raise an exception if more than 1 row is returned.
getCollectionFromDB( $sql, $bSingleValue=false )
Returns an associative array of rows for a sql SELECT query.
The key of the resulting associative array is the first field specified in the SELECT query.
The value of the resulting associative array is an associative array with all the field specified in the SELECT query and associated values.
First column must be a primary or alternate key.
The resulting collection can be empty.
If you specified $bSingleValue=true and if your SQL query request 2 fields A and B, the method returns an associative array "A=>B"

Example 1: 

self::getCollectionFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );

Result:
array(
 1234 => array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),
 1235 => array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )
)

Example 2: 

self::getCollectionFromDB( "SELECT player_id id, player_name name FROM player", true );

Result:
array(
 1234 => 'myuser0',
 1235 => 'myuser1'
)
getNonEmptyCollectionFromDB( $sql )
Same as getCollectionFromDB($sdl), but raise an exception if the collection is empty. Note: this function does NOT have 2nd argument as previous one does.
getObjectFromDB( $sql )
Returns one row for the sql SELECT query as an associative array or null if there is no result
Raise an exception if the query return more than one row

Example: 

self::getObjectFromDB( "SELECT player_id id, player_name name, player_score score FROM player WHERE player_id='$player_id'" );

Result:
array(
  'id'=>1234, 'name'=>'myuser0', 'score'=>1 
)
getNonEmptyObjectFromDB( $sql )
Similar to previous one, but raise an exception if no row is found
getObjectListFromDB( $sql, $bUniqueValue=false )
Return an array of rows for a sql SELECT query.
The result is the same than "getCollectionFromDB" except that the result is a simple array (and not an associative array).
The result can be empty.
If you specified $bUniqueValue=true and if your SQL query request 1 field, the method returns directly an array of values.

Example 1: 

self::getObjectListFromDB( "SELECT player_id id, player_name name, player_score score FROM player" );

Result:
array(
 array( 'id'=>1234, 'name'=>'myuser0', 'score'=>1 ),
 array( 'id'=>1235, 'name'=>'myuser1', 'score'=>0 )
)

Example 2: 

self::getObjectListFromDB( "SELECT player_name name FROM player", true );

Result:
array(
 'myuser0',
 'myuser1'
)
getDoubleKeyCollectionFromDB( $sql, $bSingleValue=false )
Return an associative array of associative array, from a SQL SELECT query.
First array level correspond to first column specified in SQL query.
Second array level correspond to second column specified in SQL query.
If bSingleValue = true, keep only third column on result


DbGetLastId()
Return the PRIMARY key of the last inserted row (see PHP mysql_insert_id function).
DbAffectedRow()
Return the number of row affected by the last operation
escapeStringForDB( $string )
You must use this function on every string type data in your database that contains unsafe data.
(unsafe = can be modified by a player).
This method makes sure that no SQL injection will be done through the string used.
Note: if you using standard types in ajax actions, like AT_alphanum it is sanitized before arrival,
this is only needed if you manage to get unchecked string, like in the games where user has to enter text as a response.

Note: see Editing Game database model: dbmodel.sql to know how to define your database model.

Use globals

Sometimes, you want a single global integer value for your game, and you don't want to create a DB table specifically for it.

You can do this with the BGA framework "global." Your value will be stored in the "global" table in the database, and you can access it with simple methods.

initGameStateLabels

This method should be located at the beginning of __construct() method of yourgamename.game.php. This is where you define the globals used in your game logic, by assigning them IDs.

You can define up to 80 globals, with IDs from 10 to 89 (inclusive). You must not use globals outside this range, as those values are used by other components of the framework. 

        self::initGameStateLabels( array( 
                "my_first_global_variable" => 10,
                "my_second_global_variable" => 11
        ) );

or 

        $this->GAMESTATELABELS = ["my_first_global_variable" => 10, "my_second_global_variable" => 11];
        self::initGameStateLabels($this->GAMESTATELABELS);


setGameStateInitialValue( $value_label, $value_value )

Initialize your global value. Must be called before any use of your global, so you should call this method from your "setupNewGame" method. $value_value must be an integer.

It seems that a non initialized value will not be restored with undo system, so it is therefore advisable to initialize them all in your "setupNewGame" method. 

foreach ($this->GAMESTATELABELS as $value_label=> $ID) if ($ID >= 10 && $ID < 90) self::setGameStateInitialValue($value_label, 0);

getGameStateValue( $value_label )

Retrieve the current value of a global.

For debugging purposes, you can have labels and value pairs send to client side by inserting that line of code in your "getAllDatas": 

$result['labels'] = array_combine(array_keys($this->GAMESTATELABELS), array_map('self::getGameStateValue', array_keys($this->GAMESTATELABELS)));

setGameStateValue( $value_label, $value_value )

Set the current value of a global. $value_value must be an integer.

incGameStateValue( $value_label, $increment )

Increment the current value of a global. If increment is negative, decrement the value of the global.

Return the final value of the global.

Game states and active players

Activate player handling

$this->activeNextPlayer()
Make the next player active in the natural player order.
Note: you CANNOT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.
$this->activePrevPlayer()
Make the previous player active (in the natural player order).
Note: you CANNOT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.
$this->gamestate->changeActivePlayer( $player_id )
You can call this method to make any player active.
Note: you CANNOT use this method in a "activeplayer" or "multipleactiveplayer" state. You must use a "game" type game state for this.
$this->getActivePlayerId()
Return the "active_player" id
Note: it does NOT mean that this player is active right now, because state type could be "game" or "multipleactiveplayer"
Note: avoid using this method in a "multipleactiveplayer" state because it does not mean anything.

Multiple activate player handling

$this->gamestate->setAllPlayersMultiactive()
All playing players are made active. Update notification is sent to all players (this will trigger onUpdateActionButtons).
Usually, you use this method at the beginning of a game state (e.g., "stGameState") which transitions to a multipleactiveplayer state in which multiple players have to perform some action. Do not use this method if you going to make some more changes in the active player list. (I.e., if you want to take away multipleactiveplayer status immediately afterwards, use setPlayersMultiactive instead.)

Example of usage: 

    function st_MultiPlayerInit() {
        $this->gamestate->setAllPlayersMultiactive();
    }

And this is the state declaration: 

    2 => array(
    		"name" => "playerTurnPlace",
    		"description" => clienttranslate('Other player must place ships'),
    		"descriptionmyturn" => clienttranslate('${you} must place ships (click on YOUR SHIPS board to place)'),
    		"type" => "multipleactiveplayer",
                'action' => 'multiPlayerDoSomething',
                'args' => 'arg_playerTurnPlace',
    	     	"possibleactions" => array( "actionBla" ),
                "transitions" => array( "next" => 4, "last" => 99)
    ),
$this->gamestate->setAllPlayersNonMultiactive( $next_state )
All playing players are made inactive. Transition to next state
$this->gamestate->setPlayersMultiactive( $players, $next_state, $bExclusive = false )
Make a specific list of players active during a multiactive gamestate. Update notification is sent to all players whose state changed.
"players" is the array of player id that should be made active.
If "exclusive" parameter is not set or false it doesn't deactivate other previously active players. If its set to true, the players who will be multiactive at the end are only these in "$players" array
In case "players" is empty, the method trigger the "next_state" transition to go to the next game state.
returns true if state transition happened, false otherwise
$this->gamestate->setPlayerNonMultiactive( $player_id, $next_state )
During a multiactive game state, make the specified player inactive.
Usually, you call this method during a multiactive game state after a player did his action. It is also possible to call it directly from multiplayer action handler.
If this player was the last active player, the method trigger the "next_state" transition to go to the next game state.
returns true if state transition happened, false otherwise

Example of usage (see state declaration of playerTurnPlace above): 

    function actionBla($args) {
        self::checkAction('actionBla');
        // handle the action using $this->getCurrentPlayerId()
        $this->gamestate->setPlayerNonMultiactive( $this->getCurrentPlayerId(), 'next');
    }
$this->gamestate->getActivePlayerList()
With this method you can retrieve the list of the active player at any time.
During a "game" type gamestate, it will return a void array.
During a "activeplayer" type gamestate, it will return an array with one value (the active player id).
During a "multipleactiveplayer" type gamestate, it will return an array of the active players id.
Note: you should only use this method in the latter case.


$this->gamestate->updateMultiactiveOrNextState( $next_state_if_none )
Sends update notification about multiplayer changes. All multiactive set* functions above do that, however if you want to change state manually using db queries for complex calculations, you have to call this yourself after. Do not call this if you calling one of the other setters above.

Example: you have player teams and you want to activate all players in one team 

        $sql = "UPDATE player SET player_is_multiactive='0'";
        self::DbQuery( $sql );
        $sql = "UPDATE player SET player_is_multiactive='1' WHERE player_id='$player_id' AND player_team='$team_no'";
        self::DbQuery( $sql );
        
        $this->gamestate->updateMultiactiveOrNextState( 'error' );
updating database manually
Use this helper function to change multiactive state without sending notification
    /**
     * Changes values of multiactivity in db, does not sent notifications.
     * To send notifications after use updateMultiactiveOrNextState
     * @param number $player_id, player id <=0 or null - means ALL
     * @param number $value - 1 multiactive, 0 non multiactive
     */
    function dbSetPlayerMultiactive($player_id = -1, $value = 1) {
        if (! $value)
            $value = 0;
        else
            $value = 1;
        $sql = "UPDATE player SET player_is_multiactive = '$value' WHERE player_zombie = 0 and player_eliminated = 0";
        if ($player_id > 0) {
            $sql .= " AND player_id = $player_id";
        }
        self::DbQuery($sql);
    }

States functions

$this->gamestate->nextState( $transition )
Change current state to a new state. Important: the $transition parameter is the name of the transition, and NOT the name of the target game state, see Your game state machine: states.inc.php for more information about states.
$this->checkAction( $actionName, $bThrowException=true )
Check if the current player can perform a specific action in the current game state, and optionally throw an exception if they can't.
The action is valid if it is listed in the "possibleactions" array for the current game state (see game state description).
This method MUST be the first one called in ALL your PHP methods that handle player actions, in order to make sure a player doesn't perform an action not allowed by the rules at the point in the game. It should not be called from methods where the current player is not necessarily the active player, otherwise it may fail with an "It is not your turn" exception.
If "bThrowException" is set to "false", the function returns false in case of failure instead of throwing an exception. This is useful when several actions are possible, in order to test each of them without throwing exceptions.
$this->gamestate->checkPossibleAction( $action )
(rarely used)
This works exactly like "checkAction" (above), except that it does NOT check if the current player is active.
This is used specifically in certain game states when you want to authorize additional actions for players that are not active at the moment.
Example: in Libertalia, you want to authorize players to change their mind about the card played. They are of course not active at the time they change their mind, so you cannot use "checkAction"; use "checkPossibleAction" instead.

This is how PHP action looks that returns player to active state (only for multiplayeractive states). To be able to execute on js side do not checkAction on js side for this specific one. 

  function actionUnpass() {
       $this->gamestate->checkPossibleAction('actionUnpass'); // player chane mind about passing while others were thinking
       $this->gamestate->setPlayersMultiactive(array ($this->getCurrentPlayerId() ), 'error', false);
   }
$this->gamestate->state()
Get an associative array of current game state attributes, see Your game state machine: states.inc.php for state attributes.
 $state=$this->gamestate->state(); if( $state['name'] == 'myGameState' ) {...}

Players turn order

getNextPlayerTable()

Return an associative array which associate each player with the next player around the table.

In addition, key 0 is associated to the first player to play.

Example: if three player with ID 1, 2 and 3 are around the table, in this order, the method returns: 

   array( 
    1 => 2, 
    2 => 3, 
    3 => 1, 
    0 => 1 
   );

getPrevPlayerTable()

Same as above, but the associative array associate the previous player around the table. However there no 0 index here.

getPlayerAfter( $player_id )

Get player playing after given player in natural playing order.

getPlayerBefore( $player_id )

Get player playing before given player in natural playing order.

Note: There is no API to modify this order, if you have custom player order you have to maintain it in your database and have custom function to access it.

createNextPlayerTable( $players, $bLoop=true )

Using $players array creates a map of current => next as in example from getNextPlayerTable(), however you can use custom order here. Parmeter $bLoop is true if last player points to first, false otherwise. In any case index 0 points to first player (first element of $players array). $players is array of player ids in desired order.

N.B: This function DOES NOT allow to change players turn order!

Example of usage: 

    function getNextPlayerTableCustom() {
        $starting = $this->getStartingPlayer(); // custom function to get starting player
        $player_ids = $this->getPlayerIdsInOrder($starting); // custom function to create players array starting from starting player
        return self::createNextPlayerTable($player_ids, false); // create next player table in custom order
    }

Notify players

To understand notifications, please read The BGA Framework at a glance first.

IMPORTANT

Notifications are sent at the very end of the request, when it ends normally. It means that if you throw an exception for any reason (ex: move not allowed), no notifications will be sent to players. Notifications sent between the game start (setupNewGame) and the end of the "action" method of the first active state will never reach their destination.

NotifyAllPlayers

notifyAllPlayers( $notification_type, $notification_log, $notification_args )

Send a notification to all players of the game.

  • notification_type:

A string that defines the type of your notification.

Your game interface Javascript logic will use this to know what is the type of the received notification (and to trigger the corresponding method).

  • notification_log:

A string that defines what is to be displayed in the game log.

You can use an empty string here (""). In this case, nothing is displayed in the game log.

If you define a real string here, you should use "clienttranslate" method to make sure it can be translated.

You can use arguments in your notification_log strings, that refers to values defines in the "notification_args" argument (see below). Note: Make sure you only use single quotes ('), otherwise PHP will try to interpolate the variable and will ignore the values in the args array.

  • notification_args:

The arguments of your notifications, as an associative array.

This array will be transmitted to the game interface logic, in order the game interface can be updated.

Complete notifyAllPlayers example (from "Reversi"): 

self::notifyAllPlayers( "playDisc", clienttranslate( '${player_name} plays a disc and turns over ${returned_nbr} disc(s)' ),
 array(
        'player_id' => $player_id,
        'player_name' => self::getActivePlayerName(),
        'returned_nbr' => count( $turnedOverDiscs ),
        'x' => $x,
        'y' => $y
     ) );

You can see in the example above the use of the "clienttranslate" method, and the use of 2 arguments "player_name" and "returned_nbr" in the notification log.

Important: NO private data must be sent with this method, as a cheater could see it even if it is not used explicitly by the game interface logic. If you want to send private information to a player, please use notifyPlayer below.

Important: this array is serialized to be sent to the browsers, and will be saved with the notification to be able to replay the game later. If it is too big, it can make notifications slower / less reliable, and replay archives very big (to the point of failing). So as a general rule, you should send only the minimum of information necessary to update the client interface with no overhead in order to keep the notifications as light as possible.

Important: When the game page is reloaded (i.e. F5 or when loading turn based game) all previous notifications are replayed as history notifications. These notifications do not trigger notification handlers and are used basically to build the game log. Because of that most of the notification arguments, except i18n, player_id and all arguments used in the message, are removed from these history notifications. If you need additional arguments in history notifications you can add special field preserve to notification arguments, like this: 

self::notifyAllPlayers( "playDisc", clienttranslate( '${player_name} plays a disc and turns over ${returned_nbr} disc(s)' ),
 array(
        'player_id' => $player_id,
        'player_name' => self::getActivePlayerName(),
        'returned_nbr' => count( $turnedOverDiscs ),
        'x' => $x,
        'y' => $y,
        'preserve' => [ 'x', 'y' ]
     ) );

In this example, fields x and y will be preserved when replaying history notification at the game load.

HTML in Notifications

You CAN use some HTML inside your notification log, however it not recommended for many reasons:

  • Its bad architecture, ui elements leak into server now you have to manage ui in many places
  • If you decided to change something in ui in future version, old games replay and tutorials may not work, since they use stored notifications
  • When you read log preview for old games its unreadable (this is log before you enter the game replay, useful for troubleshooting or game analysis)
  • Its more data to transfer and store in db
  • Its nightmare for translators, at least don't put HTML tags inside the "clienttranslate" method. You can use a notification argument instead, and provide your HTML through this argument.

If you still want to have pretty pictures in the log check this BGA_Studio_Cookbook#Inject_images_and_styled_html_in_the_log.

Recursive Notifications

If your notification contains some phrases that build programmatically you may need to use recursive notifications. In this case the argument can be not only the string but an array itself, which contains 'log' and 'args', i.e. 

 $this->notifyAllPlayers('playerLog',clienttranslate('Game moves ${token_name_rec}'),
                  ['token_name_rec'=>['log'=>'${token_name} #${token_number}',
                                      'args'=> ['token_name'=>clienttranslate('Boo'), 'token_number'=>$number, 'i18n'=>['token_name'] ]
                                     ]
                  ]);

Special handling of arguments:

  • ${player_name} - this will be wrapped in html and text shown using color of the corresponding player, some colors also have reserved background. This will apply recursively as well.
  • ${player_name2} - same


Excluding some players

Sometimes you want to notify all players of a message but not have it appear in the log of specific players (for example, have every player see "Player X draws a card" but have Player X see "You draw the Ace of Spades").

To send a notification to all players but have some clients ignore it, send it as normal from the server, but implement setIgnoreNotificationCheck on the client to ignore the message under given conditions. See the X.js documentation for more details.

NotifyPlayer

notifyPlayer( $player_id, $notification_type, $notification_log, $notification_args )

Same as above, except that the notification is sent to one player only.

This method must be used each time some private information must be transmitted to a player.

Important: the variable for player name must be ${player_name} in order to be highlighted with the player color in the game log. If you want a second player name in the log, name the variable ${player_name2}, etc.

Note that spectators cannot be notified using this method, because their player ID is not available via loadPlayersBasicInfos() or otherwise. You must use notifyAllPlayers() for any notification that spectators should get.

About random and randomness

A large number of board games rely on random, most often based on dice, cards shuffling, picking some item in a bag, and so on. This is very important to ensure a high level of randomness for each of these situations.

Here's are a list of techniques you should use in these situations, from the best to the worst.

Dice and bga_rand

bga_rand( min, max ) This is a BGA framework function that provides you a random number between "min" and "max" (inclusive), using the best available random method available on the system.

This is the preferred function you should use, because we are updating it when a better method is introduced.

As of now, bga_rand is based on the PHP function "random_int", which ensures a cryptographic level of randomness.

In particular, it is mandatory to use it for all dice throw (ie: games using other methods for dice throwing will be rejected by BGA during review).

Note: rand() and mt_rand() are deprecated on BGA and should not be used anymore, as their randomness is not as good as "bga_rand".

shuffle and cards shuffling

To shuffle items, like a pile of cards, the best way is to use the BGA PHP Deck component and to use "shuffle" method. This ensures that the best available shuffling method is used, and that if in the future we improve it your game will be up to date.

As of now, the Deck component shuffle method is based on PHP "shuffle" method, which has quite good randomness (even it is not as good as bga_rand). In consequence, we accept other shuffling methods during reviews, as long as they are based on PHP "shuffle" function (or similar, like "array_rand").

Other methods

Mysql "RAND()" function has not enough randomness to be a valid method to get a random element on BGA. This function has been used in some existing games and has given acceptable results, but now it should be avoided and you should use other methods instead.

Game statistics

There are 2 types of statistics:

  • a "player" statistic is a statistic associated to a player
  • a "table" statistic is a statistic not associated to a player (global statistic for this game).

See Game statistics: stats.inc.php to see how you define statistics for your game.


initStat( $table_or_player, $name, $value, $player_id = null )

Create a statistic entry with a default value.

This method must be called for each statistic of your game, in your setupNewGame method. If you neglect to call this for a statistic, and also do not update the value during the course of a certain game using setStat or incStat, the value of the stat will be undefined rather than 0. This will result in it being ignored at the end of the game, as if it didn't apply to that particular game, and excluded from cumulative statistics. As a consequence - if do not want statistic to be applied, do not init it, or call set or inc on it.


'$table_or_player' must be set to "table" if this is a table statistic, or "player" if this is a player statistic.

'$name' is the name of your statistic, as it has been defined in your stats.inc.php file.

'$value' is the initial value of the statistic. If this is a player statistic and if the player is not specified by "$player_id" argument, the value is set for ALL players.


setStat( $value, $name, $player_id = null )

Set a statistic $name to $value.

If "$player_id" is not specified, setStat consider it is a TABLE statistic.

If "$player_id" is specified, setStat consider it is a PLAYER statistic.


incStat( $delta, $name, $player_id = null )

Increment (or decrement) specified statistic value by $delta value. Same behavior as setStat function.


getStat( $name, $player_id = null )

Return the value of statistic specified by $name. Useful when creating derivative statistics such as average.

Translations

See Translations

Manage player scores and Tie breaker

Normal scoring

At the end of the game, players automatically get a rank depending on their score: the player with the biggest score is #1, the player with the second biggest score is #2, and so on...

During the game, you update player's score directly by updating "player_score" field of "player" table in database.

Examples: 


  // +2 points to active player
  self::DbQuery( "UPDATE player SET player_score=player_score+2 WHERE player_id='".self::getActivePlayerId()."'" );

  // Set score of active player to 5
  self::DbQuery( "UPDATE player SET player_score=5 WHERE player_id='".self::getActivePlayerId()."'" );

Note: don't forget to notify the client side in order the score control can be updated accordingly.

Tie breaker

Tie breaker is used when two players get the same score at the end of a game.

Tie breaker is using "player_score_aux" field of "player" table. It is updated exactly like the "player_score" field.

Tie breaker score is displayed only for players who are tied at the end of the game. Most of the time, it is not supposed to be displayed explicitly during the game.

When you are using "player_score_aux" functionality, you must describe the formula to use in your gameinfos.inc.php file like this: 

         'tie_breaker_description' => totranslate("Describe here your tie breaker formula"),

This description will be used as a tooltip to explain to players how this auxiliary score has been calculated.

Co-operative game

To make everyone win/lose together in a full-coop game:

Add the following in gameinfos.inc.php : 'is_coop' => 1, // full cooperative

Assign a score of zero to everyone if it's a loss. Assign the same score > 0 to everyone if it's a win.

Semi-coop

If the game is not full-coop, then everyone loses = everyone is tied. I.e. set score to 0 to everybody.

Only "winners" and "losers"

For some games, there is only a group (or a single) "winner", and everyone else is a "loser", with no "end of game rank" (1st, 2nd, 3rd...).

Examples:

  • Coup
  • Not Alone
  • Werewolves
  • Quantum

In this case:

  • Set the scores so that the winner has the best score, and the other players have the same (lower) score.
  • Add the following lines to gameinfos.inc.php:
// If in the game, all losers are equal (no score to rank them or explicit in the rules that losers are not ranked between them), set this to true 
// The game end result will display "Winner" for the 1st player and "Loser" for all other players
'losers_not_ranked' => true,

Werewolves and Coup are implemented like this, as you can see here:

Adding this has the following effects:

  • On game results for this game, "Winner" or "Loser" is going to appear instead of the usual "1st, 2nd, 3rd, ...".
  • When a game is over, the result of the game will be "End of game: Victory" or "End of game: Defeat" depending on the result of the CURRENT player (instead of the usual "Victory of XXX").
  • When calculating ELO points, if there is at least one "Loser", no "victorious" player can lose ELO points, and no "losing" player can win ELO point. Usually it may happened because being tie with many players with a low rank is considered as a tie and may cost you points. If losers_not_ranked is set, we prevent this behavior and make sure you only gain/loss ELO when you get the corresponding results.

Important: this SHOULD NOT be used for cooperative games (see is_coop parameter), or for 2 players games (it makes no sense in this case).

Solo

If game supports solo variant, a negative or zero score means defeat, a positive score means victory.

Player elimination

In some games, this is useful to eliminate a player from the game in order he/she can start another game without waiting for the current game end.

This case should be rare. Please don't use player elimination feature if some player just has to wait the last 10% of the game for game end. This feature should be used only in games where players are eliminated all along the game (typical examples: "Perudo" or "The Werewolves of Miller's Hollow").

Usage:

  • Player to eliminate should NOT be active anymore (preferably use the feature in a "game" type game state).
  • In your PHP code:
 self::eliminatePlayer( <player_to_eliminate_id> );
  • the player is informed in a dialog box that he no longer have to play and can start another game if he/she wants too (with buttons "stay at this table" "quit table and back to main site"). In any case, the player is free to start & join another table from now.
  • When your game is over, all players who have been eliminated before receive a "notification" (the small "!" icon on the top right of the BGA interface) that indicate them that "the game has ended" and invite them to review the game results.

Important: this should never be used on a player who has already left the game ("zombie") as leaving/being kicked of the game (outside of the scope of the rules) is not the same as being eliminated from the game (according to the rules).

Scoring Helper functions

These functions should have been API but they are not, just add them to your php game and use for every game. 

   // get score
   function dbGetScore($player_id) {
       return $this->getUniqueValueFromDB("SELECT player_score FROM player WHERE player_id='$player_id'");
   }

   // set score
   function dbSetScore($player_id, $count) {
       $this->DbQuery("UPDATE player SET player_score='$count' WHERE player_id='$player_id'");
   }

   // set aux score (tie breaker)
   function dbSetAuxScore($player_id, $score) {
       $this->DbQuery("UPDATE player SET player_score_aux=$score WHERE player_id='$player_id'");
   }

   // increment score (can be negative too)
   function dbIncScore($player_id, $inc) {
       $count = $this->dbGetScore($player_id);
       if ($inc != 0) {
           $count += $inc;
           $this->dbSetScore($player_id, $count);
       }
       return $count;
   }

Reflexion time

function giveExtraTime( $player_id, $specific_time=null )
Give standard extra time to this player.
Standard extra time depends on the speed of the game (small with "slow" game option, bigger with other options).
You can also specify an exact time to add, in seconds, with the "specified_time" argument (rarely used).


Undo moves

Please read our BGA Undo policy before.


Important: Before using these methods, you must also add the following to your "gameinfos.inc.php" file, otherwise these methods are ineffective: 

 'db_undo_support' => true


function undoSavepoint( )
Save the whole game situation inside an "Undo save point".
There is only ONE undo save point available (see BGA Undo policy). Cannot use in multiactivate state or in game state where next state is multiactive.
Note: this function does not actually do anything when it is called, it only raises the flag to store the database AFTER transaction is over. So the actual state will be saved when you exit the function calling it (technically before first queued notification is sent, which matter if you transition to game state not to user state after), which may affect what you end up saved.


function undoRestorePoint()
Restore the situation previously saved as an "Undo save point".
You must make sure that the active player is the same after and before the undoRestorePoint (ie: this is your responsibility to ensure that the player that is active when this method is called is exactly the same than the player that was active when the undoSavePoint method has been called).
   function actionUndo() {
       self::checkAction('actionUndo');
       $this->undoRestorePoint();
       $this->gamestate->nextState('next'); // transition to single player state (i.e. beginning of player actions for this turn)
   }

Managing errors and exceptions

Note: when you throw an exception, all database changes and all notifications are cancelled immediately. This way, the game situation that existed before the request is completely restored.

throw new BgaUserException ( $error_message)
Base class to notify a user error
You must throw this exception when a player wants to do something that they are not allowed to do.
The error message will be shown to the player as a "red message".
The error message must be translated, make sure you use self::_() or $this->_() here and NOT clientranslate()
Throwing such an exception is NOT considered a bug, so it is not traced in BGA error logs.

Example from Gomoku: 

     throw new BgaUserException( self::_("There is already a stone on this intersection, you can't play there") );


throw new BgaVisibleSystemException ( $error_message)
You must throw this exception when you detect something that is not supposed to happened in your code.
The error message is shown to the user as an "Unexpected error", in order that he can report it in the forum.
The error message is logged in BGA error logs. If it happens regularly, we will report it to you.
throw new BgaSystemException ( $error_message)
Base class to notify a system exception. The message will be hidden from the user, but show in the logs. Use this if the message contains technical information.
You shouldn't use this type of exception except if you think the information shown could be critical. Indeed: a generic error message will be shown to the user, so it's going to be difficult for you to see what happened.

Zombie mode

When a player leaves a game for any reason (expelled, quit), he becomes a "zombie player". In this case, the results of the game won't count for statistics, but this is cool if the other players can finish the game anyway. That's why zombie mode exists: allow the other player to finish the game, even if the situation is not ideal.

While developing your zombie mode, keep in mind that:

  • Do not refer to the rules, because this situation is not planned by the rules.
  • Try to figure that you are playing with your friends and one of them has to leave: how can we finish the game without killing the spirit of the game?
  • The idea is NOT to develop an artificial intelligence for the game.
  • Do not try to end the game early, even in a two-player game. The zombie is there to allow the game to continue, not to end it. Trying to end the game is not supported by the framework and will likely cause unexpected errors.

Most of the time, the best thing to do when it is zombie player turn is to jump immediately to a state where he is not active anymore. For example, if he is in a game state where he has a choice between playing A and playing B, the best thing to do is NOT to choose A or B, but to pass. So, even if there's no "pass" action in the rules, add a "zombiepass" transitition in your game state and use it.

Each time a zombie player must play, your "zombieTurn" method is called.

Parameters:

  • $state: the name of the current game state.
  • $active_player: the id of the active player.

Most of the time, your zombieTurn method looks like this: 

    function zombieTurn( $state, $active_player )
    {
    	$statename = $state['name'];

        if( $statename == 'myFirstGameState'
             ||  $statename == 'my2ndGameState'
             ||  $statename == 'my3rdGameState'
               ....
           )
        {
            $this->gamestate->nextState( "zombiePass" );
        }
        else
            throw new BgaVisibleSystemException( "Zombie mode not supported at this game state: ".$statename );
    }

Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.

Very important: your zombie code will be called when the player leaves the game. This action is triggered from the main site and propagated to the gameserver from a server, not from a browser. As a consequence, there is no current player associated to this action. In your zombieTurn function, you must never use getCurrentPlayerId() or getCurrentPlayerName(), otherwise it will fail with a "Not logged" error message.

Player color preferences

BGA players (Club members) may now choose their preferred color for playing. For example, if they are used to play green for every board game, they can select "green" in their BGA preferences page.

Making your game compatible with colors preferences is very easy and requires only 1 line of configuration change:

On your gameinfos.inc.php file, add the following lines : 

 // Favorite colors support: if set to "true", support attribution of favorite colors based on player's preferences (see reattributeColorsBasedOnPreferences PHP method)
 // NB: this parameter is used only to flag games supporting this feature; you must use (or not use) reattributeColorsBasedOnPreferences PHP method to actually enable or disable the feature.
 'favorite_colors_support' => true,

Then, on your main <your_game>.game.php file check the code of "setupNewGame". New template already have correct code, but if you editing very old game and it may be absent. 

       $gameinfos = $this->getGameinfos();
       ...
       if ($gameinfos['favorite_colors_support'])
           $this->reattributeColorsBasedOnPreferences($players, $gameinfos['player_colors']); // this should be above reloadPlayersBasicInfos()
       self::reloadPlayersBasicInfos();


The "reattributeColorsBasedOnPreferences" method reattributes all colors, taking into account players color preferences and available colors.

Note that you must update the colors to indicate the colors available for your game.

Some important remarks:

  • for some games (i.e. Chess), the color has an influence on a mechanism of the game, most of the time by giving a special advantage to a player (i.e. Starting the game). Color preference mechanism must NOT be used in such a case.
  • your logic should NEVER consider that the first player has the color X, that the second player has the color Y, and so on. If this is the case, your game will NOT be compatible with reattributeColorsBasedOnPreferences as this method attribute colors to players based on their preferences and not based as their order at the table.

Colours currently listed as a choice in preferences (Note - you don't have to pick these, the "closest" color will be found):

  • #ff0000 Red
  • #008000 Green
  • #0000ff Blue
  • #ffa500 Yellow
  • #000000 Black
  • #ffffff White
  • #e94190 Pink
  • #982fff Purple
  • #72c3b1 Cyan
  • #f07f16 Orange
  • #bdd002 Khaki green
  • #7b7b7b Gray

Legacy games API

For some very specific games ("legacy", "campaign"), you need to keep some informations from a game to another.

This should be an exceptional situation: the legacy API is costing resources on Board Game Arena databases, and is slowing down the game setup process + game end of game process. Please do not use it for things like:

  • keeping a player preference/settings (=> player preferences and game options should be used instead)
  • keeping a statistics, a score, or a ranking, while it is not planned in the physical board game, or while there is no added value compared to BGA statistics / rankings.

You should use it for:

  • legacy games: when some components of the game has been altered in a previous game and should be kept as it is.
  • "campaign style" games: when a player is getting a "reward" at the end of a game, and should be able to use it in further games.

Important: you cannot store more than 64k of data (serialized as JSON) per player per game. If you go over 64k, storeLegacyData function is going to FAIL, and there is a risk to create a major bug (= players blocked) in your game. You MUST make sure that no more than 64k of data is used for each player for your game. For example, if you are implementing a "campaign style" game and if you allow a player to start multiple campaign, you must LIMIT the number of different campaign so that the total data size to not go over the limit. We strongly recommend you to use this: 

 try 
 {
 	$this->storeLegacyTeamData( 'my_variable', $my_data );
 }
 catch( feException $e )
 {
 	if( $e->getCode() == FEX_legacy_size_exceeded )
 	{
 		// Do something here to free some space in Legacy data (ex: by removing some variables)
 	}
 	else
 		throw $e;
 }

The keys may only contain letters and numbers, underscore seems not to be allowed.

function storeLegacyData( $player_id, $key, $data, $ttl = 365 )
Store some data associated with $key for the given user / current game
In the opposite of all other game data, this data will PERSIST after the end of this table, and can be re-used
in a future table with the same game.
IMPORTANT: The only possible place where you can use this method is when the game is over at your table (last game action). Otherwise, there is a risk of conflicts between ongoing games.
TTL is a time-to-live: the maximum, and default, is 365 days.
In any way, the total data (= all keys) you can store for a given user+game is 64k (note: data is store serialized as JSON data)
function retrieveLegacyData( $player_id, $key )
Get data associated with $key for the current game
This data is common to ALL tables from the same game for this player, and persist from one table to another.
Note: calling this function has an important cost => please call it few times (possibly: only ONCE) for each player for 1 game if possible
Note: you can use '%' in $key to retrieve all keys matching the given patterns
function removeLegacyData( $player_id, $key )
Remove some legacy data with the given key
(useful to free some data to avoid going over 64k)


function storeLegacyTeamData( $key, $data, $ttl = 365 )
Same as storeLegacyData, except that it stores some data for the whole team within the current table
Ie: if players A, B and C are at a table, the legacy data will be saved for future table with (exactly) A, B and C on the table.
This is useful for games which are intended to be played several time by the same team.
Note: the data total size is still limited, so you must implement catch the FEX_legacy_size_exceeded exception if it happens
function retrieveLegacyTeamData($key)
Same as retrieveLegacyData, except that it retrieves some data for the whole team within the current table (set by storeLegacyTeamData)
function removeLegacyTeamData()
Same as removeLegacyData, except that it retrieves some data for the whole team within the current table (set by storeLegacyTeamData)

Language dependent games API

This API is used for games that are heavily language dependent. Two most common use cases are:

  • Games that have a language dependent component that are not necessarily translatable, typically a list of words. (Think of games like Codenames, Decrypto, Just One...)
  • Games with massive communication where players would like to ensure that all participants speak the same language. (Think of games like Werewolf, The Resistance, maybe even dixit...)

If this option is used, the table created will be limited only to users that have specific language in their profile. Player starting the game would be able to chose one of the languages he speaks.

There is a new property language_dependency in gameinfos.inc.php which can be set like this: 

 'language_dependecy' => false,  //or if the property is missing, the game is not language dependent
 'language_dependecy' => true, //all players at the table must speak the same language
 'language_dependecy' => array( 1 => 'en', 2 => 'fr', 3 => 'it' ), //1-based list of supported languages

In the gamename.game.php file, you can get the id of selected language with the method getGameLanguage.

function getGameLanguage()
Returns an index of the selected language as defined in gameinfos.inc.php.

Languages currently available on BGA are: 

 'ar' => array( 'name' => "العربية", 'code' => 'ar_AE' ),             // Arabic
 'be' => array( 'name' => "беларуская мова", 'code' => 'be_BY' ),     // Belarusian
 'bn' => array( 'name' => "বাংলা", 'code' => 'bn_BD' ),                // Bengali
 'bg' => array( 'name' => "български език", 'code' => 'bg_BG' ),      // Bulgarian
 'ca' => array( 'name' => "català", 'code' => 'ca_ES' ),              // Catalan
 'cs' => array( 'name' => "čeština", 'code' => 'cs_CZ' ),             // Czech
 'da' => array( 'name' => "dansk", 'code' => 'da_DK' ),               // Danish
 'de' => array( 'name' => "deutsch", 'code' => 'de_DE' ),             // German
 'el' => array( 'name' => "Ελληνικά", 'code' => 'el_GR' ),            // Greek
 'en' => array( 'name' => "English", 'code' => 'en_US' ),             // English
 'es' => array( 'name' => "español", 'code' => 'es_ES' ),             // Spanish
 'et' => array( 'name' => "eesti keel", 'code' => 'et_EE' ),          // Estonian       
 'fi' => array( 'name' => "suomi", 'code' => 'fi_FI' ),               // Finnish
 'fr' => array( 'name' => "français", 'code' => 'fr_FR' ),            // French
 'he' => array( 'name' => "עברית", 'code' => 'he_IL' ),               // Hebrew       
 'hi' => array( 'name' => "हिन्दी", 'code' => 'hi_IN' ),                 // Hindi
 'hr' => array( 'name' => "Hrvatski", 'code' => 'hr_HR' ),            // Croatian
 'hu' => array( 'name' => "magyar", 'code' => 'hu_HU' ),              // Hungarian
 'id' => array( 'name' => "Bahasa Indonesia", 'code' => 'id_ID' ),    // Indonesian
 'ms' => array( 'name' => "Bahasa Malaysia", 'code' => 'ms_MY' ),     // Malaysian
 'it' => array( 'name' => "italiano", 'code' => 'it_IT' ),            // Italian
 'ja' => array( 'name' => "日本語", 'code' => 'ja_JP' ),               // Japanese
 'jv' => array( 'name' => "Basa Jawa", 'code' => 'jv_JV' ),           // Javanese                       
 'ko' => array( 'name' => "한국어", 'code' => 'ko_KR' ),               // Korean
 'lt' => array( 'name' => "lietuvių", 'code' => 'lt_LT' ),            // Lithuanian
 'lv' => array( 'name' => "latviešu", 'code' => 'lv_LV' ),            // Latvian
 'nl' => array( 'name' => "nederlands", 'code' => 'nl_NL' ),          // Dutch
 'no' => array( 'name' => "norsk", 'code' => 'nb_NO' ),               // Norwegian
 'oc' => array( 'name' => "occitan", 'code' => 'oc_FR' ),             // Occitan
 'pl' => array( 'name' => "polski", 'code' => 'pl_PL' ),              // Polish
 'pt' => array( 'name' => "português",  'code' => 'pt_PT' ),          // Portuguese
 'ro' => array( 'name' => "română",  'code' => 'ro_RO'  ),            // Romanian
 'ru' => array( 'name' => "Русский язык", 'code' => 'ru_RU' ),        // Russian
 'sk' => array( 'name' => "slovenčina", 'code' => 'sk_SK' ),          // Slovak
 'sl' => array( 'name' => "slovenščina", 'code' => 'sl_SI' ),         // Slovenian       
 'sr' => array( 'name' => "Српски", 'code' => 'sr_RS' ),              // Serbian       
 'sv' => array( 'name' => "svenska", 'code' => 'sv_SE' ),             // Swedish
 'tr' => array( 'name' => "Türkçe", 'code' => 'tr_TR' ),              // Turkish       
 'uk' => array( 'name' => "Українська мова", 'code' => 'uk_UA' ),     // Ukrainian
 'zh' => array( 'name' => "中文 (漢)",  'code' => 'zh_TW' ),           // Traditional Chinese (Hong Kong, Macau, Taiwan)
 'zh-cn' => array( 'name' => "中文 (汉)", 'code' => 'zh_CN' ),         // Simplified Chinese (Mainland China, Singapore)

Debugging and Tracing

To debug php code you can use some tracing functions available from the parent class such as debug, trace, error, warn, dump. 

 self::debug("Ahh!");
 self::dump('my_var',$my_var);

See Practical_debugging section for complete information about debugging interfaces and where to find logs.

Retrieved from "http:///index.php?title=Main_game_logic:_Game.php&oldid=8941"