Practical debugging - Historial de revisió

Denis: /* Debugging my game when it cannot start */

2014-11-20T20:40:25Z

Debugging my game when it cannot start

← Versió més antiga		Revisió del 22:40, 20 nov 2014
Línia 29:		Línia 29:
	* Your PHP "setup" - or any method used during the game initial states - generates an exception.		* Your PHP "setup" - or any method used during the game initial states - generates an exception.

	If the error is not explicitly displayed when you click on "Express start", you should check the "Gameserver error log" ~~in the~~ [[~~Studio_back-office\|~~Studio ~~backoffice~~]].		If the error is not explicitly displayed when you click on "Express start", you should check the "Gameserver error log" as per [[Studio logs]].

	== Debugging my PHP game logic (or my view) ==		== Debugging my PHP game logic (or my view) ==

Een: /* Add traces to your code */

2013-05-19T20:14:01Z

Add traces to your code

← Versió més antiga		Revisió del 22:14, 19 maig 2013
Línia 55:		Línia 55:
	You can use the following functions in your game to add server side logging:		You can use the following functions in your game to add server side logging:

	'''self::debug( $message )'''		'''self::debug( $message );''' // debug level logging

	'''self::trace( $message )'''		'''self::trace( $message );''' // info level logging

	'''self::warn( $message )'''		'''self::warn( $message );''' // warning level logging

	'''self::error( $message )'''		'''self::error( $message );''' // error level logging

	To see the logs, you should check the "Current table error log" in the [[Studio_back-office\|Studio backoffice]].		To see the logs, you should check the "Current table error log" in the [[Studio_back-office\|Studio backoffice]].

Een: /* Debugging my PHP game logic (or my view) */

2013-05-19T19:32:34Z

Debugging my PHP game logic (or my view)

← Versió més antiga		Revisió del 21:32, 19 maig 2013
Línia 50:		Línia 50:

	</pre>		</pre>

			=== Add traces to your code ===

			You can use the following functions in your game to add server side logging:

			'''self::debug( $message )'''

			'''self::trace( $message )'''

			'''self::warn( $message )'''

			'''self::error( $message )'''

			To see the logs, you should check the "Current table error log" in the [[Studio_back-office\|Studio backoffice]].

			This can be useful when you need to follow the flow of your code and not just stop it to see how it goes at some point.

			Only the error log level will appear in production. This level should be used only for critical problems.
			Other levels will show only in the development environment and can be used as you see fit.

	== Debugging my HTML/CSS layout ==		== Debugging my HTML/CSS layout ==

Een: /* Javascript does not know how to sum two numbers */

2013-02-15T15:09:18Z

Javascript does not know how to sum two numbers

← Versió més antiga		Revisió del 17:09, 15 feb 2013
Línia 155:		Línia 155:
	</pre>		</pre>

	To solve this, ~~to hesitate to~~ use the "toint" function:		To solve this, you should use the "toint" function:
	<pre>		<pre>
	var i=1;		var i=1;

Sourisdudesert: /* Javascript does not know how to sum two numbers */

2013-01-30T16:35:03Z

Javascript does not know how to sum two numbers

@@ Línia 160: / Línia 160: @@
      i += toint( notif.args.increment );  // With notif.args.increment='1'
      alert( i );                 // i=2 :)
 </pre>

Sourisdudesert: /* Some frequent errors */

2013-01-30T16:31:34Z

Some frequent errors

