RemoveMinerals (Harvest)
From OxeyeWiki
(Difference between revisions)
Jeb (Talk | contribs)
(Created page with '{{HarvestMethod | harvest.removeMinerals() harvest.removeMinerals(id) harvest.removeMinerals(id, amount) harvest.removeMinerals(x, y, radius) harvest.removeMinerals(x, y, rad...')
Newer edit →
(Created page with '{{HarvestMethod | harvest.removeMinerals() harvest.removeMinerals(id) harvest.removeMinerals(id, amount) harvest.removeMinerals(x, y, radius) harvest.removeMinerals(x, y, rad...')
Newer edit →
Revision as of 07:22, 31 March 2009
|
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. | ||
| Parameter | Expected Type | Description |
| id | An integer | When this value is used, it specifies a specific mineral patch to modify. |
| 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). |
| x | A number | When this value is used, it specifies the center x coordinate of the search circle. |
| y | A number | When this value is used, it specifies the center y coordinate of the search circle. |
| radius | A number | When this value is used, it specifies the radius of the search circle. |
| left | A number | When this value is used, it specifies the left edge of the search rectangle. |
| top | A number | When this value is used, it specifies the top edge of the search rectangle. |
| right | A number | When this value is used, it specifies the right edge of the search rectangle. |
| bottom | A number | When this value is used, it specifies the bottom edge of the search rectangle. |
| Returns | ||
|
Returns nothing. | ||
