152 private static int $worldIdCounter = 1;
154 public const Y_MAX = 320;
155 public const Y_MIN = -64;
157 public const TIME_DAY = 1000;
158 public const TIME_NOON = 6000;
159 public const TIME_SUNSET = 12000;
160 public const TIME_NIGHT = 13000;
161 public const TIME_MIDNIGHT = 18000;
162 public const TIME_SUNRISE = 23000;
164 public const TIME_FULL = 24000;
166 public const DIFFICULTY_PEACEFUL = 0;
167 public const DIFFICULTY_EASY = 1;
168 public const DIFFICULTY_NORMAL = 2;
169 public const DIFFICULTY_HARD = 3;
171 public const DEFAULT_TICKED_BLOCKS_PER_SUBCHUNK_PER_TICK = 3;
174 private const BLOCK_CACHE_SIZE_CAP = 2048;
180 private array $players = [];
186 private array $entities = [];
191 private array $entityLastKnownPositions = [];
197 private array $entitiesByChunk = [];
203 public array $updateEntities = [];
205 private bool $inDynamicStateRecalculation =
false;
210 private array $blockCache = [];
211 private int $blockCacheSize = 0;
216 private array $blockCollisionBoxCache = [];
218 private int $sendTimeTicker = 0;
220 private int $worldId;
222 private int $providerGarbageCollectionTicker = 0;
231 private array $registeredTickingChunks = [];
239 private array $validTickingChunks = [];
246 private array $recheckTickingChunks = [];
252 private array $chunkLoaders = [];
258 private array $chunkListeners = [];
263 private array $playerChunkListeners = [];
269 private array $packetBuffersByChunk = [];
275 private array $unloadQueue = [];
278 public bool $stopTime =
false;
280 private float $sunAnglePercentage = 0.0;
281 private int $skyLightReduction = 0;
283 private string $folderName;
284 private string $displayName;
290 private array $chunks = [];
296 private array $changedBlocks = [];
304 private array $scheduledBlockUpdateQueueIndex = [];
307 private \SplQueue $neighbourBlockUpdateQueue;
312 private array $neighbourBlockUpdateQueueIndex = [];
318 private array $activeChunkPopulationTasks = [];
323 private array $chunkLock = [];
324 private int $maxConcurrentChunkPopulationTasks = 2;
329 private array $chunkPopulationRequestMap = [];
334 private \SplQueue $chunkPopulationRequestQueue;
339 private array $chunkPopulationRequestQueueIndex = [];
343 private bool $autoSave =
true;
345 private int $sleepTicks = 0;
347 private int $chunkTickRadius;
348 private int $tickedBlocksPerSubchunkPerTick = self::DEFAULT_TICKED_BLOCKS_PER_SUBCHUNK_PER_TICK;
353 private array $randomTickBlocks = [];
357 public float $tickRateTime = 0;
359 private bool $doingTick =
false;
361 private bool $unloaded =
false;
366 private array $unloadCallbacks = [];
371 private \Logger $logger;
379 return morton2d_encode($x, $z);
382 private const MORTON3D_BIT_SIZE = 21;
383 private const BLOCKHASH_Y_BITS = 9;
384 private const BLOCKHASH_Y_PADDING = 64;
385 private const BLOCKHASH_Y_OFFSET = self::BLOCKHASH_Y_PADDING - self::Y_MIN;
386 private const BLOCKHASH_Y_MASK = (1 << self::BLOCKHASH_Y_BITS) - 1;
387 private const BLOCKHASH_XZ_MASK = (1 << self::MORTON3D_BIT_SIZE) - 1;
388 private const BLOCKHASH_XZ_EXTRA_BITS = (self::MORTON3D_BIT_SIZE - self::BLOCKHASH_Y_BITS) >> 1;
389 private const BLOCKHASH_XZ_EXTRA_MASK = (1 << self::BLOCKHASH_XZ_EXTRA_BITS) - 1;
390 private const BLOCKHASH_XZ_SIGN_SHIFT = 64 - self::MORTON3D_BIT_SIZE - self::BLOCKHASH_XZ_EXTRA_BITS;
391 private const BLOCKHASH_X_SHIFT = self::BLOCKHASH_Y_BITS;
392 private const BLOCKHASH_Z_SHIFT = self::BLOCKHASH_X_SHIFT + self::BLOCKHASH_XZ_EXTRA_BITS;
397 public static function blockHash(
int $x,
int $y,
int $z) : int{
398 $shiftedY = $y + self::BLOCKHASH_Y_OFFSET;
399 if(($shiftedY & (~0 << self::BLOCKHASH_Y_BITS)) !== 0){
400 throw new \InvalidArgumentException(
"Y coordinate $y is out of range!");
405 return morton3d_encode(
406 $x & self::BLOCKHASH_XZ_MASK,
408 ((($x >> self::MORTON3D_BIT_SIZE) & self::BLOCKHASH_XZ_EXTRA_MASK) << self::BLOCKHASH_X_SHIFT) |
409 ((($z >> self::MORTON3D_BIT_SIZE) & self::BLOCKHASH_XZ_EXTRA_MASK) << self::BLOCKHASH_Z_SHIFT),
410 $z & self::BLOCKHASH_XZ_MASK
418 return morton3d_encode($x, $y, $z);
427 public static function getBlockXYZ(
int $hash, ?
int &$x, ?
int &$y, ?
int &$z) : void{
428 [$baseX, $baseY, $baseZ] = morton3d_decode($hash);
430 $extraX = ((($baseY >> self::BLOCKHASH_X_SHIFT) & self::BLOCKHASH_XZ_EXTRA_MASK) << self::MORTON3D_BIT_SIZE);
431 $extraZ = ((($baseY >> self::BLOCKHASH_Z_SHIFT) & self::BLOCKHASH_XZ_EXTRA_MASK) << self::MORTON3D_BIT_SIZE);
433 $x = (($baseX & self::BLOCKHASH_XZ_MASK) | $extraX) << self::BLOCKHASH_XZ_SIGN_SHIFT >> self::BLOCKHASH_XZ_SIGN_SHIFT;
434 $y = ($baseY & self::BLOCKHASH_Y_MASK) - self::BLOCKHASH_Y_OFFSET;
435 $z = (($baseZ & self::BLOCKHASH_XZ_MASK) | $extraZ) << self::BLOCKHASH_XZ_SIGN_SHIFT >> self::BLOCKHASH_XZ_SIGN_SHIFT;
443 public static function getXZ(
int $hash, ?
int &$x, ?
int &$z) : void{
444 [$x, $z] = morton2d_decode($hash);
447 public static function getDifficultyFromString(
string $str) : int{
448 switch(strtolower(trim($str))){
452 return World::DIFFICULTY_PEACEFUL;
457 return World::DIFFICULTY_EASY;
462 return World::DIFFICULTY_NORMAL;
467 return World::DIFFICULTY_HARD;
482 $this->folderName = $name;
483 $this->worldId = self::$worldIdCounter++;
485 $this->displayName = $this->provider->getWorldData()->getName();
486 $this->logger = new \PrefixedLogger($server->getLogger(),
"World: $this->displayName");
488 $this->blockStateRegistry = RuntimeBlockStateRegistry::getInstance();
489 $this->minY = $this->provider->getWorldMinY();
490 $this->maxY = $this->provider->getWorldMaxY();
492 $this->
server->getLogger()->info($this->
server->getLanguage()->translate(KnownTranslationFactory::pocketmine_level_preparing($this->displayName)));
493 $generator = GeneratorManager::getInstance()->getGenerator($this->provider->getWorldData()->getGenerator()) ??
494 throw new AssumptionFailedError(
"WorldManager should already have checked that the generator exists");
495 $generator->validateGeneratorOptions($this->provider->getWorldData()->getGeneratorOptions());
498 worldMinY: $this->minY,
499 worldMaxY: $this->maxY,
500 generatorSeed: $this->getSeed(),
501 generatorClass: $generator->getGeneratorClass(),
502 generatorSettings: $this->provider->getWorldData()->getGeneratorOptions()
504 $this->generatorExecutor = $generator->isFast() ?
509 $executorSetupParameters,
513 $this->chunkPopulationRequestQueue = new \SplQueue();
514 $this->addOnUnloadCallback(
function() :
void{
515 $this->logger->debug(
"Cancelling unfulfilled generation requests");
517 foreach($this->chunkPopulationRequestMap as $chunkHash => $promise){
519 unset($this->chunkPopulationRequestMap[$chunkHash]);
521 if(count($this->chunkPopulationRequestMap) !== 0){
529 $this->scheduledBlockUpdateQueue->setExtractFlags(\SplPriorityQueue::EXTR_BOTH);
531 $this->neighbourBlockUpdateQueue = new \SplQueue();
533 $this->time = $this->provider->getWorldData()->getTime();
535 $cfg = $this->
server->getConfigGroup();
536 $this->chunkTickRadius = min($this->
server->getViewDistance(), max(0, $cfg->getPropertyInt(YmlServerProperties::CHUNK_TICKING_TICK_RADIUS, 4)));
537 if($cfg->getPropertyInt(
"chunk-ticking.per-tick", 40) <= 0){
539 $this->logger->warning(
"\"chunk-ticking.per-tick\" setting is deprecated, but you've used it to disable chunk ticking. Set \"chunk-ticking.tick-radius\" to 0 in \"pocketmine.yml\" instead.");
540 $this->chunkTickRadius = 0;
542 $this->tickedBlocksPerSubchunkPerTick = $cfg->getPropertyInt(YmlServerProperties::CHUNK_TICKING_BLOCKS_PER_SUBCHUNK_PER_TICK, self::DEFAULT_TICKED_BLOCKS_PER_SUBCHUNK_PER_TICK);
543 $this->maxConcurrentChunkPopulationTasks = $cfg->getPropertyInt(YmlServerProperties::CHUNK_GENERATION_POPULATION_QUEUE_SIZE, 2);
545 $this->initRandomTickBlocksFromConfig($cfg);
551 $dontTickBlocks = [];
552 $parser = StringToItemParser::getInstance();
553 foreach($cfg->getProperty(YmlServerProperties::CHUNK_TICKING_DISABLE_BLOCK_TICKING, []) as $name){
554 $name = (string) $name;
555 $item = $parser->parse($name);
557 $block = $item->getBlock();
558 }elseif(preg_match(
"/^-?\d+$/", $name) === 1){
561 $blockStateData = GlobalBlockStateHandlers::getUpgrader()->upgradeIntIdMeta((
int) $name, 0);
562 }
catch(BlockStateDeserializeException){
565 $block = $this->blockStateRegistry->fromStateId(GlobalBlockStateHandlers::getDeserializer()->deserialize($blockStateData));
571 if($block->getTypeId() !== BlockTypeIds::AIR){
572 $dontTickBlocks[$block->getTypeId()] = $name;
576 foreach($this->blockStateRegistry->getAllKnownStates() as $state){
577 $dontTickName = $dontTickBlocks[$state->getTypeId()] ??
null;
578 if($dontTickName ===
null && $state->ticksRandomly()){
579 $this->randomTickBlocks[$state->getStateId()] =
true;
584 public function getTickRateTime() : float{
585 return $this->tickRateTime;
588 public function getServer() : Server{
592 public function getLogger() : \
Logger{
593 return $this->logger;
596 final public function getProvider() : WritableWorldProvider{
597 return $this->provider;
603 final public function getId() : int{
604 return $this->worldId;
607 public function isLoaded() : bool{
608 return !$this->unloaded;
614 public function onUnload() : void{
616 throw new \LogicException(
"Tried to close a world which is already closed");
619 foreach($this->unloadCallbacks as $callback){
622 $this->unloadCallbacks = [];
624 foreach($this->chunks as $chunkHash => $chunk){
625 self::getXZ($chunkHash, $chunkX, $chunkZ);
626 $this->unloadChunk($chunkX, $chunkZ,
false);
628 foreach($this->entitiesByChunk as $chunkHash => $entities){
629 self::getXZ($chunkHash, $chunkX, $chunkZ);
632 foreach($entities as $entity){
633 if(!$entity->isFlaggedForDespawn()){
638 if($leakedEntities !== 0){
639 $this->logger->warning(
"$leakedEntities leaked entities found in ungenerated chunk $chunkX $chunkZ during unload, they won't be saved!");
645 $this->generatorExecutor->shutdown();
647 $this->provider->close();
648 $this->blockCache = [];
649 $this->blockCacheSize = 0;
650 $this->blockCollisionBoxCache = [];
652 $this->unloaded =
true;
657 $this->unloadCallbacks[spl_object_id($callback)] = $callback;
662 unset($this->unloadCallbacks[spl_object_id($callback)]);
673 private function filterViewersForPosition(
Vector3 $pos, array $allowed) : array{
674 $candidates = $this->getViewersForPosition($pos);
676 foreach($allowed as $player){
677 $k = spl_object_id($player);
678 if(isset($candidates[$k])){
679 $filtered[$k] = $candidates[$k];
690 $players ??= $this->getViewersForPosition($pos);
692 if(WorldSoundEvent::hasHandlers()){
695 if($ev->isCancelled()){
699 $sound = $ev->getSound();
700 $players = $ev->getRecipients();
703 $pk = $sound->
encode($pos);
705 if($players === $this->getViewersForPosition($pos)){
707 $this->broadcastPacketToViewers($pos, $e);
710 NetworkBroadcastUtils::broadcastPackets($this->filterViewersForPosition($pos, $players), $pk);
719 $players ??= $this->getViewersForPosition($pos);
721 if(WorldParticleEvent::hasHandlers()){
724 if($ev->isCancelled()){
728 $particle = $ev->getParticle();
729 $players = $ev->getRecipients();
732 $pk = $particle->
encode($pos);
734 if($players === $this->getViewersForPosition($pos)){
736 $this->broadcastPacketToViewers($pos, $e);
739 NetworkBroadcastUtils::broadcastPackets($this->filterViewersForPosition($pos, $players), $pk);
744 public function getAutoSave() : bool{
745 return $this->autoSave;
748 public function setAutoSave(
bool $value) : void{
749 $this->autoSave = $value;
762 return $this->playerChunkListeners[
World::chunkHash($chunkX, $chunkZ)] ?? [];
772 return $this->chunkLoaders[
World::chunkHash($chunkX, $chunkZ)] ?? [];
782 return $this->getChunkPlayers($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE);
789 $this->broadcastPacketToPlayersUsingChunk($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE, $packet);
792 private function broadcastPacketToPlayersUsingChunk(
int $chunkX,
int $chunkZ,
ClientboundPacket $packet) : void{
793 if(!isset($this->packetBuffersByChunk[$index =
World::chunkHash($chunkX, $chunkZ)])){
794 $this->packetBuffersByChunk[$index] = [$packet];
796 $this->packetBuffersByChunk[$index][] = $packet;
800 public function registerChunkLoader(ChunkLoader $loader,
int $chunkX,
int $chunkZ,
bool $autoLoad =
true) : void{
801 $loaderId = spl_object_id($loader);
803 if(!isset($this->chunkLoaders[$chunkHash = World::chunkHash($chunkX, $chunkZ)])){
804 $this->chunkLoaders[$chunkHash] = [];
805 }elseif(isset($this->chunkLoaders[$chunkHash][$loaderId])){
809 $this->chunkLoaders[$chunkHash][$loaderId] = $loader;
811 $this->cancelUnloadChunkRequest($chunkX, $chunkZ);
814 $this->loadChunk($chunkX, $chunkZ);
818 public function unregisterChunkLoader(ChunkLoader $loader,
int $chunkX,
int $chunkZ) : void{
819 $chunkHash = World::chunkHash($chunkX, $chunkZ);
820 $loaderId = spl_object_id($loader);
821 if(isset($this->chunkLoaders[$chunkHash][$loaderId])){
822 if(count($this->chunkLoaders[$chunkHash]) === 1){
823 unset($this->chunkLoaders[$chunkHash]);
824 $this->unloadChunkRequest($chunkX, $chunkZ,
true);
825 if(isset($this->chunkPopulationRequestMap[$chunkHash]) && !isset($this->activeChunkPopulationTasks[$chunkHash])){
826 $this->chunkPopulationRequestMap[$chunkHash]->reject();
827 unset($this->chunkPopulationRequestMap[$chunkHash]);
830 unset($this->chunkLoaders[$chunkHash][$loaderId]);
839 $hash =
World::chunkHash($chunkX, $chunkZ);
840 if(isset($this->chunkListeners[$hash])){
841 $this->chunkListeners[$hash][spl_object_id($listener)] = $listener;
843 $this->chunkListeners[$hash] = [spl_object_id($listener) => $listener];
845 if($listener instanceof
Player){
846 $this->playerChunkListeners[$hash][spl_object_id($listener)] = $listener;
856 $hash =
World::chunkHash($chunkX, $chunkZ);
857 if(isset($this->chunkListeners[$hash])){
858 if(count($this->chunkListeners[$hash]) === 1){
859 unset($this->chunkListeners[$hash]);
860 unset($this->playerChunkListeners[$hash]);
862 unset($this->chunkListeners[$hash][spl_object_id($listener)]);
863 unset($this->playerChunkListeners[$hash][spl_object_id($listener)]);
872 foreach($this->chunkListeners as $hash => $listeners){
873 World::getXZ($hash, $chunkX, $chunkZ);
874 $this->unregisterChunkListener($listener, $chunkX, $chunkZ);
885 return $this->chunkListeners[
World::chunkHash($chunkX, $chunkZ)] ?? [];
891 public function sendTime(
Player ...$targets) : void{
892 if(count($targets) === 0){
893 $targets = $this->players;
895 foreach($targets as $player){
896 $player->getNetworkSession()->syncWorldTime($this->time);
900 public function isDoingTick() : bool{
901 return $this->doingTick;
907 public function doTick(
int $currentTick) : void{
909 throw new \LogicException(
"Attempted to tick a world which has been closed");
912 $this->timings->doTick->startTiming();
913 $this->doingTick =
true;
915 $this->actuallyDoTick($currentTick);
917 $this->doingTick =
false;
918 $this->timings->doTick->stopTiming();
922 protected function actuallyDoTick(
int $currentTick) : void{
923 if(!$this->stopTime){
925 if($this->time === PHP_INT_MAX){
926 $this->time = PHP_INT_MIN;
932 $this->sunAnglePercentage = $this->computeSunAnglePercentage();
933 $this->skyLightReduction = $this->computeSkyLightReduction();
935 if(++$this->sendTimeTicker === 200){
937 $this->sendTimeTicker = 0;
940 $this->unloadChunks();
941 if(++$this->providerGarbageCollectionTicker >= 6000){
942 $this->provider->doGarbageCollection();
943 $this->providerGarbageCollectionTicker = 0;
946 $this->timings->scheduledBlockUpdates->startTiming();
948 while($this->scheduledBlockUpdateQueue->count() > 0 && $this->scheduledBlockUpdateQueue->current()[
"priority"] <= $currentTick){
950 $vec = $this->scheduledBlockUpdateQueue->extract()[
"data"];
951 unset($this->scheduledBlockUpdateQueueIndex[World::blockHash($vec->x, $vec->y, $vec->z)]);
952 if(!$this->isInLoadedTerrain($vec)){
955 $block = $this->getBlock($vec);
956 $block->onScheduledUpdate();
958 $this->timings->scheduledBlockUpdates->stopTiming();
960 $this->timings->neighbourBlockUpdates->startTiming();
962 while($this->neighbourBlockUpdateQueue->count() > 0){
963 $index = $this->neighbourBlockUpdateQueue->dequeue();
964 unset($this->neighbourBlockUpdateQueueIndex[$index]);
965 World::getBlockXYZ($index, $x, $y, $z);
966 if(!$this->isChunkLoaded($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)){
970 $block = $this->getBlockAt($x, $y, $z);
972 if(BlockUpdateEvent::hasHandlers()){
973 $ev =
new BlockUpdateEvent($block);
975 if($ev->isCancelled()){
979 foreach($this->getNearbyEntities(AxisAlignedBB::one()->offset($x, $y, $z)) as $entity){
980 $entity->onNearbyBlockChange();
982 $block->onNearbyBlockChange();
985 $this->timings->neighbourBlockUpdates->stopTiming();
987 $this->timings->entityTick->startTiming();
989 foreach($this->updateEntities as $id => $entity){
990 if($entity->isClosed() || $entity->isFlaggedForDespawn() || !$entity->onUpdate($currentTick)){
991 unset($this->updateEntities[$id]);
993 if($entity->isFlaggedForDespawn()){
997 $this->timings->entityTick->stopTiming();
999 $this->timings->randomChunkUpdates->startTiming();
1000 $this->tickChunks();
1001 $this->timings->randomChunkUpdates->stopTiming();
1003 $this->executeQueuedLightUpdates();
1005 if(count($this->changedBlocks) > 0){
1006 if(count($this->players) > 0){
1007 foreach($this->changedBlocks as $index => $blocks){
1008 if(count($blocks) === 0){
1011 World::getXZ($index, $chunkX, $chunkZ);
1012 if(!$this->isChunkLoaded($chunkX, $chunkZ)){
1016 if(count($blocks) > 512){
1017 $chunk = $this->getChunk($chunkX, $chunkZ) ??
throw new AssumptionFailedError(
"We already checked that the chunk is loaded");
1018 foreach($this->getChunkPlayers($chunkX, $chunkZ) as $p){
1019 $p->onChunkChanged($chunkX, $chunkZ, $chunk);
1022 foreach($this->createBlockUpdatePackets($blocks) as $packet){
1023 $this->broadcastPacketToPlayersUsingChunk($chunkX, $chunkZ, $packet);
1029 $this->changedBlocks = [];
1033 if($this->sleepTicks > 0 && --$this->sleepTicks <= 0){
1034 $this->checkSleep();
1037 foreach($this->packetBuffersByChunk as $index => $entries){
1038 World::getXZ($index, $chunkX, $chunkZ);
1039 $chunkPlayers = $this->getChunkPlayers($chunkX, $chunkZ);
1040 if(count($chunkPlayers) > 0){
1041 NetworkBroadcastUtils::broadcastPackets($chunkPlayers, $entries);
1045 $this->packetBuffersByChunk = [];
1048 public function checkSleep() : void{
1049 if(count($this->players) === 0){
1054 foreach($this->getPlayers() as $p){
1055 if(!$p->isSleeping()){
1062 $time = $this->getTimeOfDay();
1064 if($time >= World::TIME_NIGHT && $time < World::TIME_SUNRISE){
1065 $this->setTime($this->getTime() + World::TIME_FULL - $time);
1067 foreach($this->getPlayers() as $p){
1074 public function setSleepTicks(
int $ticks) : void{
1075 $this->sleepTicks = $ticks;
1087 $blockTranslator = TypeConverter::getInstance()->getBlockTranslator();
1089 foreach($blocks as $b){
1091 throw new \TypeError(
"Expected Vector3 in blocks array, got " . (is_object($b) ? get_class($b) : gettype($b)));
1094 $fullBlock = $this->getBlockAt($b->x, $b->y, $b->z);
1095 $blockPosition = BlockPosition::fromVector3($b);
1097 $tile = $this->getTileAt($b->x, $b->y, $b->z);
1099 $expectedClass = $fullBlock->getIdInfo()->getTileClass();
1100 if($expectedClass !==
null && $tile instanceof $expectedClass && count($fakeStateProperties = $tile->getRenderUpdateBugWorkaroundStateProperties($fullBlock)) > 0){
1101 $originalStateData = $blockTranslator->internalIdToNetworkStateData($fullBlock->getStateId());
1103 $originalStateData->getName(),
1104 array_merge($originalStateData->getStates(), $fakeStateProperties),
1105 $originalStateData->getVersion()
1107 $packets[] = UpdateBlockPacket::create(
1109 $blockTranslator->getBlockStateDictionary()->lookupStateIdFromData($fakeStateData) ??
throw new AssumptionFailedError(
"Unmapped fake blockstate data: " . $fakeStateData->toNbt()),
1110 UpdateBlockPacket::FLAG_NETWORK,
1111 UpdateBlockPacket::DATA_LAYER_NORMAL
1115 $packets[] = UpdateBlockPacket::create(
1117 $blockTranslator->internalIdToNetworkId($fullBlock->getStateId()),
1118 UpdateBlockPacket::FLAG_NETWORK,
1119 UpdateBlockPacket::DATA_LAYER_NORMAL
1123 $packets[] = BlockActorDataPacket::create($blockPosition, $tile->getSerializedSpawnCompound());
1130 public function clearCache(
bool $force =
false) : void{
1132 $this->blockCache = [];
1133 $this->blockCacheSize = 0;
1134 $this->blockCollisionBoxCache = [];
1137 $this->blockCacheSize = 0;
1138 foreach($this->blockCache as $list){
1139 $this->blockCacheSize += count($list);
1140 if($this->blockCacheSize > self::BLOCK_CACHE_SIZE_CAP){
1141 $this->blockCache = [];
1142 $this->blockCacheSize = 0;
1148 foreach($this->blockCollisionBoxCache as $list){
1149 $count += count($list);
1150 if($count > self::BLOCK_CACHE_SIZE_CAP){
1152 $this->blockCollisionBoxCache = [];
1159 private function trimBlockCache() : void{
1160 $before = $this->blockCacheSize;
1163 foreach($this->blockCache as $chunkHash => $blocks){
1164 unset($this->blockCache[$chunkHash]);
1165 $this->blockCacheSize -= count($blocks);
1166 if($this->blockCacheSize < self::BLOCK_CACHE_SIZE_CAP){
1177 return $this->randomTickBlocks;
1180 public function addRandomTickedBlock(
Block $block) : void{
1182 throw new \InvalidArgumentException(
"Cannot do random-tick on unknown block");
1184 $this->randomTickBlocks[$block->getStateId()] =
true;
1187 public function removeRandomTickedBlock(Block $block) : void{
1188 unset($this->randomTickBlocks[$block->getStateId()]);
1196 return $this->chunkTickRadius;
1204 $this->chunkTickRadius = $radius;
1215 return array_keys($this->validTickingChunks);
1223 $chunkPosHash =
World::chunkHash($chunkX, $chunkZ);
1224 $this->registeredTickingChunks[$chunkPosHash][spl_object_id($ticker)] = $ticker;
1225 $this->recheckTickingChunks[$chunkPosHash] = $chunkPosHash;
1233 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
1234 $tickerId = spl_object_id($ticker);
1235 if(isset($this->registeredTickingChunks[$chunkHash][$tickerId])){
1236 if(count($this->registeredTickingChunks[$chunkHash]) === 1){
1238 $this->registeredTickingChunks[$chunkHash],
1239 $this->recheckTickingChunks[$chunkHash],
1240 $this->validTickingChunks[$chunkHash]
1243 unset($this->registeredTickingChunks[$chunkHash][$tickerId]);
1248 private function tickChunks() : void{
1249 if($this->chunkTickRadius <= 0 || count($this->registeredTickingChunks) === 0){
1253 if(count($this->recheckTickingChunks) > 0){
1254 $this->timings->randomChunkUpdatesChunkSelection->startTiming();
1256 $chunkTickableCache = [];
1258 foreach($this->recheckTickingChunks as $hash => $_){
1259 World::getXZ($hash, $chunkX, $chunkZ);
1260 if($this->isChunkTickable($chunkX, $chunkZ, $chunkTickableCache)){
1261 $this->validTickingChunks[$hash] = $hash;
1264 $this->recheckTickingChunks = [];
1266 $this->timings->randomChunkUpdatesChunkSelection->stopTiming();
1269 foreach($this->validTickingChunks as $index => $_){
1270 World::getXZ($index, $chunkX, $chunkZ);
1272 $this->tickChunk($chunkX, $chunkZ);
1282 private function isChunkTickable(
int $chunkX,
int $chunkZ, array &$cache) : bool{
1283 for($cx = -1; $cx <= 1; ++$cx){
1284 for($cz = -1; $cz <= 1; ++$cz){
1285 $chunkHash = World::chunkHash($chunkX + $cx, $chunkZ + $cz);
1286 if(isset($cache[$chunkHash])){
1287 if(!$cache[$chunkHash]){
1292 if($this->isChunkLocked($chunkX + $cx, $chunkZ + $cz)){
1293 $cache[$chunkHash] =
false;
1296 $adjacentChunk = $this->getChunk($chunkX + $cx, $chunkZ + $cz);
1297 if($adjacentChunk ===
null || !$adjacentChunk->isPopulated()){
1298 $cache[$chunkHash] =
false;
1301 $lightPopulatedState = $adjacentChunk->isLightPopulated();
1302 if($lightPopulatedState !==
true){
1303 if($lightPopulatedState ===
false){
1304 $this->orderLightPopulation($chunkX + $cx, $chunkZ + $cz);
1306 $cache[$chunkHash] =
false;
1310 $cache[$chunkHash] =
true;
1326 private function markTickingChunkForRecheck(
int $chunkX,
int $chunkZ) : void{
1327 for($cx = -1; $cx <= 1; ++$cx){
1328 for($cz = -1; $cz <= 1; ++$cz){
1329 $chunkHash = World::chunkHash($chunkX + $cx, $chunkZ + $cz);
1330 unset($this->validTickingChunks[$chunkHash]);
1331 if(isset($this->registeredTickingChunks[$chunkHash])){
1332 $this->recheckTickingChunks[$chunkHash] = $chunkHash;
1334 unset($this->recheckTickingChunks[$chunkHash]);
1340 private function orderLightPopulation(
int $chunkX,
int $chunkZ) : void{
1341 $chunkHash = World::chunkHash($chunkX, $chunkZ);
1342 $lightPopulatedState = $this->chunks[$chunkHash]->isLightPopulated();
1343 if($lightPopulatedState ===
false){
1344 $this->chunks[$chunkHash]->setLightPopulated(
null);
1345 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
1347 $this->workerPool->submitTask(
new LightPopulationTask(
1348 $this->chunks[$chunkHash],
1349 function(array $blockLight, array $skyLight, array $heightMap) use ($chunkX, $chunkZ) :
void{
1356 if($this->unloaded || ($chunk = $this->getChunk($chunkX, $chunkZ)) ===
null || $chunk->isLightPopulated() ===
true){
1361 $chunk->setHeightMapArray($heightMap);
1362 foreach($blockLight as $y => $lightArray){
1363 $chunk->getSubChunk($y)->setBlockLightArray($lightArray);
1365 foreach($skyLight as $y => $lightArray){
1366 $chunk->getSubChunk($y)->setBlockSkyLightArray($lightArray);
1368 $chunk->setLightPopulated(
true);
1369 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
1375 private function tickChunk(
int $chunkX,
int $chunkZ) : void{
1376 $chunk = $this->getChunk($chunkX, $chunkZ);
1377 if($chunk ===
null){
1381 foreach($this->getChunkEntities($chunkX, $chunkZ) as $entity){
1382 $entity->onRandomUpdate();
1385 $blockFactory = $this->blockStateRegistry;
1386 foreach($chunk->getSubChunks() as $Y => $subChunk){
1387 if(!$subChunk->isEmptyFast()){
1389 for($i = 0; $i < $this->tickedBlocksPerSubchunkPerTick; ++$i){
1392 $k = mt_rand(0, (1 << 60) - 1);
1394 $x = $k & SubChunk::COORD_MASK;
1395 $y = ($k >> SubChunk::COORD_BIT_SIZE) & SubChunk::COORD_MASK;
1396 $z = ($k >> (SubChunk::COORD_BIT_SIZE * 2)) & SubChunk::COORD_MASK;
1397 $k >>= (SubChunk::COORD_BIT_SIZE * 3);
1399 $state = $subChunk->getBlockStateId($x, $y, $z);
1401 if(isset($this->randomTickBlocks[$state])){
1402 $block = $blockFactory->fromStateId($state);
1403 $block->position($this, $chunkX * Chunk::EDGE_LENGTH + $x, ($Y << SubChunk::COORD_BIT_SIZE) + $y, $chunkZ * Chunk::EDGE_LENGTH + $z);
1404 $block->onRandomTick();
1418 public function save(
bool $force =
false) : bool{
1420 if(!$this->getAutoSave() && !$force){
1424 (
new WorldSaveEvent($this))->call();
1426 $timings = $this->timings->syncDataSave;
1427 $timings->startTiming();
1429 $this->provider->getWorldData()->setTime($this->time);
1430 $this->saveChunks();
1431 $this->provider->getWorldData()->save();
1433 $timings->stopTiming();
1438 public function saveChunks() : void{
1439 $this->timings->syncChunkSave->startTiming();
1441 foreach($this->chunks as $chunkHash => $chunk){
1442 self::getXZ($chunkHash, $chunkX, $chunkZ);
1443 $this->provider->saveChunk($chunkX, $chunkZ,
new ChunkData(
1444 $chunk->getSubChunks(),
1445 $chunk->isPopulated(),
1446 array_map(fn(Entity $e) => $e->saveNBT(), array_values(array_filter($this->getChunkEntities($chunkX, $chunkZ), fn(Entity $e) => $e->canSaveWithChunk()))),
1447 array_map(fn(Tile $t) => $t->saveNBT(), array_values($chunk->getTiles())),
1448 ), $chunk->getTerrainDirtyFlags());
1449 $chunk->clearTerrainDirtyFlags();
1452 $this->timings->syncChunkSave->stopTiming();
1462 !$this->isInWorld($pos->x, $pos->y, $pos->z) ||
1463 (isset($this->scheduledBlockUpdateQueueIndex[$index =
World::blockHash($pos->x, $pos->y, $pos->z)]) && $this->scheduledBlockUpdateQueueIndex[$index] <= $delay)
1467 $this->scheduledBlockUpdateQueueIndex[$index] = $delay;
1468 $this->scheduledBlockUpdateQueue->insert(
new Vector3((
int) $pos->x, (
int) $pos->y, (
int) $pos->z), $delay + $this->server->getTick());
1471 private function tryAddToNeighbourUpdateQueue(
int $x,
int $y,
int $z) : void{
1472 if($this->isInWorld($x, $y, $z)){
1473 $hash = World::blockHash($x, $y, $z);
1474 if(!isset($this->neighbourBlockUpdateQueueIndex[$hash])){
1475 $this->neighbourBlockUpdateQueue->enqueue($hash);
1476 $this->neighbourBlockUpdateQueueIndex[$hash] =
true;
1487 private function internalNotifyNeighbourBlockUpdate(
int $x,
int $y,
int $z) : void{
1488 $this->tryAddToNeighbourUpdateQueue($x, $y, $z);
1489 foreach(Facing::OFFSET as [$dx, $dy, $dz]){
1490 $this->tryAddToNeighbourUpdateQueue($x + $dx, $y + $dy, $z + $dz);
1502 $this->internalNotifyNeighbourBlockUpdate($pos->getFloorX(), $pos->getFloorY(), $pos->getFloorZ());
1510 $minX = (int) floor($bb->minX - 1);
1511 $minY = (int) floor($bb->minY - 1);
1512 $minZ = (int) floor($bb->minZ - 1);
1513 $maxX = (int) floor($bb->maxX + 1);
1514 $maxY = (int) floor($bb->maxY + 1);
1515 $maxZ = (int) floor($bb->maxZ + 1);
1519 $collisionInfo = $this->blockStateRegistry->collisionInfo;
1521 for($z = $minZ; $z <= $maxZ; ++$z){
1522 $zOverflow = $z === $minZ || $z === $maxZ;
1523 for($x = $minX; $x <= $maxX; ++$x){
1524 $zxOverflow = $zOverflow || $x === $minX || $x === $maxX;
1525 for($y = $minY; $y <= $maxY; ++$y){
1526 $overflow = $zxOverflow || $y === $minY || $y === $maxY;
1528 $stateCollisionInfo = $this->getBlockCollisionInfo($x, $y, $z, $collisionInfo);
1530 $stateCollisionInfo === RuntimeBlockStateRegistry::COLLISION_MAY_OVERFLOW && $this->getBlockAt($x, $y, $z)->collidesWithBB($bb) :
1531 match ($stateCollisionInfo) {
1532 RuntimeBlockStateRegistry::COLLISION_CUBE =>
true,
1533 RuntimeBlockStateRegistry::COLLISION_NONE =>
false,
1534 default => $this->getBlockAt($x, $y, $z)->collidesWithBB($bb)
1537 return [$this->getBlockAt($x, $y, $z)];
1544 for($z = $minZ; $z <= $maxZ; ++$z){
1545 $zOverflow = $z === $minZ || $z === $maxZ;
1546 for($x = $minX; $x <= $maxX; ++$x){
1547 $zxOverflow = $zOverflow || $x === $minX || $x === $maxX;
1548 for($y = $minY; $y <= $maxY; ++$y){
1549 $overflow = $zxOverflow || $y === $minY || $y === $maxY;
1551 $stateCollisionInfo = $this->getBlockCollisionInfo($x, $y, $z, $collisionInfo);
1553 $stateCollisionInfo === RuntimeBlockStateRegistry::COLLISION_MAY_OVERFLOW && $this->getBlockAt($x, $y, $z)->collidesWithBB($bb) :
1554 match ($stateCollisionInfo) {
1555 RuntimeBlockStateRegistry::COLLISION_CUBE =>
true,
1556 RuntimeBlockStateRegistry::COLLISION_NONE =>
false,
1557 default => $this->getBlockAt($x, $y, $z)->collidesWithBB($bb)
1560 $collides[] = $this->getBlockAt($x, $y, $z);
1574 private function getBlockCollisionInfo(
int $x,
int $y,
int $z, array $collisionInfo) : int{
1575 if(!$this->isInWorld($x, $y, $z)){
1576 return RuntimeBlockStateRegistry::COLLISION_NONE;
1578 $chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE);
1579 if($chunk ===
null){
1580 return RuntimeBlockStateRegistry::COLLISION_NONE;
1583 ->getSubChunk($y >> SubChunk::COORD_BIT_SIZE)
1585 $x & SubChunk::COORD_MASK,
1586 $y & SubChunk::COORD_MASK,
1587 $z & SubChunk::COORD_MASK
1589 return $collisionInfo[$stateId];
1603 private function getBlockCollisionBoxesForCell(
int $x,
int $y,
int $z, array $collisionInfo) : array{
1604 $stateCollisionInfo = $this->getBlockCollisionInfo($x, $y, $z, $collisionInfo);
1605 $boxes = match($stateCollisionInfo){
1606 RuntimeBlockStateRegistry::COLLISION_NONE => [],
1607 RuntimeBlockStateRegistry::COLLISION_CUBE => [AxisAlignedBB::one()->offset($x, $y, $z)],
1608 default => $this->getBlockAt($x, $y, $z)->getCollisionBoxes()
1612 if($stateCollisionInfo !== RuntimeBlockStateRegistry::COLLISION_CUBE){
1614 foreach(Facing::OFFSET as [$dx, $dy, $dz]){
1615 $offsetX = $x + $dx;
1616 $offsetY = $y + $dy;
1617 $offsetZ = $z + $dz;
1618 $stateCollisionInfo = $this->getBlockCollisionInfo($offsetX, $offsetY, $offsetZ, $collisionInfo);
1619 if($stateCollisionInfo === RuntimeBlockStateRegistry::COLLISION_MAY_OVERFLOW){
1621 $cellBB ??= AxisAlignedBB::one()->offset($x, $y, $z);
1622 $extraBoxes = $this->getBlockAt($offsetX, $offsetY, $offsetZ)->getCollisionBoxes();
1623 foreach($extraBoxes as $extraBox){
1624 if($extraBox->intersectsWith($cellBB)){
1625 $boxes[] = $extraBox;
1640 $minX = (int) floor($bb->minX);
1641 $minY = (int) floor($bb->minY);
1642 $minZ = (int) floor($bb->minZ);
1643 $maxX = (int) floor($bb->maxX);
1644 $maxY = (int) floor($bb->maxY);
1645 $maxZ = (int) floor($bb->maxZ);
1649 $collisionInfo = $this->blockStateRegistry->collisionInfo;
1651 for($z = $minZ; $z <= $maxZ; ++$z){
1652 for($x = $minX; $x <= $maxX; ++$x){
1653 $chunkPosHash = World::chunkHash($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE);
1654 for($y = $minY; $y <= $maxY; ++$y){
1655 $relativeBlockHash = World::chunkBlockHash($x, $y, $z);
1657 $boxes = $this->blockCollisionBoxCache[$chunkPosHash][$relativeBlockHash] ??= $this->getBlockCollisionBoxesForCell($x, $y, $z, $collisionInfo);
1659 foreach($boxes as $blockBB){
1660 if($blockBB->intersectsWith($bb)){
1661 $collides[] = $blockBB;
1676 $timeProgress = ($this->time % self::TIME_FULL) / self::TIME_FULL;
1679 $sunProgress = $timeProgress + ($timeProgress < 0.25 ? 0.75 : -0.25);
1683 $diff = (((1 - ((cos($sunProgress * M_PI) + 1) / 2)) - $sunProgress) / 3);
1685 return $sunProgress + $diff;
1692 return $this->sunAnglePercentage;
1699 return $this->sunAnglePercentage * 2 * M_PI;
1706 return $this->sunAnglePercentage * 360.0;
1714 $percentage = max(0, min(1, -(cos($this->getSunAngleRadians()) * 2 - 0.5)));
1718 return (
int) ($percentage * 11);
1725 return $this->skyLightReduction;
1733 $floorX = $pos->getFloorX();
1734 $floorY = $pos->getFloorY();
1735 $floorZ = $pos->getFloorZ();
1736 return $this->getFullLightAt($floorX, $floorY, $floorZ);
1744 $skyLight = $this->getRealBlockSkyLightAt($x, $y, $z);
1746 return max($skyLight, $this->getBlockLightAt($x, $y, $z));
1757 return $this->getHighestAdjacentLight($x, $y, $z, $this->getFullLightAt(...));
1765 $floorX = $pos->getFloorX();
1766 $floorY = $pos->getFloorY();
1767 $floorZ = $pos->getFloorZ();
1768 return $this->getPotentialLightAt($floorX, $floorY, $floorZ);
1776 return max($this->getPotentialBlockSkyLightAt($x, $y, $z), $this->getBlockLightAt($x, $y, $z));
1784 return $this->getHighestAdjacentLight($x, $y, $z, $this->getPotentialLightAt(...));
1794 if(!$this->isInWorld($x, $y, $z)){
1795 return $y >= self::Y_MAX ? 15 : 0;
1797 if(($chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)) !==
null && $chunk->isLightPopulated() ===
true){
1798 return $chunk->getSubChunk($y >> Chunk::COORD_BIT_SIZE)->getBlockSkyLightArray()->get($x & SubChunk::COORD_MASK, $y & SubChunk::COORD_MASK, $z & SubChunk::COORD_MASK);
1809 $light = $this->getPotentialBlockSkyLightAt($x, $y, $z) - $this->skyLightReduction;
1810 return $light < 0 ? 0 : $light;
1819 if(!$this->isInWorld($x, $y, $z)){
1822 if(($chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)) !==
null && $chunk->isLightPopulated() ===
true){
1823 return $chunk->getSubChunk($y >> Chunk::COORD_BIT_SIZE)->getBlockLightArray()->get($x & SubChunk::COORD_MASK, $y & SubChunk::COORD_MASK, $z & SubChunk::COORD_MASK);
1828 public function updateAllLight(
int $x,
int $y,
int $z) : void{
1829 if(($chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)) === null || $chunk->isLightPopulated() !== true){
1833 $blockFactory = $this->blockStateRegistry;
1834 $this->timings->doBlockSkyLightUpdates->startTiming();
1835 if($this->skyLightUpdate ===
null){
1836 $this->skyLightUpdate =
new SkyLightUpdate(
new SubChunkExplorer($this), $blockFactory->lightFilter, $blockFactory->blocksDirectSkyLight);
1838 $this->skyLightUpdate->recalculateNode($x, $y, $z);
1839 $this->timings->doBlockSkyLightUpdates->stopTiming();
1841 $this->timings->doBlockLightUpdates->startTiming();
1842 if($this->blockLightUpdate ===
null){
1843 $this->blockLightUpdate =
new BlockLightUpdate(
new SubChunkExplorer($this), $blockFactory->lightFilter, $blockFactory->light);
1845 $this->blockLightUpdate->recalculateNode($x, $y, $z);
1846 $this->timings->doBlockLightUpdates->stopTiming();
1852 private function getHighestAdjacentLight(
int $x,
int $y,
int $z, \Closure $lightGetter) : int{
1854 foreach(Facing::OFFSET as [$offsetX, $offsetY, $offsetZ]){
1855 $x1 = $x + $offsetX;
1856 $y1 = $y + $offsetY;
1857 $z1 = $z + $offsetZ;
1859 !$this->isInWorld($x1, $y1, $z1) ||
1860 ($chunk = $this->getChunk($x1 >> Chunk::COORD_BIT_SIZE, $z1 >> Chunk::COORD_BIT_SIZE)) ===
null ||
1861 $chunk->isLightPopulated() !==
true
1865 $max = max($max, $lightGetter($x1, $y1, $z1));
1874 return $this->getHighestAdjacentLight($x, $y, $z, $this->getPotentialBlockSkyLightAt(...));
1882 return $this->getHighestAdjacentPotentialBlockSkyLight($x, $y, $z) - $this->skyLightReduction;
1889 return $this->getHighestAdjacentLight($x, $y, $z, $this->getBlockLightAt(...));
1892 private function executeQueuedLightUpdates() : void{
1893 if($this->blockLightUpdate !== null){
1894 $this->timings->doBlockLightUpdates->startTiming();
1895 $this->blockLightUpdate->execute();
1896 $this->blockLightUpdate =
null;
1897 $this->timings->doBlockLightUpdates->stopTiming();
1900 if($this->skyLightUpdate !==
null){
1901 $this->timings->doBlockSkyLightUpdates->startTiming();
1902 $this->skyLightUpdate->execute();
1903 $this->skyLightUpdate =
null;
1904 $this->timings->doBlockSkyLightUpdates->stopTiming();
1911 $y < $this->maxY && $y >= $this->minY &&
1927 return $this->getBlockAt((int) floor($pos->x), (int) floor($pos->y), (int) floor($pos->z), $cached, $addToCache);
1939 public function getBlockAt(
int $x,
int $y,
int $z,
bool $cached =
true,
bool $addToCache =
true) :
Block{
1940 $relativeBlockHash = null;
1941 $chunkHash = World::chunkHash($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE);
1943 if($this->isInWorld($x, $y, $z)){
1944 $relativeBlockHash = World::chunkBlockHash($x, $y, $z);
1946 if($cached && isset($this->blockCache[$chunkHash][$relativeBlockHash])){
1947 return $this->blockCache[$chunkHash][$relativeBlockHash];
1950 $chunk = $this->chunks[$chunkHash] ??
null;
1951 if($chunk !==
null){
1952 $block = $this->blockStateRegistry->fromStateId($chunk->getBlockStateId($x & Chunk::COORD_MASK, $y, $z & Chunk::COORD_MASK));
1954 $addToCache =
false;
1955 $block = VanillaBlocks::AIR();
1958 $block = VanillaBlocks::AIR();
1961 $block->position($this, $x, $y, $z);
1963 if($this->inDynamicStateRecalculation){
1967 $addToCache =
false;
1969 $this->inDynamicStateRecalculation =
true;
1970 $replacement = $block->readStateFromWorld();
1971 if($replacement !== $block){
1972 $replacement->position($this, $x, $y, $z);
1973 $block = $replacement;
1975 $this->inDynamicStateRecalculation =
false;
1978 if($addToCache && $relativeBlockHash !==
null){
1979 $this->blockCache[$chunkHash][$relativeBlockHash] = $block;
1981 if(++$this->blockCacheSize >= self::BLOCK_CACHE_SIZE_CAP){
1982 $this->trimBlockCache();
1995 $this->setBlockAt((int) floor($pos->x), (int) floor($pos->y), (int) floor($pos->z), $block, $update);
2006 public function setBlockAt(
int $x,
int $y,
int $z,
Block $block,
bool $update =
true) : void{
2007 if(!$this->isInWorld($x, $y, $z)){
2008 throw new \InvalidArgumentException(
"Pos x=$x,y=$y,z=$z is outside of the world bounds");
2010 $chunkX = $x >> Chunk::COORD_BIT_SIZE;
2011 $chunkZ = $z >> Chunk::COORD_BIT_SIZE;
2012 if($this->loadChunk($chunkX, $chunkZ) ===
null){
2013 throw new WorldException(
"Cannot set a block in un-generated terrain");
2017 $stateId = $block->getStateId();
2018 if(!$this->blockStateRegistry->hasStateId($stateId)){
2019 throw new \LogicException(
"Block state ID not known to RuntimeBlockStateRegistry (probably not registered)");
2021 if(!GlobalBlockStateHandlers::getSerializer()->isRegistered($block)){
2022 throw new \LogicException(
"Block not registered with GlobalBlockStateHandlers serializer");
2025 $this->timings->setBlock->startTiming();
2027 $this->unlockChunk($chunkX, $chunkZ,
null);
2029 $block = clone $block;
2031 $block->position($this, $x, $y, $z);
2032 $block->writeStateToWorld();
2033 $pos =
new Vector3($x, $y, $z);
2035 $chunkHash = World::chunkHash($chunkX, $chunkZ);
2036 $relativeBlockHash = World::chunkBlockHash($x, $y, $z);
2038 unset($this->blockCache[$chunkHash][$relativeBlockHash]);
2039 $this->blockCacheSize--;
2040 unset($this->blockCollisionBoxCache[$chunkHash][$relativeBlockHash]);
2043 foreach(Facing::OFFSET as [$offsetX, $offsetY, $offsetZ]){
2044 $sideChunkPosHash = World::chunkHash(($x + $offsetX) >> Chunk::COORD_BIT_SIZE, ($z + $offsetZ) >> Chunk::COORD_BIT_SIZE);
2045 $sideChunkBlockHash = World::chunkBlockHash($x + $offsetX, $y + $offsetY, $z + $offsetZ);
2046 unset($this->blockCollisionBoxCache[$sideChunkPosHash][$sideChunkBlockHash]);
2049 if(!isset($this->changedBlocks[$chunkHash])){
2050 $this->changedBlocks[$chunkHash] = [];
2052 $this->changedBlocks[$chunkHash][$relativeBlockHash] = $pos;
2054 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2055 $listener->onBlockChanged($pos);
2059 $this->updateAllLight($x, $y, $z);
2060 $this->internalNotifyNeighbourBlockUpdate($x, $y, $z);
2063 $this->timings->setBlock->stopTiming();
2066 public function dropItem(Vector3 $source, Item $item, ?Vector3 $motion =
null,
int $delay = 10) : ?ItemEntity{
2067 if($item->isNull()){
2071 $itemEntity =
new ItemEntity(Location::fromObject($source, $this, Utils::getRandomFloat() * 360, 0), $item);
2073 $itemEntity->setPickupDelay($delay);
2074 $itemEntity->setMotion($motion ??
new Vector3(Utils::getRandomFloat() * 0.2 - 0.1, 0.2, Utils::getRandomFloat() * 0.2 - 0.1));
2075 $itemEntity->spawnToAll();
2089 foreach(ExperienceOrb::splitIntoOrbSizes($amount) as $split){
2090 $orb =
new ExperienceOrb(Location::fromObject($pos, $this, Utils::getRandomFloat() * 360, 0), $split);
2092 $orb->setMotion(
new Vector3((Utils::getRandomFloat() * 0.2 - 0.1) * 2, Utils::getRandomFloat() * 0.4, (Utils::getRandomFloat() * 0.2 - 0.1) * 2));
2109 public function useBreakOn(
Vector3 $vector, ?
Item &$item =
null, ?
Player $player =
null,
bool $createParticles =
false, array &$returnedItems = []) : bool{
2110 $vector = $vector->floor();
2112 $chunkX = $vector->getFloorX() >> Chunk::COORD_BIT_SIZE;
2113 $chunkZ = $vector->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2114 if(!$this->isChunkLoaded($chunkX, $chunkZ) || $this->isChunkLocked($chunkX, $chunkZ)){
2118 $target = $this->getBlock($vector);
2119 $affectedBlocks = $target->getAffectedBlocks();
2122 $item = VanillaItems::AIR();
2126 if($player ===
null || $player->hasFiniteResources()){
2127 $drops = array_merge(...array_map(fn(Block $block) => $block->getDrops($item), $affectedBlocks));
2131 if($player !==
null && $player->hasFiniteResources()){
2132 $xpDrop = array_sum(array_map(fn(Block $block) => $block->getXpDropForTool($item), $affectedBlocks));
2135 if($player !==
null){
2136 $ev =
new BlockBreakEvent($player, $target, $item, $player->isCreative(), $drops, $xpDrop);
2138 if($target instanceof Air || ($player->isSurvival() && !$target->getBreakInfo()->isBreakable()) || $player->isSpectator()){
2142 if($player->isAdventure(
true) && !$ev->isCancelled()){
2144 $itemParser = LegacyStringToItemParser::getInstance();
2145 foreach($item->getCanDestroy() as $v){
2146 $entry = $itemParser->parse($v);
2147 if($entry->getBlock()->hasSameTypeId($target)){
2159 if($ev->isCancelled()){
2163 $drops = $ev->getDrops();
2164 $xpDrop = $ev->getXpDropAmount();
2166 }elseif(!$target->getBreakInfo()->isBreakable()){
2170 foreach($affectedBlocks as $t){
2171 $this->destroyBlockInternal($t, $item, $player, $createParticles, $returnedItems);
2174 $item->onDestroyBlock($target, $returnedItems);
2176 if(count($drops) > 0){
2177 $dropPos = $vector->add(0.5, 0.5, 0.5);
2178 foreach($drops as $drop){
2179 if(!$drop->isNull()){
2180 $this->dropItem($dropPos, $drop);
2186 $this->dropExperience($vector->add(0.5, 0.5, 0.5), $xpDrop);
2195 private function destroyBlockInternal(Block $target, Item $item, ?Player $player,
bool $createParticles, array &$returnedItems) : void{
2196 if($createParticles){
2197 $this->addParticle($target->getPosition()->add(0.5, 0.5, 0.5),
new BlockBreakParticle($target));
2200 $target->onBreak($item, $player, $returnedItems);
2202 $tile = $this->getTile($target->getPosition());
2204 $tile->onBlockDestroyed();
2215 public function useItemOn(
Vector3 $vector,
Item &$item,
int $face, ?
Vector3 $clickVector =
null, ?
Player $player =
null,
bool $playSound =
false, array &$returnedItems = []) : bool{
2216 $blockClicked = $this->getBlock($vector);
2217 $blockReplace = $blockClicked->getSide($face);
2219 if($clickVector ===
null){
2220 $clickVector =
new Vector3(0.0, 0.0, 0.0);
2223 min(1.0, max(0.0, $clickVector->x)),
2224 min(1.0, max(0.0, $clickVector->y)),
2225 min(1.0, max(0.0, $clickVector->z))
2229 if(!$this->isInWorld($blockReplace->getPosition()->x, $blockReplace->getPosition()->y, $blockReplace->getPosition()->z)){
2233 $chunkX = $blockReplace->getPosition()->getFloorX() >> Chunk::COORD_BIT_SIZE;
2234 $chunkZ = $blockReplace->getPosition()->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2235 if(!$this->isChunkLoaded($chunkX, $chunkZ) || $this->isChunkLocked($chunkX, $chunkZ)){
2239 if($blockClicked->getTypeId() === BlockTypeIds::AIR){
2243 if($player !==
null){
2244 $ev = new PlayerInteractEvent($player, $item, $blockClicked, $clickVector, $face, PlayerInteractEvent::RIGHT_CLICK_BLOCK);
2245 if($player->isSneaking()){
2246 $ev->setUseItem(false);
2247 $ev->setUseBlock($item->isNull());
2249 if($player->isSpectator()){
2254 if(!$ev->isCancelled()){
2255 if($ev->useBlock() && $blockClicked->onInteract($item, $face, $clickVector, $player, $returnedItems)){
2260 $result = $item->onInteractBlock($player, $blockReplace, $blockClicked, $face, $clickVector, $returnedItems);
2261 if($result !== ItemUseResult::NONE){
2262 return $result === ItemUseResult::SUCCESS;
2268 }elseif($blockClicked->onInteract($item, $face, $clickVector, $player, $returnedItems)){
2272 if($item->isNull() || !$item->canBePlaced()){
2276 $hand->position($this, $blockReplace->getPosition()->x, $blockReplace->getPosition()->y, $blockReplace->getPosition()->z);
2278 if($hand->canBePlacedAt($blockClicked, $clickVector, $face,
true)){
2279 $blockReplace = $blockClicked;
2284 $hand->position($this, $blockReplace->getPosition()->x, $blockReplace->getPosition()->y, $blockReplace->getPosition()->z);
2285 }elseif(!$hand->canBePlacedAt($blockReplace, $clickVector, $face,
false)){
2289 $tx =
new BlockTransaction($this);
2290 if(!$hand->place($tx, $item, $blockReplace, $blockClicked, $face, $clickVector, $player)){
2294 foreach($tx->getBlocks() as [$x, $y, $z, $block]){
2295 $block->position($this, $x, $y, $z);
2296 foreach($block->getCollisionBoxes() as $collisionBox){
2297 if(count($this->getCollidingEntities($collisionBox)) > 0){
2303 if($player !==
null){
2304 $ev =
new BlockPlaceEvent($player, $tx, $blockClicked, $item);
2305 if($player->isSpectator()){
2309 if($player->isAdventure(
true) && !$ev->isCancelled()){
2311 $itemParser = LegacyStringToItemParser::getInstance();
2313 $entry = $itemParser->parse($v);
2314 if($entry->getBlock()->hasSameTypeId($blockClicked)){
2326 if($ev->isCancelled()){
2334 foreach($tx->getBlocks() as [$x, $y, $z, $_]){
2335 $tile = $this->getTileAt($x, $y, $z);
2338 $tile->copyDataFromItem($item);
2341 $this->getBlockAt($x, $y, $z)->onPostPlace();
2345 $this->addSound($hand->getPosition(),
new BlockPlaceSound($hand));
2353 public function getEntity(
int $entityId) : ?Entity{
2354 return $this->entities[$entityId] ?? null;
2364 return $this->entities;
2380 foreach($this->getNearbyEntities($bb, $entity) as $ent){
2381 if($ent->canBeCollidedWith() && ($entity ===
null || $entity->canCollideWith($ent))){
2398 $minX = ((int) floor($bb->minX - 2)) >> Chunk::COORD_BIT_SIZE;
2399 $maxX = ((int) floor($bb->maxX + 2)) >> Chunk::COORD_BIT_SIZE;
2400 $minZ = ((int) floor($bb->minZ - 2)) >> Chunk::COORD_BIT_SIZE;
2401 $maxZ = ((int) floor($bb->maxZ + 2)) >> Chunk::COORD_BIT_SIZE;
2403 for($x = $minX; $x <= $maxX; ++$x){
2404 for($z = $minZ; $z <= $maxZ; ++$z){
2405 foreach($this->getChunkEntities($x, $z) as $ent){
2406 if($ent !== $entity && $ent->boundingBox->intersectsWith($bb)){
2428 assert(is_a($entityType,
Entity::class, true));
2430 $minX = ((int) floor($pos->x - $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2431 $maxX = ((int) floor($pos->x + $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2432 $minZ = ((int) floor($pos->z - $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2433 $maxZ = ((int) floor($pos->z + $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2435 $currentTargetDistSq = $maxDistance ** 2;
2441 $currentTarget =
null;
2443 for($x = $minX; $x <= $maxX; ++$x){
2444 for($z = $minZ; $z <= $maxZ; ++$z){
2445 foreach($this->getChunkEntities($x, $z) as $entity){
2446 if(!($entity instanceof $entityType) || $entity->isFlaggedForDespawn() || (!$includeDead && !$entity->isAlive())){
2449 $distSq = $entity->getPosition()->distanceSquared($pos);
2450 if($distSq < $currentTargetDistSq){
2451 $currentTargetDistSq = $distSq;
2452 $currentTarget = $entity;
2458 return $currentTarget;
2468 return $this->players;
2478 return $this->getTileAt((int) floor($pos->x), (int) floor($pos->y), (int) floor($pos->z));
2485 return ($chunk = $this->loadChunk($x >>
Chunk::COORD_BIT_SIZE, $z >>
Chunk::COORD_BIT_SIZE)) !== null ? $chunk->getTile($x &
Chunk::COORD_MASK, $y, $z &
Chunk::COORD_MASK) : null;
2488 public function getBiomeId(
int $x,
int $y,
int $z) : int{
2489 if(($chunk = $this->loadChunk($x >>
Chunk::COORD_BIT_SIZE, $z >>
Chunk::COORD_BIT_SIZE)) !== null){
2490 return $chunk->getBiomeId($x & Chunk::COORD_MASK, $y & Chunk::COORD_MASK, $z & Chunk::COORD_MASK);
2492 return BiomeIds::OCEAN;
2495 public function getBiome(
int $x,
int $y,
int $z) : Biome{
2496 return BiomeRegistry::getInstance()->getBiome($this->getBiomeId($x, $y, $z));
2499 public function setBiomeId(
int $x,
int $y,
int $z,
int $biomeId) : void{
2500 $chunkX = $x >> Chunk::COORD_BIT_SIZE;
2501 $chunkZ = $z >> Chunk::COORD_BIT_SIZE;
2502 $this->unlockChunk($chunkX, $chunkZ,
null);
2503 if(($chunk = $this->loadChunk($chunkX, $chunkZ)) !==
null){
2504 $chunk->setBiomeId($x & Chunk::COORD_MASK, $y & Chunk::COORD_MASK, $z & Chunk::COORD_MASK, $biomeId);
2507 throw new WorldException(
"Cannot set biome in a non-generated chunk");
2516 return $this->chunks;
2519 public function getChunk(
int $chunkX,
int $chunkZ) : ?
Chunk{
2520 return $this->chunks[
World::chunkHash($chunkX, $chunkZ)] ?? null;
2528 return $this->entitiesByChunk[
World::chunkHash($chunkX, $chunkZ)] ?? [];
2535 return $this->loadChunk($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE);
2546 for($xx = -1; $xx <= 1; ++$xx){
2547 for($zz = -1; $zz <= 1; ++$zz){
2548 if($xx === 0 && $zz === 0){
2551 $result[World::chunkHash($xx, $zz)] = $this->loadChunk($x + $xx, $z + $zz);
2573 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
2574 if(isset($this->chunkLock[$chunkHash])){
2575 throw new \InvalidArgumentException(
"Chunk $chunkX $chunkZ is already locked");
2577 $this->chunkLock[$chunkHash] = $lockId;
2578 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
2590 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
2591 if(isset($this->chunkLock[$chunkHash]) && ($lockId ===
null || $this->chunkLock[$chunkHash] === $lockId)){
2592 unset($this->chunkLock[$chunkHash]);
2593 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
2605 return isset($this->chunkLock[
World::chunkHash($chunkX, $chunkZ)]);
2608 public function setChunk(
int $chunkX,
int $chunkZ,
Chunk $chunk) : void{
2609 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
2610 $oldChunk = $this->loadChunk($chunkX, $chunkZ);
2611 if($oldChunk !==
null && $oldChunk !== $chunk){
2613 $transferredTiles = 0;
2614 foreach($oldChunk->getTiles() as $oldTile){
2615 $tilePosition = $oldTile->getPosition();
2616 $localX = $tilePosition->getFloorX() & Chunk::COORD_MASK;
2617 $localY = $tilePosition->getFloorY();
2618 $localZ = $tilePosition->getFloorZ() & Chunk::COORD_MASK;
2620 $newBlock = $this->blockStateRegistry->fromStateId($chunk->
getBlockStateId($localX, $localY, $localZ));
2621 $expectedTileClass = $newBlock->getIdInfo()->getTileClass();
2623 $expectedTileClass ===
null ||
2624 !($oldTile instanceof $expectedTileClass) ||
2625 (($newTile = $chunk->
getTile($localX, $localY, $localZ)) !==
null && $newTile !== $oldTile)
2630 $transferredTiles++;
2631 $chunk->addTile($oldTile);
2632 $oldChunk->removeTile($oldTile);
2635 if($deletedTiles > 0 || $transferredTiles > 0){
2636 $this->logger->debug(
"Replacement of chunk $chunkX $chunkZ caused deletion of $deletedTiles obsolete/conflicted tiles, and transfer of $transferredTiles");
2640 $this->chunks[$chunkHash] = $chunk;
2642 $this->blockCacheSize -= count($this->blockCache[$chunkHash] ?? []);
2643 unset($this->blockCache[$chunkHash]);
2644 unset($this->blockCollisionBoxCache[$chunkHash]);
2645 unset($this->changedBlocks[$chunkHash]);
2646 $chunk->setTerrainDirty();
2647 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
2649 if(!$this->isChunkInUse($chunkX, $chunkZ)){
2650 $this->unloadChunkRequest($chunkX, $chunkZ);
2653 if($oldChunk ===
null){
2654 if(ChunkLoadEvent::hasHandlers()){
2655 (
new ChunkLoadEvent($this, $chunkX, $chunkZ, $chunk,
true))->call();
2658 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2659 $listener->onChunkLoaded($chunkX, $chunkZ, $chunk);
2662 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2663 $listener->onChunkChanged($chunkX, $chunkZ, $chunk);
2667 for($cX = -1; $cX <= 1; ++$cX){
2668 for($cZ = -1; $cZ <= 1; ++$cZ){
2669 foreach($this->getChunkEntities($chunkX + $cX, $chunkZ + $cZ) as $entity){
2670 $entity->onNearbyBlockChange();
2683 if(($chunk = $this->loadChunk($x >>
Chunk::COORD_BIT_SIZE, $z >>
Chunk::COORD_BIT_SIZE)) !== null){
2684 return $chunk->
getHighestBlockAt($x & Chunk::COORD_MASK, $z & Chunk::COORD_MASK);
2686 throw new WorldException(
"Cannot get highest block in an ungenerated chunk");
2693 return $this->isChunkLoaded($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE);
2696 public function isChunkLoaded(
int $x,
int $z) : bool{
2697 return isset($this->chunks[
World::chunkHash($x, $z)]);
2700 public function isChunkGenerated(
int $x,
int $z) : bool{
2701 return $this->loadChunk($x, $z) !== null;
2704 public function isChunkPopulated(
int $x,
int $z) : bool{
2705 $chunk = $this->loadChunk($x, $z);
2706 return $chunk !==
null && $chunk->isPopulated();
2713 return
Position::fromObject($this->provider->getWorldData()->getSpawn(), $this);
2720 $previousSpawn = $this->getSpawnLocation();
2721 $this->provider->getWorldData()->setSpawn($pos);
2724 $location = Position::fromObject($pos, $this);
2725 foreach($this->players as $player){
2726 $player->getNetworkSession()->syncWorldSpawnPoint($location);
2734 if($entity->isClosed()){
2735 throw new \InvalidArgumentException(
"Attempted to add a garbage closed Entity to world");
2737 if($entity->getWorld() !== $this){
2738 throw new \InvalidArgumentException(
"Invalid Entity world");
2740 if(array_key_exists($entity->getId(), $this->entities)){
2741 if($this->entities[$entity->getId()] === $entity){
2742 throw new \InvalidArgumentException(
"Entity " . $entity->getId() .
" has already been added to this world");
2744 throw new AssumptionFailedError(
"Found two different entities sharing entity ID " . $entity->getId());
2747 if(!EntityFactory::getInstance()->isRegistered($entity::class) && !$entity instanceof Player){
2750 throw new \LogicException(
"Entity " . $entity::class .
" is not registered for a save ID in EntityFactory");
2752 $pos = $entity->getPosition()->
asVector3();
2753 $this->entitiesByChunk[World::chunkHash($pos->getFloorX() >> Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE)][$entity->getId()] = $entity;
2754 $this->entityLastKnownPositions[$entity->getId()] = $pos;
2756 if($entity instanceof Player){
2757 $this->players[$entity->getId()] = $entity;
2759 $this->entities[$entity->getId()] = $entity;
2768 if($entity->getWorld() !== $this){
2769 throw new \InvalidArgumentException(
"Invalid Entity world");
2771 if(!array_key_exists($entity->getId(), $this->entities)){
2772 throw new \InvalidArgumentException(
"Entity is not tracked by this world (possibly already removed?)");
2774 $pos = $this->entityLastKnownPositions[$entity->getId()];
2775 $chunkHash = World::chunkHash($pos->getFloorX() >> Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE);
2776 if(isset($this->entitiesByChunk[$chunkHash][$entity->getId()])){
2777 if(count($this->entitiesByChunk[$chunkHash]) === 1){
2778 unset($this->entitiesByChunk[$chunkHash]);
2780 unset($this->entitiesByChunk[$chunkHash][$entity->getId()]);
2783 unset($this->entityLastKnownPositions[$entity->getId()]);
2785 if($entity instanceof Player){
2786 unset($this->players[$entity->getId()]);
2787 $this->checkSleep();
2790 unset($this->entities[$entity->getId()]);
2791 unset($this->updateEntities[$entity->getId()]);
2797 public function onEntityMoved(Entity $entity) : void{
2798 if(!array_key_exists($entity->getId(), $this->entityLastKnownPositions)){
2802 $oldPosition = $this->entityLastKnownPositions[$entity->getId()];
2803 $newPosition = $entity->getPosition();
2805 $oldChunkX = $oldPosition->getFloorX() >> Chunk::COORD_BIT_SIZE;
2806 $oldChunkZ = $oldPosition->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2807 $newChunkX = $newPosition->getFloorX() >> Chunk::COORD_BIT_SIZE;
2808 $newChunkZ = $newPosition->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2810 if($oldChunkX !== $newChunkX || $oldChunkZ !== $newChunkZ){
2811 $oldChunkHash = World::chunkHash($oldChunkX, $oldChunkZ);
2812 if(isset($this->entitiesByChunk[$oldChunkHash][$entity->getId()])){
2813 if(count($this->entitiesByChunk[$oldChunkHash]) === 1){
2814 unset($this->entitiesByChunk[$oldChunkHash]);
2816 unset($this->entitiesByChunk[$oldChunkHash][$entity->getId()]);
2820 $newViewers = $this->getViewersForPosition($newPosition);
2821 foreach($entity->getViewers() as $player){
2822 if(!isset($newViewers[spl_object_id($player)])){
2823 $entity->despawnFrom($player);
2825 unset($newViewers[spl_object_id($player)]);
2828 foreach($newViewers as $player){
2829 $entity->spawnTo($player);
2832 $newChunkHash = World::chunkHash($newChunkX, $newChunkZ);
2833 $this->entitiesByChunk[$newChunkHash][$entity->getId()] = $entity;
2835 $this->entityLastKnownPositions[$entity->getId()] = $newPosition->asVector3();
2842 public function addTile(Tile $tile) : void{
2843 if($tile->isClosed()){
2844 throw new \InvalidArgumentException(
"Attempted to add a garbage closed Tile to world");
2846 $pos = $tile->getPosition();
2847 if(!$pos->isValid() || $pos->getWorld() !== $this){
2848 throw new \InvalidArgumentException(
"Invalid Tile world");
2850 if(!$this->isInWorld($pos->getFloorX(), $pos->getFloorY(), $pos->getFloorZ())){
2851 throw new \InvalidArgumentException(
"Tile position is outside the world bounds");
2853 if(!TileFactory::getInstance()->isRegistered($tile::class)){
2854 throw new \LogicException(
"Tile " . $tile::class .
" is not registered for a save ID in TileFactory");
2857 $chunkX = $pos->getFloorX() >> Chunk::COORD_BIT_SIZE;
2858 $chunkZ = $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2860 if(isset($this->chunks[$hash = World::chunkHash($chunkX, $chunkZ)])){
2861 $this->chunks[$hash]->addTile($tile);
2863 throw new \InvalidArgumentException(
"Attempted to create tile " . get_class($tile) .
" in unloaded chunk $chunkX $chunkZ");
2867 $this->scheduleDelayedBlockUpdate($pos->
asVector3(), 1);
2874 public function removeTile(Tile $tile) : void{
2876 if(!$pos->isValid() || $pos->getWorld() !== $this){
2877 throw new \InvalidArgumentException(
"Invalid Tile world");
2880 $chunkX = $pos->getFloorX() >> Chunk::COORD_BIT_SIZE;
2881 $chunkZ = $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2883 if(isset($this->chunks[$hash = World::chunkHash($chunkX, $chunkZ)])){
2884 $this->chunks[$hash]->removeTile($tile);
2886 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2887 $listener->onBlockChanged($pos->
asVector3());
2891 public function isChunkInUse(
int $x,
int $z) : bool{
2892 return isset($this->chunkLoaders[$index = World::chunkHash($x, $z)]) && count($this->chunkLoaders[$index]) > 0;
2902 if(isset($this->chunks[$chunkHash =
World::chunkHash($x, $z)])){
2903 return $this->chunks[$chunkHash];
2906 $this->timings->syncChunkLoad->startTiming();
2908 $this->cancelUnloadChunkRequest($x, $z);
2910 $this->timings->syncChunkLoadData->startTiming();
2912 $loadedChunkData =
null;
2915 $loadedChunkData = $this->provider->loadChunk($x, $z);
2916 }
catch(CorruptedChunkException $e){
2917 $this->logger->critical(
"Failed to load chunk x=$x z=$z: " . $e->getMessage());
2920 $this->timings->syncChunkLoadData->stopTiming();
2922 if($loadedChunkData ===
null){
2923 $this->timings->syncChunkLoad->stopTiming();
2927 $chunkData = $loadedChunkData->getData();
2928 $chunk =
new Chunk($chunkData->getSubChunks(), $chunkData->isPopulated());
2929 if(!$loadedChunkData->isUpgraded()){
2930 $chunk->clearTerrainDirtyFlags();
2932 $this->logger->debug(
"Chunk $x $z has been upgraded, will be saved at the next autosave opportunity");
2934 $this->chunks[$chunkHash] = $chunk;
2936 $this->blockCacheSize -= count($this->blockCache[$chunkHash] ?? []);
2937 unset($this->blockCache[$chunkHash]);
2938 unset($this->blockCollisionBoxCache[$chunkHash]);
2940 $this->initChunk($x, $z, $chunkData);
2942 if(ChunkLoadEvent::hasHandlers()){
2943 (
new ChunkLoadEvent($this, $x, $z, $this->chunks[$chunkHash],
false))->call();
2946 if(!$this->isChunkInUse($x, $z)){
2947 $this->logger->debug(
"Newly loaded chunk $x $z has no loaders registered, will be unloaded at next available opportunity");
2948 $this->unloadChunkRequest($x, $z);
2950 foreach($this->getChunkListeners($x, $z) as $listener){
2951 $listener->onChunkLoaded($x, $z, $this->chunks[$chunkHash]);
2953 $this->markTickingChunkForRecheck($x, $z);
2955 $this->timings->syncChunkLoad->stopTiming();
2957 return $this->chunks[$chunkHash];
2960 private function initChunk(
int $chunkX,
int $chunkZ, ChunkData $chunkData) : void{
2961 $logger = new \
PrefixedLogger($this->logger,
"Loading chunk $chunkX $chunkZ");
2963 if(count($chunkData->getEntityNBT()) !== 0){
2964 $this->timings->syncChunkLoadEntities->startTiming();
2965 $entityFactory = EntityFactory::getInstance();
2966 foreach($chunkData->getEntityNBT() as $k => $nbt){
2968 $entity = $entityFactory->createFromData($this, $nbt);
2969 }catch(SavedDataLoadingException $e){
2970 $logger->error(
"Bad entity data at list position $k: " . $e->getMessage());
2971 $logger->logException($e);
2974 if($entity === null){
2975 $saveIdTag = $nbt->getTag(
"identifier") ?? $nbt->getTag(
"id");
2976 $saveId =
"<unknown>";
2977 if($saveIdTag instanceof StringTag){
2978 $saveId = $saveIdTag->getValue();
2979 }elseif($saveIdTag instanceof IntTag){
2980 $saveId =
"legacy(" . $saveIdTag->getValue() .
")";
2982 $logger->warning(
"Deleted unknown entity type $saveId");
2988 $this->timings->syncChunkLoadEntities->stopTiming();
2991 if(count($chunkData->getTileNBT()) !== 0){
2992 $this->timings->syncChunkLoadTileEntities->startTiming();
2993 $tileFactory = TileFactory::getInstance();
2994 foreach($chunkData->getTileNBT() as $k => $nbt){
2996 $tile = $tileFactory->createFromData($this, $nbt);
2997 }catch(SavedDataLoadingException $e){
2998 $logger->error(
"Bad tile entity data at list position $k: " . $e->getMessage());
2999 $logger->logException($e);
3003 $logger->warning(
"Deleted unknown tile entity type " . $nbt->getString(
"id",
"<unknown>"));
3007 $tilePosition = $tile->getPosition();
3008 if(!$this->isChunkLoaded($tilePosition->getFloorX() >> Chunk::COORD_BIT_SIZE, $tilePosition->getFloorZ() >> Chunk::COORD_BIT_SIZE)){
3009 $logger->error(
"Found tile saved on wrong chunk - unable to fix due to correct chunk not loaded");
3010 }elseif(!$this->isInWorld($tilePosition->getFloorX(), $tilePosition->getFloorY(), $tilePosition->getFloorZ())){
3011 $logger->error(
"Cannot add tile with position outside the world bounds: x=$tilePosition->x,y=$tilePosition->y,z=$tilePosition->z");
3012 }elseif($this->getTile($tilePosition) !== null){
3013 $logger->error(
"Cannot add tile at x=$tilePosition->x,y=$tilePosition->y,z=$tilePosition->z: Another tile is already at that position");
3015 $this->addTile($tile);
3019 $this->timings->syncChunkLoadTileEntities->stopTiming();
3023 private function queueUnloadChunk(
int $x,
int $z) : void{
3024 $this->unloadQueue[World::chunkHash($x, $z)] = microtime(true);
3027 public function unloadChunkRequest(
int $x,
int $z,
bool $safe =
true) : bool{
3028 if(($safe && $this->isChunkInUse($x, $z)) || $this->isSpawnChunk($x, $z)){
3032 $this->queueUnloadChunk($x, $z);
3037 public function cancelUnloadChunkRequest(
int $x,
int $z) : void{
3038 unset($this->unloadQueue[World::chunkHash($x, $z)]);
3041 public function unloadChunk(
int $x,
int $z,
bool $safe =
true,
bool $trySave =
true) : bool{
3042 if($safe && $this->isChunkInUse($x, $z)){
3046 if(!$this->isChunkLoaded($x, $z)){
3050 $this->timings->doChunkUnload->startTiming();
3052 $chunkHash = World::chunkHash($x, $z);
3054 $chunk = $this->chunks[$chunkHash] ??
null;
3056 if($chunk !==
null){
3057 if(ChunkUnloadEvent::hasHandlers()){
3058 $ev =
new ChunkUnloadEvent($this, $x, $z, $chunk);
3060 if($ev->isCancelled()){
3061 $this->timings->doChunkUnload->stopTiming();
3067 if($trySave && $this->getAutoSave()){
3068 $this->timings->syncChunkSave->startTiming();
3070 $this->provider->saveChunk($x, $z,
new ChunkData(
3072 $chunk->isPopulated(),
3073 array_map(fn(Entity $e) => $e->saveNBT(), array_values(array_filter($this->getChunkEntities($x, $z), fn(Entity $e) => $e->canSaveWithChunk()))),
3074 array_map(fn(Tile $t) => $t->saveNBT(), array_values($chunk->
getTiles())),
3075 ), $chunk->getTerrainDirtyFlags());
3077 $this->timings->syncChunkSave->stopTiming();
3081 foreach($this->getChunkListeners($x, $z) as $listener){
3082 $listener->onChunkUnloaded($x, $z, $chunk);
3085 foreach($this->getChunkEntities($x, $z) as $entity){
3086 if($entity instanceof Player){
3095 unset($this->chunks[$chunkHash]);
3096 $this->blockCacheSize -= count($this->blockCache[$chunkHash] ?? []);
3097 unset($this->blockCache[$chunkHash]);
3098 unset($this->blockCollisionBoxCache[$chunkHash]);
3099 unset($this->changedBlocks[$chunkHash]);
3100 unset($this->registeredTickingChunks[$chunkHash]);
3101 $this->markTickingChunkForRecheck($x, $z);
3103 if(array_key_exists($chunkHash, $this->chunkPopulationRequestMap)){
3104 $this->logger->debug(
"Rejecting population promise for chunk $x $z");
3105 $this->chunkPopulationRequestMap[$chunkHash]->reject();
3106 unset($this->chunkPopulationRequestMap[$chunkHash]);
3107 if(isset($this->activeChunkPopulationTasks[$chunkHash])){
3108 $this->logger->debug(
"Marking population task for chunk $x $z as orphaned");
3109 $this->activeChunkPopulationTasks[$chunkHash] =
false;
3113 $this->timings->doChunkUnload->stopTiming();
3122 $spawn = $this->getSpawnLocation();
3123 $spawnX = $spawn->x >> Chunk::COORD_BIT_SIZE;
3124 $spawnZ = $spawn->z >> Chunk::COORD_BIT_SIZE;
3126 return abs($X - $spawnX) <= 1 && abs($Z - $spawnZ) <= 1;
3139 $spawn ??= $this->getSpawnLocation();
3144 $this->requestChunkPopulation($spawn->getFloorX() >> Chunk::COORD_BIT_SIZE, $spawn->getFloorZ() >> Chunk::COORD_BIT_SIZE,
null)->onCompletion(
3145 function() use ($spawn, $resolver) :
void{
3146 $spawn = $this->getSafeSpawn($spawn);
3147 $resolver->resolve($spawn);
3149 function() use ($resolver) : void{
3150 $resolver->reject();
3154 return $resolver->getPromise();
3164 if(!($spawn instanceof
Vector3) || $spawn->y <= $this->minY){
3165 $spawn = $this->getSpawnLocation();
3169 $v = $spawn->floor();
3170 $chunk = $this->getOrLoadChunkAtPosition($v);
3171 if($chunk ===
null){
3172 throw new WorldException(
"Cannot find a safe spawn point in non-generated terrain");
3176 $y = (int) min($max - 2, $v->y);
3177 $wasAir = $this->getBlockAt($x, $y - 1, $z)->getTypeId() === BlockTypeIds::AIR;
3178 for(; $y > $this->minY; --$y){
3179 if($this->getBlockAt($x, $y, $z)->isFullCube()){
3189 for(; $y >= $this->minY && $y < $max; ++$y){
3190 if(!$this->getBlockAt($x, $y + 1, $z)->isFullCube()){
3191 if(!$this->getBlockAt($x, $y, $z)->isFullCube()){
3192 return new Position($spawn->x, $y === (
int) $spawn->y ? $spawn->y : $y, $spawn->z, $this);
3199 return new Position($spawn->x, $y, $spawn->z, $this);
3213 return $this->time % self::TIME_FULL;
3221 return $this->displayName;
3230 $this->displayName = $name;
3231 $this->provider->getWorldData()->setName($name);
3238 return $this->folderName;
3245 $this->time = $time;
3253 $this->stopTime = true;
3261 $this->stopTime = false;
3269 return $this->provider->getWorldData()->getSeed();
3280 public function getDifficulty() : int{
3281 return $this->provider->getWorldData()->getDifficulty();
3284 public function setDifficulty(
int $difficulty) : void{
3285 if($difficulty < 0 || $difficulty > 3){
3286 throw new \InvalidArgumentException(
"Invalid difficulty level $difficulty");
3288 (
new WorldDifficultyChangeEvent($this, $this->getDifficulty(), $difficulty))->call();
3289 $this->provider->getWorldData()->setDifficulty($difficulty);
3291 foreach($this->players as $player){
3292 $player->getNetworkSession()->syncWorldDifficulty($this->getDifficulty());
3296 private function addChunkHashToPopulationRequestQueue(
int $chunkHash) : void{
3297 if(!isset($this->chunkPopulationRequestQueueIndex[$chunkHash])){
3298 $this->chunkPopulationRequestQueue->enqueue($chunkHash);
3299 $this->chunkPopulationRequestQueueIndex[$chunkHash] =
true;
3306 private function enqueuePopulationRequest(
int $chunkX,
int $chunkZ, ?ChunkLoader $associatedChunkLoader) : Promise{
3307 $chunkHash = World::chunkHash($chunkX, $chunkZ);
3308 $this->addChunkHashToPopulationRequestQueue($chunkHash);
3310 $resolver = $this->chunkPopulationRequestMap[$chunkHash] =
new PromiseResolver();
3311 if($associatedChunkLoader ===
null){
3312 $temporaryLoader =
new class implements ChunkLoader{};
3313 $this->registerChunkLoader($temporaryLoader, $chunkX, $chunkZ);
3314 $resolver->getPromise()->onCompletion(
3315 fn() => $this->unregisterChunkLoader($temporaryLoader, $chunkX, $chunkZ),
3316 static function() :
void{}
3319 return $resolver->getPromise();
3322 private function drainPopulationRequestQueue() : void{
3324 while(count($this->activeChunkPopulationTasks) < $this->maxConcurrentChunkPopulationTasks && !$this->chunkPopulationRequestQueue->isEmpty()){
3325 $nextChunkHash = $this->chunkPopulationRequestQueue->dequeue();
3326 unset($this->chunkPopulationRequestQueueIndex[$nextChunkHash]);
3327 World::getXZ($nextChunkHash, $nextChunkX, $nextChunkZ);
3328 if(isset($this->chunkPopulationRequestMap[$nextChunkHash])){
3329 assert(!($this->activeChunkPopulationTasks[$nextChunkHash] ??
false),
"Population for chunk $nextChunkX $nextChunkZ already running");
3331 !$this->orderChunkPopulation($nextChunkX, $nextChunkZ,
null)->isResolved() &&
3332 !isset($this->activeChunkPopulationTasks[$nextChunkHash])
3334 $failed[] = $nextChunkHash;
3341 foreach($failed as $hash){
3342 $this->addChunkHashToPopulationRequestQueue($hash);
3351 private function checkChunkPopulationPreconditions(
int $chunkX,
int $chunkZ) : array{
3352 $chunkHash = World::chunkHash($chunkX, $chunkZ);
3353 $resolver = $this->chunkPopulationRequestMap[$chunkHash] ??
null;
3354 if($resolver !==
null && isset($this->activeChunkPopulationTasks[$chunkHash])){
3356 return [$resolver,
false];
3359 $temporaryChunkLoader =
new class implements ChunkLoader{};
3360 $this->registerChunkLoader($temporaryChunkLoader, $chunkX, $chunkZ);
3361 $chunk = $this->loadChunk($chunkX, $chunkZ);
3362 $this->unregisterChunkLoader($temporaryChunkLoader, $chunkX, $chunkZ);
3363 if($chunk !==
null && $chunk->isPopulated()){
3365 $resolver ??=
new PromiseResolver();
3366 unset($this->chunkPopulationRequestMap[$chunkHash]);
3367 $resolver->resolve($chunk);
3368 return [$resolver,
false];
3370 return [$resolver,
true];
3385 [$resolver, $proceedWithPopulation] = $this->checkChunkPopulationPreconditions($chunkX, $chunkZ);
3386 if(!$proceedWithPopulation){
3387 return $resolver?->getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3390 if(count($this->activeChunkPopulationTasks) >= $this->maxConcurrentChunkPopulationTasks){
3392 return $resolver?->getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3394 return $this->internalOrderChunkPopulation($chunkX, $chunkZ, $associatedChunkLoader, $resolver);
3408 [$resolver, $proceedWithPopulation] = $this->checkChunkPopulationPreconditions($chunkX, $chunkZ);
3409 if(!$proceedWithPopulation){
3410 return $resolver?->getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3413 return $this->internalOrderChunkPopulation($chunkX, $chunkZ, $associatedChunkLoader, $resolver);
3420 private function internalOrderChunkPopulation(
int $chunkX,
int $chunkZ, ?ChunkLoader $associatedChunkLoader, ?
PromiseResolver $resolver) :
Promise{
3421 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
3423 $timings = $this->timings->chunkPopulationOrder;
3424 $timings->startTiming();
3427 for($xx = -1; $xx <= 1; ++$xx){
3428 for($zz = -1; $zz <= 1; ++$zz){
3429 if($this->isChunkLocked($chunkX + $xx, $chunkZ + $zz)){
3431 return $resolver?->
getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3436 $this->activeChunkPopulationTasks[$chunkHash] =
true;
3437 if($resolver ===
null){
3438 $resolver =
new PromiseResolver();
3439 $this->chunkPopulationRequestMap[$chunkHash] = $resolver;
3442 $chunkPopulationLockId =
new ChunkLockId();
3444 $temporaryChunkLoader =
new class implements ChunkLoader{
3446 for($xx = -1; $xx <= 1; ++$xx){
3447 for($zz = -1; $zz <= 1; ++$zz){
3448 $this->lockChunk($chunkX + $xx, $chunkZ + $zz, $chunkPopulationLockId);
3449 $this->registerChunkLoader($temporaryChunkLoader, $chunkX + $xx, $chunkZ + $zz);
3453 $centerChunk = $this->loadChunk($chunkX, $chunkZ);
3454 $adjacentChunks = $this->getAdjacentChunks($chunkX, $chunkZ);
3456 $this->generatorExecutor->populate(
3461 function(Chunk $centerChunk, array $adjacentChunks) use ($chunkPopulationLockId, $chunkX, $chunkZ, $temporaryChunkLoader) :
void{
3462 if(!$this->isLoaded()){
3466 $this->generateChunkCallback($chunkPopulationLockId, $chunkX, $chunkZ, $centerChunk, $adjacentChunks, $temporaryChunkLoader);
3472 $timings->stopTiming();
3480 private function generateChunkCallback(ChunkLockId $chunkLockId,
int $x,
int $z, Chunk $chunk, array $adjacentChunks, ChunkLoader $temporaryChunkLoader) : void{
3481 $timings = $this->timings->chunkPopulationCompletion;
3482 $timings->startTiming();
3485 for($xx = -1; $xx <= 1; ++$xx){
3486 for($zz = -1; $zz <= 1; ++$zz){
3487 $this->unregisterChunkLoader($temporaryChunkLoader, $x + $xx, $z + $zz);
3488 if(!$this->unlockChunk($x + $xx, $z + $zz, $chunkLockId)){
3494 $index = World::chunkHash($x, $z);
3495 if(!isset($this->activeChunkPopulationTasks[$index])){
3496 throw new AssumptionFailedError(
"This should always be set, regardless of whether the task was orphaned or not");
3498 if(!$this->activeChunkPopulationTasks[$index]){
3499 $this->logger->debug(
"Discarding orphaned population result for chunk x=$x,z=$z");
3500 unset($this->activeChunkPopulationTasks[$index]);
3502 if($dirtyChunks === 0){
3503 $oldChunk = $this->loadChunk($x, $z);
3504 $this->setChunk($x, $z, $chunk);
3506 foreach($adjacentChunks as $relativeChunkHash => $adjacentChunk){
3507 World::getXZ($relativeChunkHash, $relativeX, $relativeZ);
3508 if($relativeX < -1 || $relativeX > 1 || $relativeZ < -1 || $relativeZ > 1){
3509 throw new AssumptionFailedError(
"Adjacent chunks should be in range -1 ... +1 coordinates");
3511 $this->setChunk($x + $relativeX, $z + $relativeZ, $adjacentChunk);
3514 if(($oldChunk ===
null || !$oldChunk->isPopulated()) && $chunk->isPopulated()){
3515 if(ChunkPopulateEvent::hasHandlers()){
3516 (
new ChunkPopulateEvent($this, $x, $z, $chunk))->call();
3519 foreach($this->getChunkListeners($x, $z) as $listener){
3520 $listener->onChunkPopulated($x, $z, $chunk);
3524 $this->logger->debug(
"Discarding population result for chunk x=$x,z=$z - terrain was modified on the main thread before async population completed");
3533 unset($this->activeChunkPopulationTasks[$index]);
3535 if($dirtyChunks === 0){
3536 $promise = $this->chunkPopulationRequestMap[$index] ??
null;
3537 if($promise !==
null){
3538 unset($this->chunkPopulationRequestMap[$index]);
3539 $promise->resolve($chunk);
3542 $this->logger->debug(
"Unable to resolve population promise for chunk x=$x,z=$z - populated chunk was forcibly unloaded while setting modified chunks");
3548 $this->addChunkHashToPopulationRequestQueue($index);
3551 $this->drainPopulationRequestQueue();
3553 $timings->stopTiming();
3556 public function doChunkGarbageCollection() : void{
3557 $this->timings->doChunkGC->startTiming();
3559 foreach($this->chunks as $index => $chunk){
3560 if(!isset($this->unloadQueue[$index])){
3561 World::getXZ($index, $X, $Z);
3562 if(!$this->isSpawnChunk($X, $Z)){
3563 $this->unloadChunkRequest($X, $Z,
true);
3566 $chunk->collectGarbage();
3569 $this->provider->doGarbageCollection();
3571 $this->timings->doChunkGC->stopTiming();
3574 public function unloadChunks(
bool $force =
false) : void{
3575 if(count($this->unloadQueue) > 0){
3577 $now = microtime(
true);
3578 foreach($this->unloadQueue as $index => $time){
3579 World::getXZ($index, $X, $Z);
3582 if($maxUnload <= 0){
3584 }elseif($time > ($now - 30)){
3590 if($this->unloadChunk($X, $Z,
true)){
3591 unset($this->unloadQueue[$index]);