SandboxScripts - تاریخچهٔ نسخه‌ها

Sourisdudesert: /* bga.getElement( selector, (optionnal) fields ) */

2017-01-04T18:17:05Z

bga.getElement( selector, (optionnal) fields )

→ نسخهٔ قدیمی‌تر		نسخهٔ ‏۴ ژانویهٔ ۲۰۱۷، ساعت ۲۰:۱۷
خط ۱۴۸:		خط ۱۴۸:
	The following examples are showing all the possible use of bga.getElement :		The following examples are showing all the possible use of bga.getElement :

	// ~~Examples~~ :		// Basic example :

	// Retrieve the ID of a game element using its name ("Deck")		// Retrieve the ID of a game element using its name ("Deck")
	var deck_id = bga.getElement( { name: "Deck" } );		var deck_id = bga.getElement( { name: "Deck" } );
			// Return : 1234

			// Examples using "field" parameter :

			// Retrieve a specific property from a game element using its name ("Deck")
			var deck_id = bga.getElement( { name: "Deck" }, 'x' );
			// Return : 20

	// Retrieve several properties from the previous element		// Retrieve several properties from the previous element
	var deck_properties = bga.getElement( { name: "Deck" }, ['name','id','parent','canShuffle'] );		var deck_properties = bga.getElement( { name: "Deck" }, ['name','id','parent', 'x','y','canShuffle'] );
			// Return : { name:'Deck', id:1234, parent:4321, x: 20, y:50, canShuffle: true }

			// Note : as you can see, getElement returns:
			// _ the element ID by default, or
			// _ a single value if you request a single field, or
			// _ an object if you request several fields

			// Examples using different "selector" paramter

			// Retrieve an element name from its id
			var deck_name = bga.getElement( { id: 1234 }, ['name'] );
			// Return : "Deck"

			// Retrieve the last child element of another element
			// Here, we are requesting for elements who has element with ID=1234 (Deck) as their parent
			// Note the use of "limit:1" which allows us to retrieve only 1 element.
			var first_card_on_deck_id = bga.getElement( { parent: 1234, limit:1 } );
			//

Sourisdudesert: /* Get / search game elements and their properties */

2017-01-04T18:04:13Z

Get / search game elements and their properties

@@ خط ۱۳۷: / خط ۱۳۷: @@
 == Get / search game elements and their properties ==
@@ خط ۱۸۲: / خط ۲۰۲: @@
    // Result : [ 41, 42, 43, ... ]
 == Utility methods ==

Sourisdudesert در ‏۴ ژانویهٔ ۲۰۱۷، ساعت ۱۷:۵۸

2017-01-04T17:58:04Z

→ نسخهٔ قدیمی‌تر		نسخهٔ ‏۴ ژانویهٔ ۲۰۱۷، ساعت ۱۹:۵۸
خط ۲۰۶:		خط ۲۰۶:
	// Example :		// Example :
	bga.moveElement( bga.getElementIdByName( 'Turn counter' ), bga.getElementIdByName( 'Turn 3' ) );		bga.moveElement( bga.getElementIdByName( 'Turn counter' ), bga.getElementIdByName( 'Turn 3' ) );


			== Other functions ==

			=== pause( milliseconds ) ===

			Pause the client interface during a specified number of milliseconds.

			If you do not use bga.pause, all Sandbox game actions are executed immediately and synchronously.

			// Example :
			bga.log( "1" ); // Will be displayed immediately on the log
			bga.pause( 3000 ); // pause during 3 seconds
			bga.log( "2" ); // Will be displayed after the 3 second on the log
			bga.log( "3" ); // Will be displayed right after the previous one, without delay.


			All game actions performed after this call will

Sourisdudesert: /* Top useful tips */

2017-01-04T17:53:52Z

Top useful tips

→ نسخهٔ قدیمی‌تر		نسخهٔ ‏۴ ژانویهٔ ۲۰۱۷، ساعت ۱۹:۵۳
خط ۴۲:		خط ۴۲:

	* Alternatively to bga.log(), you can use bga.exit( "my message" ) to debug your script. With bga.exit, the script execution immediately stops and all previous game changes are cancelled, so this is very practical to try and retry an action until your script is fine.		* Alternatively to bga.log(), you can use bga.exit( "my message" ) to debug your script. With bga.exit, the script execution immediately stops and all previous game changes are cancelled, so this is very practical to try and retry an action until your script is fine.

			* We advise you to develop first a full playable version of the game without the scripts, and THEN to script it.

			* This is not mandatory to script the full game! You can start by automate most painful game actions first, publish the game, and then continue later :)

	= Functions you can use in your Sandbox scripts=		= Functions you can use in your Sandbox scripts=

Sourisdudesert: /* bga.error( text ) */

2017-01-04T17:50:40Z

bga.error( text )

→ نسخهٔ قدیمی‌تر		نسخهٔ ‏۴ ژانویهٔ ۲۰۱۷، ساعت ۱۹:۵۰
خط ۹۵:		خط ۹۵:
	Note : most of the time, you should wrap your text inside a _() translation marker to make this string translatable.		Note : most of the time, you should wrap your text inside a _() translation marker to make this string translatable.

	== bga.error( text ) ==		=== bga.error( text ) ===

	This is the function to use when some unexpected error happens in your script.		This is the function to use when some unexpected error happens in your script.

Sourisdudesert: /* bga.cancel( txt ) */

