Script3 Things - Revision history

Brandan: Undo revision 6785 by IncaWarrior (talk) ObjectProxy is required for long term storage else the game might crash if the shaman dies.

2019-04-22T22:33:54Z

Undo revision 6785 by IncaWarrior (talk) ObjectProxy is required for long term storage else the game might crash if the shaman dies.

← Older revision		Revision as of 15:33, 22 April 2019
Line 73:		Line 73:
	===== Correct Code =====		===== Correct Code =====
	<source lang="javascript">		<source lang="javascript">
	global ~~shaman~~ = getShaman(TRIBE_BLUE);		global shamanProxy = ObjectProxy(getShaman(TRIBE_BLUE));

	def OnTurn()		def OnTurn()
	{		{
	if (!~~shaman~~.isNull())		if (!shamanProxy.isNull())
	{		{
	var t_thing = ~~shaman~~.get();		var t_thing = shamanProxy.get();
	log(t_thing.ThingNum);		log(t_thing.ThingNum);
	}		}
Line 88:		Line 88:
	}		}
	</source>		</source>

	===== Bad Code =====		===== Bad Code =====
	<source lang="javascript">		<source lang="javascript">

IncaWarrior: /* Correct Code */ made correct code closer to bad code

2019-04-18T01:35:27Z

Correct Code: made correct code closer to bad code

← Older revision		Revision as of 18:35, 17 April 2019
Line 73:		Line 73:
	===== Correct Code =====		===== Correct Code =====
	<source lang="javascript">		<source lang="javascript">
	global ~~shamanProxy~~ = ~~ObjectProxy(~~getShaman(TRIBE_BLUE));		global shaman = getShaman(TRIBE_BLUE);

	def OnTurn()		def OnTurn()
	{		{
	if (!~~shamanProxy~~.isNull())		if (!shaman.isNull())
	{		{
	var t_thing = ~~shamanProxy~~.get();		var t_thing = shaman.get();
	log(t_thing.ThingNum);		log(t_thing.ThingNum);
	}		}
Line 88:		Line 88:
	}		}
	</source>		</source>

	===== Bad Code =====		===== Bad Code =====
	<source lang="javascript">		<source lang="javascript">

Brandan at 20:36, 17 April 2019

2019-04-17T20:36:42Z

← Older revision		Revision as of 13:36, 17 April 2019
Line 60:		Line 60:
	=== Bad Code Vs. Good Code ===		=== Bad Code Vs. Good Code ===

	===== Bad Code: =====		===== Bad Code =====
	<source lang="javascript">		<source lang="javascript">
	global shaman = getShaman(TRIBE_BLUE);		global shaman = getShaman(TRIBE_BLUE);
Line 71:		Line 71:
	Reason: Shaman may not exist on the next turn and will not become null.		Reason: Shaman may not exist on the next turn and will not become null.

	===== Correct Code: =====		===== Correct Code =====
	<source lang="javascript">		<source lang="javascript">
	global shamanProxy = ObjectProxy(getShaman(TRIBE_BLUE));		global shamanProxy = ObjectProxy(getShaman(TRIBE_BLUE));
Line 88:		Line 88:
	}		}
	</source>		</source>
	===== Bad Code: =====		===== Bad Code =====
	<source lang="javascript">		<source lang="javascript">
	global shamanProxy = ObjectProxy(getShaman(TRIBE_BLUE));		global shamanProxy = ObjectProxy(getShaman(TRIBE_BLUE));
Line 100:		Line 100:
	Reason: Once the shaman object dies shaman will become null, thus it is required to check if it is null before accessing else the game will crash.		Reason: Once the shaman object dies shaman will become null, thus it is required to check if it is null before accessing else the game will crash.

	===== Good code: =====		===== Good code =====
	<source lang="javascript">		<source lang="javascript">
	global shamanProxy = ObjectProxy(getShaman(TRIBE_BLUE));		global shamanProxy = ObjectProxy(getShaman(TRIBE_BLUE));

Brandan at 20:35, 17 April 2019

