Game material description: material.inc.php - Revision history

AmadanNaBriona: /* Testing */

2025-11-11T16:03:40Z

Testing

← Older revision		Revision as of 18:03, 11 November 2025
Line 96:		Line 96:

	== Testing ==		== Testing ==
	If you screw up ~~you~~ material file such as ~~miss~~ some brackets it is very hard to diagnose. But you can test it locally like this		If you screw up your material file such as by missing some brackets, it is very hard to diagnose. But you can test it locally like this:

	misc/material_test.php:		misc/material_test.php:
Line 115:		Line 115:
	== Adjusting material ==		== Adjusting material ==

	In rare cases expansions of the game ~~change~~ the materials of the original game~~, in~~ such cases same card ~~for example~~ was re-printed with a different text/rules.		In rare cases expansions of the game changes the materials of the original game. In such cases (for example, the same card was re-printed with a different text/rules),
	~~Can~~ you keep same card and have material adjust based on selected game options? It is possible with some trickery.		can you keep same card and have material adjust based on selected game options? It is possible with some trickery.

	You need to modify the data in that file AFTER constructor when database access is initialized, and have it available for all php entry points.		You need to modify the data in that file AFTER constructor when database access is initialized, and have it available for all php entry points.

Thoun: /* Move it to modules/php */

2025-11-11T15:57:50Z

Move it to modules/php

