imports/architectury-api
1
0
Fork 0
mirror of https://github.com/architectury/architectury-api.git synced 2026-03-30 05:05:19 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add Chunk data save and load events, closes #89 (#92)

Browse Source 
* Created Chunk save and load event. Closes #89

* Fixed missing licence

* Update common/src/main/java/me/shedaniel/architectury/event/events/ChunkEvent.java

* Update common/src/main/java/me/shedaniel/architectury/event/events/ChunkEvent.java

* Update common/src/main/java/me/shedaniel/architectury/event/events/ChunkEvent.java

* Supply ServerLevel in ChunkEvent.LOAD, style cleanup

Signed-off-by: shedaniel <daniel@shedaniel.me>

* Add "Data" suffix to Chunk IO Events and mark level as nullable for load

* Update common/src/main/java/me/shedaniel/architectury/event/events/ChunkEvent.java

* Bump to 1.16

Co-authored-by: shedaniel <daniel@shedaniel.me>
Co-authored-by: Max <maxh2709@gmail.com>
This commit is contained in:
canitzp
2021-05-27 01:03:20 +02:00
committed by GitHub
parent d737e8e2b7
commit 582ededddd
10 changed files with 309 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
common/src/main/java/me/shedaniel/architectury/event/events/ChunkEvent.java Normal file
View File

@@ -0,0 +1,65 @@
/*
* This file is part of architectury.
* Copyright (C) 2020, 2021 architectury
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package me.shedaniel.architectury.event.events;
import me.shedaniel.architectury.event.Event;
import me.shedaniel.architectury.event.EventFactory;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.world.level.chunk.ChunkAccess;
import net.minecraft.world.level.chunk.ProtoChunk;
import org.jetbrains.annotations.Nullable;
public interface ChunkEvent {
/**
* @see SaveData#save(ChunkAccess, ServerLevel, CompoundTag)
*/
Event<SaveData> SAVE_DATA = EventFactory.createLoop();
/**
* @see LoadData#load(ChunkAccess, ServerLevel, CompoundTag)
*/
Event<LoadData> LOAD_DATA = EventFactory.createLoop();
interface SaveData {
/**
* Invoked when a chunk's data is saved, just before the data is written.
* Add your own data to the {@link CompoundTag} parameter to get your data saved as well.
* Equivalent to Forge's {@code ChunkDataEvent.Save}.
*
* @param chunk The chunk that is saved.
* @param level The level the chunk is in.
* @param nbt The chunk data that is written to the save file.
*/
void save(ChunkAccess chunk, ServerLevel level, CompoundTag nbt);
}
interface LoadData {
/**
* Invoked just before a chunk's data is fully read.
* You can read out your own data from the {@link CompoundTag} parameter, when you have saved one before.
* Equivalent to Forge's {@code ChunkDataEvent.Load}.
*
* @param chunk The chunk that is loaded.
* @param level The level the chunk is in, may be {@code null}.
* @param nbt The chunk data that was read from the save file.
*/
void load(ChunkAccess chunk, @Nullable ServerLevel level, CompoundTag nbt);
}
}