2019-04-17T20:35:59Z

← Older revision		Revision as of 13:35, 17 April 2019
Line 73:		Line 73:
	===== Correct Code: =====		===== Correct Code: =====
	<source lang="javascript">		<source lang="javascript">
	global ~~shaman~~ = ObjectProxy(getShaman(TRIBE_BLUE));		global shamanProxy = ObjectProxy(getShaman(TRIBE_BLUE));

	def OnTurn()		def OnTurn()
Line 90:		Line 90:
	===== Bad Code: =====		===== Bad Code: =====
	<source lang="javascript">		<source lang="javascript">
	global ~~shaman~~ = ObjectProxy(getShaman(TRIBE_BLUE));		global shamanProxy = ObjectProxy(getShaman(TRIBE_BLUE));

	def OnTurn()		def OnTurn()

Brandan at 01:26, 16 April 2019

2019-04-16T01:26:02Z

← Older revision		Revision as of 18:26, 15 April 2019
Line 44:		Line 44:
	=== Example 1 ===		=== Example 1 ===

	For example the this function giveMeFirstThingNum should always give a Thing that exists and does not need to be checked if it is null. However the return value of ProcessGlobalUsedList is not guaranteed to exist so that needs to be checked for null. Remember ProcessGlobalUsedList returns the last object processed on a return false, else it returns null.		For example the this function giveMeFirstThingNum should always give a Thing that exists and does not need to be checked if it is null. However the return value of ProcessGlobalUsedList is not guaranteed to exist so that needs to be checked for null. Remember ProcessGlobalUsedList returns the last object processed on a return false, else it returns null.
	# def giveMeFirstThingNum(Thing)		<source lang="javascript">
	# {		def giveMeFirstThingNum(Thing)
	# log(Thing.ThingNum);		{
	# return false;		log(Thing.ThingNum);
	# }		return false;
	# var retT = ProcessGlobalUsedList(giveMeFirstThingNum);		}
	#		var retT = ProcessGlobalUsedList(giveMeFirstThingNum);
	# if (retT.is_var_null())
	# {		if (retT.is_var_null())
	# log(retT.ThingNum);		{
	# }		log(retT.ThingNum);
			}
			</source>
	=== Bad Code Vs. Good Code ===		=== Bad Code Vs. Good Code ===

	===== Bad Code: =====		===== Bad Code: =====
	# global shaman = getShaman(TRIBE_BLUE);		<source lang="javascript">
	#		global shaman = getShaman(TRIBE_BLUE);
	# def OnTurn()
	# {		def OnTurn()
	# log(shaman.ThingNum);		{
	# }		log(shaman.ThingNum);
			}
			</source>
	Reason: Shaman may not exist on the next turn and will not become null.		Reason: Shaman may not exist on the next turn and will not become null.

	===== Correct Code: =====		===== Correct Code: =====
	# global shaman = ObjectProxy(getShaman(TRIBE_BLUE));		<source lang="javascript">
	#		global shaman = ObjectProxy(getShaman(TRIBE_BLUE));
	# def OnTurn()
	# {		def OnTurn()
	# if (!shamanProxy.isNull())		{
	# {		if (!shamanProxy.isNull())
	# var t_thing = shamanProxy.get();		{
	# log(t_thing.ThingNum);		var t_thing = shamanProxy.get();
	# }		log(t_thing.ThingNum);
	# else		}
	# {		else
	# log("Shaman has died");		{
	# }		log("Shaman has died");
	# }		}
			}
			</source>
	===== Bad Code: =====		===== Bad Code: =====
	# global shaman = ObjectProxy(getShaman(TRIBE_BLUE));		<source lang="javascript">
	#		global shaman = ObjectProxy(getShaman(TRIBE_BLUE));
	# def OnTurn()
	# {		def OnTurn()
	# var t_thing = shamanProxy.get();		{
	# log(t_thing.ThingNum);		var t_thing = shamanProxy.get();
	# }		log(t_thing.ThingNum);
			}
			</source>
	Reason: Once the shaman object dies shaman will become null, thus it is required to check if it is null before accessing else the game will crash.		Reason: Once the shaman object dies shaman will become null, thus it is required to check if it is null before accessing else the game will crash.

	===== Good code: =====		===== Good code: =====
	# global shamanProxy = ObjectProxy(getShaman(TRIBE_BLUE));		<source lang="javascript">
	#		global shamanProxy = ObjectProxy(getShaman(TRIBE_BLUE));
	# def OnTurn()
	# {		def OnTurn()
	# if (!shamanProxy.isNull())		{
	# {		if (!shamanProxy.isNull())
	# var t_thing = shamanProxy.get();		{
	# log(t_thing .ThingNum);		var t_thing = shamanProxy.get();
	# }		log(t_thing .ThingNum);
	# }		}
			}
			</source>

