RemoveMinerals (Harvest) - Revision history

166 MMX at 22:55, 2 December 2009

2009-12-02T22:55:49Z

← Older revision		Revision as of 22:55, 2 December 2009
Line 2:		Line 2:
	\|		\|
	removeMinerals()		removeMinerals()
		+
	removeMinerals(id)		removeMinerals(id)
		+
	removeMinerals(id, amount)		removeMinerals(id, amount)
		+
	removeMinerals(x, y, radius)		removeMinerals(x, y, radius)
		+
	removeMinerals(x, y, radius, amount)		removeMinerals(x, y, radius, amount)
		+
	removeMinerals(left, top, right, bottom, amount)		removeMinerals(left, top, right, bottom, amount)
	\|		\|

166 MMX at 22:55, 2 December 2009

2009-12-02T22:55:40Z

← Older revision		Revision as of 22:55, 2 December 2009
Line 1:		Line 1:
	{{HarvestMethod		{{HarvestMethod
	\|		\|
-	~~harvest.~~removeMinerals()	+	removeMinerals()
-		+	removeMinerals(id)
-	~~harvest.~~removeMinerals(id)	+	removeMinerals(id, amount)
-		+	removeMinerals(x, y, radius)
-	~~harvest.~~removeMinerals(id, amount)	+	removeMinerals(x, y, radius, amount)
-		+	removeMinerals(left, top, right, bottom, amount)
-	~~harvest.~~removeMinerals(x, y, radius)	+
-		+
-	~~harvest.~~removeMinerals(x, y, radius, amount)	+
-		+
-	~~harvest.~~removeMinerals(left, top, right, bottom, amount)	+
	\|		\|
	This method removes minerals from the map. The method comes in 5 different forms, depending on the number of parameters you use.		This method removes minerals from the map. The method comes in 5 different forms, depending on the number of parameters you use.
Line 17:		Line 12:
	When the 'amount' value is used, the game will look for minerals and modify the number of minerals remaining in those patches. If the number reaches 0, the minerals patch will be removed.		When the 'amount' value is used, the game will look for minerals and modify the number of minerals remaining in those patches. If the number reaches 0, the minerals patch will be removed.
	\|		\|
-	{{MethodParam\|id\|~~An integer~~\|When this value is used, it specifies a specific mineral patch to modify.}}	+	{{MethodParam\|id\|Number\|When this value is used, it specifies a specific mineral patch to modify.}}
-	{{MethodParam\|amount\|~~An integer~~\|When this value is used, it specifies the amount of minerals to remove from the patch. This value can be negative (which means minerals will be added to the patch).}}	+	{{MethodParam\|amount\|Number\|When this value is used, it specifies the amount of minerals to remove from the patch. This value can be negative (which means minerals will be added to the patch).}}
-	{{MethodParam\|x\|~~A number~~\|When this value is used, it specifies the center x coordinate of the search circle.}}	+	{{MethodParam\|x\|Number\|When this value is used, it specifies the center x coordinate of the search circle.}}
-	{{MethodParam\|y\|~~A number~~\|When this value is used, it specifies the center y coordinate of the search circle.}}	+	{{MethodParam\|y\|Number\|When this value is used, it specifies the center y coordinate of the search circle.}}
-	{{MethodParam\|radius\|~~A number~~\|When this value is used, it specifies the radius of the search circle.}}	+	{{MethodParam\|radius\|Number\|When this value is used, it specifies the radius of the search circle.}}
-	{{MethodParam\|left\|~~A number~~\|When this value is used, it specifies the left edge of the search rectangle.}}	+	{{MethodParam\|left\|Number\|When this value is used, it specifies the left edge of the search rectangle.}}
-	{{MethodParam\|top\|~~A number~~\|When this value is used, it specifies the top edge of the search rectangle.}}	+	{{MethodParam\|top\|Number\|When this value is used, it specifies the top edge of the search rectangle.}}
-	{{MethodParam\|right\|~~A number~~\|When this value is used, it specifies the right edge of the search rectangle.}}	+	{{MethodParam\|right\|Number\|When this value is used, it specifies the right edge of the search rectangle.}}
-	{{MethodParam\|bottom\|~~A number~~\|When this value is used, it specifies the bottom edge of the search rectangle.}}	+	{{MethodParam\|bottom\|Number\|When this value is used, it specifies the bottom edge of the search rectangle.}}
	\|		\|
	Returns nothing.		Returns nothing.
	}}		}}
		+
		+	=== Example ===
		+	<pre>
		+
		+	</pre>
		+
		+	=== Resources ===
		+	*[http://www.oxeyegames.com/forum/viewtopic.php?p=1523#p1523 Oxeye Game Studio Forum - Harvest Functions]

Jeb: Created page with '{{HarvestMethod | harvest.removeMinerals() harvest.removeMinerals(id) harvest.removeMinerals(id, amount) harvest.removeMinerals(x, y, radius) harvest.removeMinerals(x, y, rad...'

2009-03-31T07:22:22Z

Created page with '{{HarvestMethod | harvest.removeMinerals() harvest.removeMinerals(id) harvest.removeMinerals(id, amount) harvest.removeMinerals(x, y, radius) harvest.removeMinerals(x, y, rad...'

New page

{{HarvestMethod
|
harvest.removeMinerals()

harvest.removeMinerals(id)

harvest.removeMinerals(id, amount)

harvest.removeMinerals(x, y, radius)

harvest.removeMinerals(x, y, radius, amount)

harvest.removeMinerals(left, top, right, bottom, amount)
|
This method removes minerals from the map. The method comes in 5 different forms, depending on the number of parameters you use.

When the 'amount' value is used, the game will look for minerals and modify the number of minerals remaining in those patches. If the number reaches 0, the minerals patch will be removed.
|
{{MethodParam|id|An integer|When this value is used, it specifies a specific mineral patch to modify.}}
{{MethodParam|amount|An integer|When this value is used, it specifies the amount of minerals to remove from the patch. This value can be negative (which means minerals will be added to the patch).}}
{{MethodParam|x|A number|When this value is used, it specifies the center x coordinate of the search circle.}}
{{MethodParam|y|A number|When this value is used, it specifies the center y coordinate of the search circle.}}
{{MethodParam|radius|A number|When this value is used, it specifies the radius of the search circle.}}
{{MethodParam|left|A number|When this value is used, it specifies the left edge of the search rectangle.}}
{{MethodParam|top|A number|When this value is used, it specifies the top edge of the search rectangle.}}
{{MethodParam|right|A number|When this value is used, it specifies the right edge of the search rectangle.}}
{{MethodParam|bottom|A number|When this value is used, it specifies the bottom edge of the search rectangle.}}
|
Returns nothing.
}}