Pickups are used to create a pickup-able kit at a specific location. While somewhat similar to a kit applied using a region, pickups are represented by a physical object and have a refresh time.
By default an ender crystal entity is used to show the pickup location.
When a player walks into the crystal it gives them a kit and then de-spawns.
The crystal will respawn again at a random location inside the specified region after the set respawn time.
This means that the pickup’s region must be randomize-able, e.g. a <cuboid>
, <cylinder>
, <block>
or <point>
.
A <point>
region does not return a randomized position but can still be used to specify an exact location for a pickup.
Pickups Element | Description | |
---|---|---|
<pickups> </pickups>
|
Node containing all the pickups. | |
Sub-elements | Value/Children | |
<pickup/>
|
A single pickup. | Pickup Sub-elements |
Attribute | Description | Type | Default |
---|---|---|---|
id
|
Unique identifier used to reference this pickup from other places in the XML. | String | |
name
|
The display name of this pickup, shown above the pickup entity if present. | Formatted Text | |
appearance
|
Entity used to show this pickup's location. Currently only accepts ENDER CRYSTAL
|
Entity Type | Ender Crystal |
spawn-filter
|
Property Filter if this pickup is and can be spawned. | Filter |
<always/>
|
pickup-filter
|
Property Filter who can pick up the pickup's kit. | Filter |
<always/>
|
region
|
Property Required Region where the pickup entity is placed into. | Randomize-able Region | |
kit
|
Property The kit to give to players who pick up this pickup. | Kit ID | |
respawn-time
|
Time until the pickup entity is re-spawned after being picked up.
If set to zero the entity will not despawn and will simply be refreshed. |
Time Period | 3 sec |
pickup-time
|
Time until the pickup is refreshed and can be picked up again. | Time Period | 3 sec |
effects
|
Show the pickup's particle effects. | true/false | true |
sounds
|
Play the pickup's sound effects. | true/false | true |
Element | Description | Value | Default |
---|---|---|---|
<spawn-filter>
|
Property Filter if this pickup is and can be spawned. | Filters |
<always/>
|
<pickup-filter>
|
Property Filter who can pick up the pickup's kit. | Filters |
<always/>
|
<region>
|
Property Required Region where this pickup is placed into. | Randomize-able Regions | |
<kit>
|
Property The kit to give to players who pick up this pickup. | Kits |
Examples
<pickups>
<pickup id="archer-pickup" name="`3Archery" region="archery-tower" kit="archery-kit" refresh="5m"/>
<pickup id="healing-pickup" name="`4Healing Station" region="heal-station" refresh="1m">
<kit>
<effect duration="10" amplifier="4">instant_health</effect>
</kit>
</pickup>
</pickups>
<pickups>
<pickup id="speed-powerup" region="powerups" kit="speed-kit" refresh="10s"/>
<!-- ... -->
<pickup id="poison-powerdown" region="powerups" kit="poison-kit" refresh="10s"/>
</pickups>