Brandan: /* Correct Code: */

2019-04-15T19:17:15Z

Correct Code:

← Older revision		Revision as of 12:17, 15 April 2019
Line 76:		Line 76:
	# {		# {
	# var t_thing = shamanProxy.get();		# var t_thing = shamanProxy.get();
	# log(t_thing .ThingNum);		# log(t_thing.ThingNum);
	# }		# }
	# else		# else

Brandan at 19:16, 15 April 2019

2019-04-15T19:16:37Z

← Older revision		Revision as of 12:16, 15 April 2019
Line 73:		Line 73:
	# def OnTurn()		# def OnTurn()
	# {		# {
	# if (!~~shaman~~.isNull())		# if (!shamanProxy.isNull())
	# {		# {
	# log(~~shaman~~.ThingNum);		# var t_thing = shamanProxy.get();
			# log(t_thing .ThingNum);
	# }		# }
	# else		# else
Line 88:		Line 89:
	# def OnTurn()		# def OnTurn()
	# {		# {
	# log(~~shaman~~.ThingNum);		# var t_thing = shamanProxy.get();
			# log(t_thing.ThingNum);
	# }		# }
	Reason: Once the shaman object dies shaman will become null, thus it is required to check if it is null before accessing else the game will crash.		Reason: Once the shaman object dies shaman will become null, thus it is required to check if it is null before accessing else the game will crash.

	===== Good code: =====		===== Good code: =====
	# global ~~shaman~~ = ObjectProxy(getShaman(TRIBE_BLUE));		# global shamanProxy = ObjectProxy(getShaman(TRIBE_BLUE));
	#		#
	# def OnTurn()		# def OnTurn()
	# {		# {
	# if (!~~shaman~~.isNull())		# if (!shamanProxy.isNull())
	# {		# {
	# log(~~shaman~~.ThingNum);		# var t_thing = shamanProxy.get();
			# log(t_thing .ThingNum);
	# }		# }
	# }		# }

Brandan: /* Example 1 */

2019-04-15T18:49:47Z

Example 1

← Older revision		Revision as of 11:49, 15 April 2019
Line 44:		Line 44:
	=== Example 1 ===		=== Example 1 ===

	For example the this function ~~listAllThingNums~~ should always give a Thing that exists and does not need to be checked if it is null. However the return value of ProcessGlobalUsedList is not guaranteed to exist so that needs to be checked for null. Remember ProcessGlobalUsedList returns the last object processed on a return false, else it returns null.		For example the this function giveMeFirstThingNum should always give a Thing that exists and does not need to be checked if it is null. However the return value of ProcessGlobalUsedList is not guaranteed to exist so that needs to be checked for null. Remember ProcessGlobalUsedList returns the last object processed on a return false, else it returns null.
	# def giveMeFirstThingNum(Thing)		# def giveMeFirstThingNum(Thing)
	# {		# {

Brandan: /* Introduction To Things */

2019-04-15T18:46:56Z

Introduction To Things