← Versió més antiga		Revisió del 18:31, 30 gen 2013
Línia 122:		Línia 122:

	If there is really nothing on the log, it's probably that the system was unable to load your Javascript because of an syntax error that affect the structure of the Javascript file, typically a missing "}" or a missing "," after a method definition.		If there is really nothing on the log, it's probably that the system was unable to load your Javascript because of an syntax error that affect the structure of the Javascript file, typically a missing "}" or a missing "," after a method definition.

			=== When I do a move, I got "Move recorded, waiting for update ..." forever ===

			"Move recorded" means that your ajaxcall request has been sent to the server and returned normally.

			"Waiting for update" means that your client interface is waiting for some notifications from the server that correspond to the move we just did.

			If this message stays forever, it is probably that your PHP code does not send any notification when the move happens, which is abnormal. To fix this: add a notifyAllPlayers or a notifyPlayer call in your PHP code.

			=== Some player action is triggered randomly when I click somewhere on the game area ===

			You probably used "dojo.connect" on a null object. In this case, dojo.connect associate the event (ex: "onclick") to the whole game area.

			Most of the time it happens in this situation, when my_object element does not exists:
			<pre>
			dojo.connect( $("my_object"), "onclick", this, function() {
			...
			}
			</pre>

			To determine if this is the case, place "alert( $("my_object") )" before the dojo.connect to check if the object exists or not.

			=== Javascript does not know how to sum two numbers ===

			Be careful when you manipulate integers returned by notifications: most of the time, Javascript considers they are Strings and not Integers.

			As a result:
			<pre>
			var i=1;
			i += notif.args.increment; // With notif.args.increment='1'
			alert( i ); // i=11 instead of 2 !! Javascript concatenate 2 strings !
			</pre>

			To solve this, to hesitate to use the "toint" function:
			<pre>
			var i=1;
			i += toint( notif.args.increment ); // With notif.args.increment='1'
			alert( i ); // i=2 :)
			</pre>

Sourisdudesert: /* Some frequent errors */

2013-01-30T16:17:01Z

Some frequent errors

← Versió més antiga		Revisió del 18:17, 30 gen 2013
Línia 114:		Línia 114:

	As a general rule, you should use getActivePlayerId() and not getCurrentPlayerId(). See the [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine presentation on the game state machine] for more information.		As a general rule, you should use getActivePlayerId() and not getCurrentPlayerId(). See the [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine presentation on the game state machine] for more information.

			=== when refreshing the web page, the interface remains on "Application loading..." ===

			In this case, you probably have a syntax error in your Javascript code, and the interface refuses to load.

			To find this error, check if there is an error message in the Javascript console (F12).

			If there is really nothing on the log, it's probably that the system was unable to load your Javascript because of an syntax error that affect the structure of the Javascript file, typically a missing "}" or a missing "," after a method definition.

Sourisdudesert: /* Some frequent errors */

2013-01-29T22:49:46Z

Some frequent errors

← Versió més antiga		Revisió del 00:49, 30 gen 2013
Línia 106:		Línia 106:

	== Some frequent errors ==		== Some frequent errors ==

			=== when launching the game "Fatal error during creation of database ebd_quoridor_389 Not logged." ===

			Check that you didn't use $g_user or getCurrentPlayerId() in setupNewGame() function or in an "args" function of your state.

			As these functions are not consequences of a user action, there is no current player defined.

			As a general rule, you should use getActivePlayerId() and not getCurrentPlayerId(). See the [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine presentation on the game state machine] for more information.

Sourisdudesert: /* What is the best way to debug? */

2013-01-29T22:49:08Z

What is the best way to debug?

← Versió més antiga		Revisió del 00:49, 30 gen 2013
Línia 106:		Línia 106:

	== Some frequent errors ==		== Some frequent errors ==


	~~== What is the best way to debug? ==~~



	~~On the client side (Javascript), we recommand installing Firebug for Firefox (or using the 'Developer tools' with Chrome that have about the same functionalities), then:~~




	~~=== Some frequent errors ===~~

	~~; The following error occurs when launching the game "Fatal error during creation of database ebd_quoridor_389 Not logged."~~
	: Check that you didn't use $g_user or getCurrentPlayerId() in setupNewGame() function or in an "args" function of your state. As these functions are not consequences of a user action, there is no current player defined. As a general rule, you should use getActivePlayerId() and not getCurrentPlayerId(). See the [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine presentation on the game state machine] for more information.

Sourisdudesert: /* Debugging my Javascript game interface logic */

2013-01-29T22:48:50Z

Debugging my Javascript game interface logic

← Versió més antiga		Revisió del 00:48, 30 gen 2013
Línia 76:		Línia 76:

	== Debugging my Javascript game interface logic ==		== Debugging my Javascript game interface logic ==

			Compare to PHP debugging, Javascript debugging can sometimes be painful.

			Here's are some tips to make your life easier while developing and debugging Javascript:

			=== Do complex things on PHP side ===

			PHP side is more reliable and simpler to debug than Javascript. Then, when you need to perform a complex operation, check first it you can't write it on server side first.

			The most frequent case is the following: you want to compute possible moves in a game situation. Doing it in Javascript is a nightmare. Then, do it on PHP, and transfer the result to your client interface using the "args" game state property.

			Note: check Reversi example for this.

			=== Add traces in your code ===

			You can use the following:

			'''console.log( variable_to_inspect )'''

			It will give you the object structure of the variable in the Javascript console, without blocking the execution.

			It's often a good idea to precede this call with a console.log( '### HERE ###' ); to find more easily the appropriate line in the console log.

			'''alert( variable_to_inspect )'''

			It will popup what you wish and pause the execution until you click ok.

			This won't be useful for complex structures, only native types will get plainly displayed. But this is sometimes useful just with messages to make sure which way the execution goes.

	== Some frequent errors ==		== Some frequent errors ==