2017-01-04T17:50:31Z

bga.cancel( txt )

→ نسخهٔ قدیمی‌تر		نسخهٔ ‏۴ ژانویهٔ ۲۰۱۷، ساعت ۱۹:۵۰
خط ۸۲:		خط ۸۲:
	== Cancelling a game action ==		== Cancelling a game action ==

	== bga.cancel( txt ) ==		=== bga.cancel( txt ) ===

	This is the function to use when a player is doing something against game rules.		This is the function to use when a player is doing something against game rules.

Sourisdudesert: /* Debugging functions */

2017-01-03T18:03:50Z

Debugging functions

@@ خط ۴۷: / خط ۴۷: @@
 == Debugging functions ==
-=== bga.trace( txt ) ===
+=== bga.trace( txt / obj ) ===
 Write something immediately in the BGA log (on the right of the screen).
@@ خط ۶۶: / خط ۶۶: @@
    bga.trace( { mykey: 'myvalue', another_key: 'another_value' } );
-=== bga.exit( txt ) ===
+=== bga.exit( txt / obj ) ===
 Stop the script immediately, display the "txt" messages and cancel (ie : rollback) on every previous API call except bga.trace :
@@ خط ۷۹: / خط ۷۹: @@
    // Example with dumping a javascript variable
    bga.exit( my_variable_to_dump );
 == Game log (history) ==

Sourisdudesert: /* bga.exit( txt ) */

2017-01-03T17:56:04Z

bga.exit( txt )

→ نسخهٔ قدیمی‌تر		نسخهٔ ‏۳ ژانویهٔ ۲۰۱۷، ساعت ۱۹:۵۶
خط ۷۰:		خط ۷۰:
	Stop the script immediately, display the "txt" messages and cancel (ie : rollback) on every previous API call except bga.trace :		Stop the script immediately, display the "txt" messages and cancel (ie : rollback) on every previous API call except bga.trace :

	~~Again :~~ ALL api call are canceled and there will be no visible changes on the interface (ex : no moves, no visible property changes, ...). Only "bga.trace" API commands are kept so you can debug.		ALL previous BGA api call are canceled and there will be no visible changes on the interface (ex : no moves, no visible property changes, ...). Only "bga.trace" API commands are kept so you can debug.

	bga.exit is very practical when you want to repeat a game action again and again to debug it : with a call to bga.exit at the end of your script, you make sure that your game situation will be kept unchanged after each test.		bga.exit is very practical when you want to repeat a game action again and again to debug it : with a call to bga.exit at the end of your script, you make sure that your game situation will be kept unchanged after each test.
خط ۷۶:		خط ۷۶:
	// Example :		// Example :
	bga.exit( "My script is stopped by this call" );		bga.exit( "My script is stopped by this call" );

			// Example with dumping a javascript variable
			bga.exit( my_variable_to_dump );

	== Game log (history) ==		== Game log (history) ==

Sourisdudesert: /* bga.trace( txt ) */

2017-01-03T17:54:45Z

bga.trace( txt )

→ نسخهٔ قدیمی‌تر		نسخهٔ ‏۳ ژانویهٔ ۲۰۱۷، ساعت ۱۹:۵۴
خط ۵۲:		خط ۵۲:

	This is the most practical way to debug your script :)		This is the most practical way to debug your script :)

			Important : bga.trace is for debugging purpose only and won't be displayed on production.

	Note : you can also pass an object in parameter. This will dump the content of this object in the log.		Note : you can also pass an object in parameter. This will dump the content of this object in the log.

			Note : in the opposite of bga.log, bga.trace is NOT cancelled if the game action failed (after a call to bga.cancel or bga.error). This makes bga.trace very practical to debug a game action that failed, and for this reason you should probably NEVER use bga.log for debugging purpose.

Sourisdudesert: /* Sandbox Scripts Hello World */

2017-01-03T17:51:40Z

Sandbox Scripts Hello World

→ نسخهٔ قدیمی‌تر		نسخهٔ ‏۳ ژانویهٔ ۲۰۱۷، ساعت ۱۹:۵۱
خط ۱۶:		خط ۱۶:
	With this API, you can get properties values of game elements from the current game situation, modify them and/or trigger the game actions (ex : move this element here, flip this card, and so on).		With this API, you can get properties values of game elements from the current game situation, modify them and/or trigger the game actions (ex : move this element here, flip this card, and so on).

	= ~~Sandbox Scripts~~ Hello World =		= Quick start =

			== Hello World Script ==

	From Sandbox editor "interface view" tab, select an element, and access to its property (top right icon).		From Sandbox editor "interface view" tab, select an element, and access to its property (top right icon).
خط ۳۴:		خط ۳۶:

	Save & publish your project, starts a test session, click on the previous element : your message appears in the log on the right!		Save & publish your project, starts a test session, click on the previous element : your message appears in the log on the right!

			== Top useful tips ==

			* You don't have to save&publish from the Sandbox editor for each modification of your script : each time you save your script (control+S), the script used for all test sessions is updated. Note that the production version on BGA is of course NOT updated until you explicitly save&publish again your project.

			* Alternatively to bga.log(), you can use bga.exit( "my message" ) to debug your script. With bga.exit, the script execution immediately stops and all previous game changes are cancelled, so this is very practical to try and retry an action until your script is fine.

	= Functions you can use in your Sandbox scripts=		= Functions you can use in your Sandbox scripts=