[ci skip] Introduce EntitySpawnExtension (#160)

* Introduce EntitySpawnExtension

* Add to mixins

* Update common/src/main/java/dev/architectury/extensions/network/EntitySpawnExtension.java

* Update common/src/main/java/dev/architectury/networking/NetworkManager.java

Co-authored-by: Juuxel <6596629+Juuxel@users.noreply.github.com>
This commit is contained in:
shedaniel
2022-01-01 05:35:40 +08:00
committed by GitHub
parent b61045bc0e
commit 6a6cad7025
5 changed files with 82 additions and 0 deletions

View File

@@ -0,0 +1,33 @@
/*
* 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 dev.architectury.extensions.network;
import net.minecraft.network.FriendlyByteBuf;
import net.minecraft.world.entity.Entity;
/**
* This interface can be implemented on {@linkplain Entity entities} to attach additional spawn data to packets sent to client.
* This is used in conjunction with {@link dev.architectury.networking.NetworkManager#createAddEntityPacket(Entity)}
*/
public interface EntitySpawnExtension {
void saveAdditionalSpawnData(FriendlyByteBuf buf);
void loadAdditionalSpawnData(FriendlyByteBuf buf);
}

View File

@@ -98,6 +98,9 @@ public final class NetworkManager {
* Easy to use utility method to create an entity spawn packet.
* This packet is needed everytime any mod adds a non-living entity.
* The entity should override {@link Entity#getAddEntityPacket()} to point to this method!
* <p>
* Additionally, entities may implement {@link dev.architectury.extensions.network.EntitySpawnExtension}
* to load / save additional data to the client.
*
* @param entity The entity which should be spawned.
* @return The ready to use packet to spawn the entity on the client.