TakeHerbs

Takes away every herb of a kind within a circle, as a pick would - for its regrow time, a time of the mode’s, or for good.

The plants are gone from every player’s world and come back like a picked spot - after the kind’s regrow time, after seconds, or with seconds = 0 only when the mode resets it (ResetHerb with the key this returns). Nobody gets an item. The radius is 0.05 to 50 metres. Needs [containers] world_items.

Syntax

TakeHerbs(kind, x, y, z, radius, seconds)

Parameter	Type
kind	string	the item name, its class GUID, or "*" for every kind
x	number	metres
y	number	metres
z	number	metres
radius	number	metres
seconds	number	real seconds until it grows back (optional; nil = the kind’s regrow time, 0 = never on its own)

Returns

string - the spot’s key, or nil and the reason

Example

-- the soldiers trampled the meadow: nothing grows there for an hour
TakeHerbs("*", 1210, 2290, 140, 25, 3600)

See also

ResetHerb · SetHerbsEnabled · the Herbs and mushrooms group of the index