RemoveMinerals (Harvest)

From OxeyeWiki

Jump to: navigation, search

removeMinerals()

removeMinerals(id)

removeMinerals(id, amount)

removeMinerals(x, y, radius)

removeMinerals(x, y, radius, amount)

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 Number When this value is used, it specifies a specific mineral patch to modify.
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).
x Number When this value is used, it specifies the center x coordinate of the search circle.
y Number When this value is used, it specifies the center y coordinate of the search circle.
radius Number When this value is used, it specifies the radius of the search circle.
left Number When this value is used, it specifies the left edge of the search rectangle.
top Number When this value is used, it specifies the top edge of the search rectangle.
right Number When this value is used, it specifies the right edge of the search rectangle.
bottom Number When this value is used, it specifies the bottom edge of the search rectangle.
Returns

Returns nothing.

Harvest Library


Example


Resources

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox