For Minecraft: Bedrock Edition 1.4.0
Plugin scheduler rewrite, RCON rewrite, performance improvements, improved idle memory usage
While this release is nominally not an alpha, it is still not feature complete and does not include all gameplay features. Please do not create issues for missing gameplay features.
This build has breaking API changes.
This release is the first to use the new merged versioning system. The PocketMine-MP version and the API version are now one and the same.
Please use our issue tracker to report bugs.
Notable changes
Core
General
- This release introduces a new dependency library called
Snooze
, which PocketMine-MP utilizes for managing notifications between threads. This library is currently utilized by command reading, RCON and RakLib, allowing faster response times to commands, reduced network latency, and better performance due to lack of need for polling. - Fixed race condition causing
ServerKiller
to sometimes kill the server for no reason on shutdown.
Dependency libraries
Requires the following libraries:
pocketmine/raklib
^0.12.0
pocketmine/spl
^0.3.0
pocketmine/binaryutils
^0.1.0
pocketmine/nbt
^0.2.0
pocketmine/math
^0.2.0
pocketmine/snooze
^0.1.0
These libraries may individually have changes which are not recorded here. See their independent repository releases for their changelogs.
Async pooling
- Async workers are now started dynamically when they are needed only, instead of being started immediately on startup. This allows reducing idle memory usage.
- AsyncPool now appropriately shuts down the workers when instructed to, instead of leaving it up to the ThreadManager to clean it up. This eliminates debug messages of shutting down async workers on server shutdown.
- Default maximum async worker memory limit has been lowered from 1024MB to 256MB.
- Async workers are now started using the options
PTHREADS_INHERIT_CONSTANTS | PTHREADS_INHERIT_INI
, which reduces idle memory wastage and works around some bugs in pthreads.
Entities
- Fixed entities not being despawned when flagged, if they weren't scheduled for an update.
Levels
- Seed handling is now always consistent between
pocketmine.yml
andserver.properties
. - Fixed generation bugs in imported LevelDB worlds where the classpath was saved into level.dat.
- Generators for levels are no longer created on the main thread, reducing memory usage.
Plugins
- Plugin data is now stored under
<data dir>/plugin_data
by default on new installations, instead of in<plugins dir>
. This behaviour does not affect existing installations by default - if you want to enable it, setplugins.legacy-data-dir
tofalse
inpocketmine.yml
.
RCON
RCON has been almost completely rewritten in this release.
- Now event-driven (using Snooze) instead of poll-based, improving performance.
- Fixed segmentation fault when stopping the server with RCON enabled.
API
WARNING: Dependency library API changes are not listed here. See their individual release notes for changes (linked above in the Core section).
The way that the API versioning is done has changed. Now the API version is synonymous with the PocketMine-MP version. Currently there is no support for locking version by metadata, although this could be implemented if it is a wanted feature.
This release features major changes to how plugin task scheduling works.
API versioning changes for plugins
Plugin compatibility is determined by the following:
+
sign, for example 3.0.0+dev.1191
becomes 3.0.0
).
General
Server->getCodename()
and \pocketmine\CODENAME
have been removed.
Server->getTickSleeper()
, which returns a \pocketmine\snooze\SleeperHandler
instance.
Server->getIp()
now returns 0.0.0.0
if not set.
Block
Block->getXpDropForTool()
.
Entities
scheduleUpdate()
on an Entity
after it has been close()
d will now cause an exception to be thrown.
Entity->motionX
, Entity->motionY
Entity->motionZ
have been removed in favour of an Entity->motion
Vector3
field. This also applies for the lastMotion
fields.
Entity->isInsideOfWater()
has been renamed to isUnderwater()
.
Events
@softDepend
annotation on event handlers, which allows the event handler to not be registered if the dependency plugin is not loaded.
@notHandler
annotation for Listener
methods to indicate that such methods are not event handlers.
EntityEffectRemoveEvent
not being reflected on the client.
EntityDamageEvent
API has significant changes. The general purpose of this is to split up base damage from modifiers.
getBaseDamage()
, setBaseDamage()
, getOriginalBaseDamage()
, getModifiers()
, getOriginalModifiers()
setDamage()
renamed to setModifier()
, and type parameter is now mandatory
getDamage()
renamed to getModifier()
, and type parameter is now mandatory
getOriginalDamage()
renamed to getOriginalModifier()
, and type parameter is now mandatory
MODIFIER_BASE
constant
float baseDamage
, float[] modifiers
instead of just float[] modifiers
BlockBreakEvent->getXpDropAmount()
and BlockBreakEvent->setXpDropAmount()
.
Inventory
InventoryTransaction->getCreationTime()
has been removed.
EntityInventoryChangeEvent
and EntityArmorChangeEvent
are no longer fired during entity inventory intialization.
Item
isPickaxe()
, isAxe()
, isSword()
, isShovel()
, isHoe()
, isShears()
have been removed. These should be replaced with instanceof
checks for the relevant classes.
Item->useOn()
. This has been superseded by new methods used for handling durability changes.
Item->onDestroyBlock()
and Item->onAttackEntity()
. These are called when a player uses the item to destroy a block or attack an entity respectively. This is used in the core code for updating durability.
Item->pop()
now accepts an optional count parameter.
Enchantment
now has separated primary items (which can be enchanted directly) and secondary items (which can be enchanted on an anvil). The constructor of Enchantment
has been updated to reflect this.
Enchantment->getSlot()
and Enchantment->hasSlot()
.
Enchantment->getPrimaryItemFlags()
, Enchantment->hasPrimaryItemFlag()
, Enchantment->getSecondaryItemFlags()
and Enchantment->hasSecondaryItemFlag()
Level
Biome
classes have been moved to pocketmine\level\biome
namespace. This is in preparation for future work on Levels which requires biome information (such as weather conditions).
WeakPosition
has been removed.
Level->getBiome()
.
Level->getSafeSpawn()
now always returns a Position
instance.
Level->getBlockExtraData()
and Level->setBlockExtraData()
have been removed (as well as their associated Chunk
methods).
ChunkManager->isInWorld()
now accepts integers instead of floats.
SubChunkIteratorManager->invalidate()
.
Generator
BiomeSelector
has been refactored to make it simpler and more robust.
registerDefaultGenerators()
, addGenerator()
, getGeneratorList()
, getGenerator()
, and getGeneratorName()
have been moved from Generator
to a new GeneratorManager
class.
Generator
base class have been moved to Noise
instance methods.
Generator::convertSeed()
, which converts an int or string into a numeric seed for generation.
Network
SourceInterface->process()
no longer returns a value.
Plugin
PluginBase->getResources()
now returns an associative array where the index is the path to the resource relative to the plugin's resources
directory.
PluginLoader
s have been almost completely rewritten to make them simpler and more robust.
PluginManager->registerInterface()
does not return anything, and now accepts a PluginLoader
instance instead of a string
.
PluginLoader
:
getPluginFilters()
, enablePlugin()
and disablePlugin()
are removed.
loadPlugin()
responsibilities are now solely confined to doing whatever is necessary to make the plugin's classes visible by the server, and does not emit log messages or check for data directories.
getAccessProtocol()
which determines what prefix to apply to the plugin path to access the files inside it (for example phar://
).
PluginBase->init()
and PluginBase->isInitialized()
have been removed.
Plugin
interface now declares a signature for the constructor which implementations must comply with.
Plugin
interface now declares setEnabled()
.
Plugin
implementation without requiring a custom PluginLoader
.
Scheduler
Server->getScheduler()
. All plugins now have their own scheduler which is accessible using Plugin->getScheduler()
. Aside from being syntactically more concise and pleasant, this also allows much more effective management of tasks when plugins are disabled.
PluginTask
class, because it's now unnecessary. Previously it was required to allow the server to delete tasks associated with a plugin when the plugin was disabled. With plugin-owned schedulers, this is no longer a requirement. Plugins may now utilize the Task
class as a base if they like.
Server->getAsyncPool()
. Since the global scheduler does not exist any more, it does not manage the server's AsyncPool
any more. Additionally, ServerScheduler
was previously bloated by a lot of AsyncTask
related methods, which are now not necessary because direct access to AsyncPool
is granted instead.
ServerScheduler
:
ServerScheduler
has been renamed to TaskScheduler
since it is now a general-purpose task scheduler which is non-dependent on the user. This allows much greater flexibility and also makes it possible to unit-test.
AsyncTask
/AsyncPool
related methods have been removed - the task scheduler does not manage the async pool anymore.
Server->getScheduler()->scheduleAsyncTask()
should be replaced with Server->getAsyncPool()->submitTask()
.
Server->getScheduler()->scheduleAsyncTaskToWorker()
should be replaced with and Server->getAsyncPool()->submitTaskToWorker()
.
Tile
scheduleUpdate()
on a Tile
after it has been close()
d will now cause an exception to be thrown.
Tile->namedtag
has been removed.
Tile->saveNBT()
now returns a new CompoundTag
containing saved data.
Tile->readSaveData()
and Tile->writeSaveData()
. These should be overridden to add or read tile-specific data, instead of overriding saveNBT()
and __construct()
.
Utils
MainLogger->getFormat()
and MainLogger->setFormat()
to allow manipulating console output format.
Gameplay
General
- Fixed a range of block collision issues stemming from off-by-one errors when fetching areas.
Blocks
- Fixed a crash which occurred when leaving a bed which was broken and replaced during sleep.
- Fixed dark oak and acacia saplings growing into oak trees - now they will not grow at all (they need to be implemented).
- Saplings now take light level into account when trying to grow.
- Ores and other blocks now drop experience when broken with an appropriate tool.
Entities
- Fixed dropped items not being correctly destroyed by fire, cacti and other damage sources.
Generation
- Grass no longer generates as the top layer of ground cover in river biomes.
- Ocean biomes now use gravel instead of grass+dirt for ground cover.
- Reduced maximum elevation of plains biomes to make them less bumpy.
- Snow layers and other can-be-flowed-into blocks no longer generate underwater.
Items
- Buckets are no longer able to delete any block by replacing it with water.
- Dried Kelp, Bleach, Nautilus Shell and Heart of the Sea items are registered (although crafting recipes for these are not yet available).
- Implemented
Vanishing
enchantment. - Implemented Totems.
World
- Fixed explosions sometimes leaving behind air blocks with non-zero damage values.