← Older revision		Revision as of 17:57, 11 November 2025
Line 172:		Line 172:

	<pre>		<pre>
	class Game extends \Table {		class Game extends Table {
	private array $DECKS; // so the IDE knows you define an array called DECKS on the material file		private array $DECKS; // so the IDE knows you define an array called DECKS on the material file

Thoun: /* Overview */

2024-11-27T09:57:45Z

Overview

← Older revision		Revision as of 11:57, 27 November 2024
Line 4:		Line 4:
	'''IMPORTANT NOTE''': This file is not generated anymore by default, but you can still create it (the name is important as only a <code>material.inc.php</code> file at the root of your project will be automatically loaded) to describe the material of your game.		'''IMPORTANT NOTE''': This file is not generated anymore by default, but you can still create it (the name is important as only a <code>material.inc.php</code> file at the root of your project will be automatically loaded) to describe the material of your game.

	If you want to put all your material.inc.php in modules/php instead, please read [https://en.doc.boardgamearena.com/~~index.php?title=~~Game_material_description:_material.inc.php~~&action=submit~~#Move_it_to_modules/php ~~Move_it_to_modules~~/php]		If you want to put all your material.inc.php in modules/php instead, please read [https://en.doc.boardgamearena.com/Game_material_description:_material.inc.php#Move_it_to_modules/php Move it to modules/php]

	This file is included by the constructor of your main game logic (yourgame.game.php), and then the variables defined here are accessible everywhere in your game logic file (and also view.php file).		This file is included by the constructor of your main game logic (yourgame.game.php), and then the variables defined here are accessible everywhere in your game logic file (and also view.php file).

Thoun: /* Overview */

2024-11-27T09:56:52Z

Overview

← Older revision		Revision as of 11:56, 27 November 2024
Line 3:		Line 3:
	== Overview ==		== Overview ==
	'''IMPORTANT NOTE''': This file is not generated anymore by default, but you can still create it (the name is important as only a <code>material.inc.php</code> file at the root of your project will be automatically loaded) to describe the material of your game.		'''IMPORTANT NOTE''': This file is not generated anymore by default, but you can still create it (the name is important as only a <code>material.inc.php</code> file at the root of your project will be automatically loaded) to describe the material of your game.

			If you want to put all your material.inc.php in modules/php instead, please read [https://en.doc.boardgamearena.com/index.php?title=Game_material_description:_material.inc.php&action=submit#Move_it_to_modules/php Move_it_to_modules/php]

	This file is included by the constructor of your main game logic (yourgame.game.php), and then the variables defined here are accessible everywhere in your game logic file (and also view.php file).		This file is included by the constructor of your main game logic (yourgame.game.php), and then the variables defined here are accessible everywhere in your game logic file (and also view.php file).

Thoun at 09:55, 27 November 2024

2024-11-27T09:55:48Z

@@ Line 7: / Line 7: @@
 Using material.inc.php makes your PHP logic file smaller and clean. Normally you put ALL static information about your cards, tokens, tiles, etc in that file which do not change. Do not store static info in database.
 == Definition ==
@@ Line 194: / Line 165: @@
+}
 </pre>
 [[Category:Studio]]

Thoun: /* Move it to modules/php */

2024-11-27T09:54:44Z

Move it to modules/php

← Older revision		Revision as of 11:54, 27 November 2024
Line 11:		Line 11:
	You can move the file to any modules/php folder/subfolder, but it will not be included automatically, you'll need to import it.		You can move the file to any modules/php folder/subfolder, but it will not be included automatically, you'll need to import it.


			<pre>
			class Game extends \Table {
			private array $DECKS; // so the IDE knows you define an array called DECKS on the material file

			function __construct()
			{
			parent::__construct();

			require 'material.inc.php'; // your material.inc.php in modules/php folder contains $this->DECKS = [...]

			$this->initGameStateLabels([]);
			}

			protected function getAllDatas(): array
			{
			// ...
			// use it the same way
			$result['DECKS'] = $this->DECKS;

			return $result;
			}
			</pre>

			Note: this way, you can use any file name and even split you material in multiple files if you want to.

	== Definition ==		== Definition ==

Thoun at 09:50, 27 November 2024

2024-11-27T09:50:30Z

← Older revision		Revision as of 11:50, 27 November 2024
Line 2:		Line 2:

	== Overview ==		== Overview ==
	IMPORTANT NOTE: This file is not generated anymore by default, but you can still create it (the name is important as only a <code>material.inc.php</code> file at the root of your project will be automatically loaded) to describe the material of your game.		'''IMPORTANT NOTE''': This file is not generated anymore by default, but you can still create it (the name is important as only a <code>material.inc.php</code> file at the root of your project will be automatically loaded) to describe the material of your game.

	This file is included by the constructor of your main game logic (yourgame.game.php), and then the variables defined here are accessible everywhere in your game logic file (and also view.php file).		This file is included by the constructor of your main game logic (yourgame.game.php), and then the variables defined here are accessible everywhere in your game logic file (and also view.php file).

	Using material.inc.php makes your PHP logic file smaller and clean. Normally you put ALL static information about your cards, tokens, tiles, etc in that file which do not change. Do not store static info in database.		Using material.inc.php makes your PHP logic file smaller and clean. Normally you put ALL static information about your cards, tokens, tiles, etc in that file which do not change. Do not store static info in database.

			== Move it to modules/php ==
			You can move the file to any modules/php folder/subfolder, but it will not be included automatically, you'll need to import it.



	== Definition ==		== Definition ==

Thoun: /* Overview */

2024-11-27T09:48:00Z

Overview

← Older revision		Revision as of 11:48, 27 November 2024
Line 2:		Line 2:

	== Overview ==		== Overview ==
	This ~~PHP~~ file ~~describes all~~ the material of your game.		IMPORTANT NOTE: This file is not generated anymore by default, but you can still create it (the name is important as only a <code>material.inc.php</code> file at the root of your project will be automatically loaded) to describe the material of your game.

	This file is included by the constructor of your main game logic (yourgame.game.php), and then the variables defined here are accessible everywhere in your game logic file (and also view.php file).		This file is included by the constructor of your main game logic (yourgame.game.php), and then the variables defined here are accessible everywhere in your game logic file (and also view.php file).

Sguzzer Gunayer: /* Adjusting material */

2024-09-15T10:24:58Z

Adjusting material

← Older revision		Revision as of 12:24, 15 September 2024
Line 114:		Line 114:

	In rare cases expansions of the game change the materials of the original game, in such cases same card for example was re-printed with a different text/rules.		In rare cases expansions of the game change the materials of the original game, in such cases same card for example was re-printed with a different text/rules.
	Can you keep same card and have material adjust based on ~~seelcted~~ game options? It is possible with some trickery.		Can you keep same card and have material adjust based on selected game options? It is possible with some trickery.

	You need to modify the data in that file AFTER constructor when database access is initialized, and have it available for all php entry points.		You need to modify the data in that file AFTER constructor when database access is initialized, and have it available for all php entry points.

Sguzzer Gunayer: /* PHP constants */

2024-09-06T16:12:42Z

PHP constants

← Older revision		Revision as of 18:12, 6 September 2024
Line 86:		Line 86:
	$result['constants']=$cc; // this will be all constants though, you may have to filter some stuff out for security reasons		$result['constants']=$cc; // this will be all constants though, you may have to filter some stuff out for security reasons

	Alternately you can include a material.inc.php in local php file and call this method to print constants in JS format, then include this file in JS, you may have to ~~syncronize~~ this manually, but its better for auto-complete also.		Alternately you can include a material.inc.php in local php file and call this method to print constants in JS format, then include this file in JS, you may have to synchronize this manually, but its better for auto-complete also.
	// this needs to be run locally after including materal file (see example in testing below)		// this needs to be run locally after including materal file (see example in testing below)
	$cc = get_defined_constants(true)['user'];		$cc = get_defined_constants(true)['user'];