← Older revision		Revision as of 11:46, 15 April 2019
Line 1:		Line 1:
	== Introduction To Things ==		== Introduction To Things ==
	In [[~~Script3\|~~Script 3]] there is many way you may come across an object named [[Script3_Thing\|Thing]] which is just the name of all objects on the game such as [[huts]], [[brave\|braves]], [[spell\|spells]], etc. Depending on how you come across these objects determines what you must do before you can use them. If you improperly use an object the script engine is not going to tell you; the game will just crash. Any long term storage of a Thing in your scripts should be stored in an [[Script3_ObjectProxy\|ObjectProxy]] and checked for null each access. This is because if you store a raw Thing the Thing might be deleted/destroyed on the next turn and the Thing WILL NOT be null. In fact it may not even be the same Thing anymore. For example lets say you stored a [[shaman]] in a global Thing and the shaman dies on the next turn and that Thing is reused for a hut. The script may think that hut is a shaman and crash.		In [[Script 3]] there is many way you may come across an object named [[Script3_Thing\|Thing]] which is just the name of all objects on the game such as [[huts]], [[brave\|braves]], [[spell\|spells]], etc. Depending on how you come across these objects determines what you must do before you can use them. If you improperly use an object the script engine is not going to tell you; the game will just crash. Any long term storage of a Thing in your scripts should be stored in an [[Script3_ObjectProxy\|ObjectProxy]] and checked for null each access. This is because if you store a raw Thing the Thing might be deleted/destroyed on the next turn and the Thing WILL NOT be null. In fact it may not even be the same Thing anymore. For example lets say you stored a [[shaman]] in a global Thing and the shaman dies on the next turn and that Thing is reused for a hut. The script may think that hut is a shaman and crash.

	If you call any of the ProcessList functions, every one of the calls to your function you specified to ProcessList is guaranteed to exist within the scope of your defined function. However, the return value of ProcessList MUST be checked for null if you are using the return value.		If you call any of the ProcessList functions, every one of the calls to your function you specified to ProcessList is guaranteed to exist within the scope of your defined function. However, the return value of ProcessList MUST be checked for null if you are using the return value.

Brandan: /* Introduction To Things */

2019-04-15T18:44:49Z

Introduction To Things

← Older revision		Revision as of 11:44, 15 April 2019
Line 1:		Line 1:
	== Introduction To Things ==		== Introduction To Things ==
	In Script 3 there is many way you may come across an object named 'Thing' which is just the name of all objects on the game such as huts, braves, spells, etc. Depending on how you come across these objects determines what you must do before you can use them. If you improperly use an object the script engine is not going to tell you; the game will just crash. Any long term storage of a Thing in your scripts should be stored in an ObjectProxy and checked for null each access. This is because if you store a raw Thing the Thing might be deleted/destroyed on the next turn and the Thing WILL NOT be null. In fact it may not even be the same Thing anymore. For example lets say you stored a shaman in a global Thing and the shaman dies on the next turn and that Thing is reused for a hut. The script may think that hut is a shaman and crash.		In [[Script3\|Script 3]] there is many way you may come across an object named [[Script3_Thing\|Thing]] which is just the name of all objects on the game such as [[huts]], [[brave\|braves]], [[spell\|spells]], etc. Depending on how you come across these objects determines what you must do before you can use them. If you improperly use an object the script engine is not going to tell you; the game will just crash. Any long term storage of a Thing in your scripts should be stored in an [[Script3_ObjectProxy\|ObjectProxy]] and checked for null each access. This is because if you store a raw Thing the Thing might be deleted/destroyed on the next turn and the Thing WILL NOT be null. In fact it may not even be the same Thing anymore. For example lets say you stored a [[shaman]] in a global Thing and the shaman dies on the next turn and that Thing is reused for a hut. The script may think that hut is a shaman and crash.

	If you call any of the ProcessList functions, every one of the calls to your function you specified to ProcessList is guaranteed to exist within the scope of your defined function. However, the return value of ProcessList MUST be checked for null if you are using the return value.		If you call any of the ProcessList functions, every one of the calls to your function you specified to ProcessList is guaranteed to exist within the scope of your defined function. However, the return value of ProcessList MUST be checked for null if you are using the return value.