SandboxScripts - Revision history

Exciting-horse430: Blanked the page

2025-04-03T07:45:05Z

Blanked the page

2022-05-17T01:18:35Z

2020-03-19T07:33:22Z

Javascript

← Older revision		Revision as of 07:33, 19 March 2020
Line 8:		Line 8:
	Using Javascript, you can write scripts to automate moves for your Sandbox games & provide rules reinforcement.		Using Javascript, you can write scripts to automate moves for your Sandbox games & provide rules reinforcement.

	Important : ~~in the opposite of~~ the most common usage of Javascript, Sandbox scripts are executed '''on server side'''.		Important : Contrary to the most common usage of Javascript, Sandbox scripts are executed '''on server side'''.

	= BGA API =		= BGA API =

2018-05-25T09:03:30Z

Trigger most common game actions

← Older revision		Revision as of 09:03, 25 May 2018
Line 271:		Line 271:
	=== shuffle( element_ids ) ===		=== shuffle( element_ids ) ===

	Shuffle elements contained inside ~~this~~ element (or array of elements).		Shuffle elements contained inside the target element (or array of elements).

			=== roll( element_ids ) ===

			Roll the target element (or array of elements). Target elements must have the property "Can be rolled" set.

			=== setDie( element_ids, value ) ===

			Set the target element (or array of elements) with this value. Target elements must have the property "Can set value" set.

	=== deal( deck_id, target_tag, nbr_per_target ) ===		=== deal( deck_id, target_tag, nbr_per_target ) ===

2018-05-22T09:18:56Z

Examples/Tutorials

← Older revision		Revision as of 09:18, 22 May 2018
Line 53:		Line 53:
	== Examples/Tutorials ==		== Examples/Tutorials ==

	In addition to the projects you will create, you have readonly access in the sandbox to two example projects ~~(one~~ is an abstract~~, the other one~~ is a card game).		In addition to the projects you will create, you have readonly access in the sandbox to two example projects: "linesofaction" is an abstract and "apocalypseazcc" is a card game.

	These two projects are fully scripted, so you can check out the scripts and use them as examples/tutorials.		These two projects are fully scripted, so you can check out the scripts and use them as examples/tutorials.

2018-05-18T16:00:55Z

Quick start: Examples

← Older revision		Revision as of 16:00, 18 May 2018
Line 50:		Line 50:

	* On Board Game Arena, players have come to expect fully implemented games with all rules enforced. So even if it's technically possible not to script the full game and to implement the game only partially, in most cases we'll publish only fully scripted games :)		* On Board Game Arena, players have come to expect fully implemented games with all rules enforced. So even if it's technically possible not to script the full game and to implement the game only partially, in most cases we'll publish only fully scripted games :)

			== Examples/Tutorials ==

			In addition to the projects you will create, you have readonly access in the sandbox to two example projects (one is an abstract, the other one is a card game).

			These two projects are fully scripted, so you can check out the scripts and use them as examples/tutorials.

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

2018-05-18T08:58:17Z

Trigger most common game actions

← Older revision		Revision as of 08:58, 18 May 2018
Line 254:		Line 254:
	// Example :		// Example :
	bga.moveTo( bga.getElementIdByName( 'Turn counter' ), bga.getElementIdByName( 'Turn 3' ) );		bga.moveTo( bga.getElementIdByName( 'Turn counter' ), bga.getElementIdByName( 'Turn 3' ) );

			=== removeElement( id ) ===

			Deletes all properties from this element and remove it from play. Warning: it won't be recoverable! If you may need it later, you should move it inside a zone with visibility set to "Everyone, but hide what's inside" instead of removing it.

	=== flip( element_ids ) ===		=== flip( element_ids ) ===

2018-05-18T08:54:38Z

stopEvent()

2018-05-18T08:54:29Z

Other functions

← Older revision		Revision as of 08:54, 18 May 2018
Line 374:		Line 374:

	Tips : if you want to execute several consecutive "moveTo", you should "bga.pause" between them, otherwise your element will move directly to the final destination.		Tips : if you want to execute several consecutive "moveTo", you should "bga.pause" between them, otherwise your element will move directly to the final destination.

			=== stopEvent() ===

			Must be used to stop the event propagation if you have two clickable elements on top of one another and you want only the onclick function matching the one on top to be triggered.

			function onClickCard( card_id, selection_ids ) {
			// Cancel event propagation
			bga.stopEvent();

			[... manage the event ...]
			}

	=== hasTag( id, tag ) ===		=== hasTag( id, tag ) ===

2018-05-18T08:52:12Z

Gamestate functions

← Older revision		Revision as of 08:52, 18 May 2018
Line 349:		Line 349:

	Returns an array of players with the players information.		Returns an array of players with the players information.

			=== setGameProgression( progression ) ===

			Updates the game progression percentage (progression must be an integer between 0 and 100)

	=== endGame() ===		=== endGame() ===