2021-03-23 11:51:40 +01:00
|
|
|
/*
|
|
|
|
* This file is part of ViaVersion - https://github.com/ViaVersion/ViaVersion
|
2024-01-12 10:01:48 +01:00
|
|
|
* Copyright (C) 2016-2024 ViaVersion and contributors
|
2021-03-23 11:51:40 +01:00
|
|
|
*
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
|
|
* in the Software without restriction, including without limitation the rights
|
|
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
|
|
* furnished to do so, subject to the following conditions:
|
|
|
|
*
|
|
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
|
|
* copies or substantial portions of the Software.
|
|
|
|
*
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
|
|
* SOFTWARE.
|
|
|
|
*/
|
2021-04-26 20:52:34 +02:00
|
|
|
package com.viaversion.viaversion.api.data;
|
2020-08-16 16:24:06 +02:00
|
|
|
|
2021-06-06 16:18:15 +02:00
|
|
|
import com.viaversion.viaversion.api.minecraft.RegistryType;
|
|
|
|
import com.viaversion.viaversion.api.minecraft.TagData;
|
|
|
|
import java.util.List;
|
2023-02-12 11:44:25 +01:00
|
|
|
import org.checkerframework.checker.nullness.qual.Nullable;
|
2021-06-06 16:18:15 +02:00
|
|
|
|
2021-04-27 13:25:18 +02:00
|
|
|
public interface MappingData {
|
2020-08-16 16:24:06 +02:00
|
|
|
|
2021-04-27 13:25:18 +02:00
|
|
|
/**
|
|
|
|
* Loads the mapping data.
|
|
|
|
*/
|
|
|
|
void load();
|
2020-09-21 09:53:04 +02:00
|
|
|
|
2021-04-27 13:25:18 +02:00
|
|
|
/**
|
|
|
|
* Returns the mapped block state id, or -1 if unmapped.
|
|
|
|
*
|
|
|
|
* @param id unmapped block state id
|
|
|
|
* @return mapped block state id, or -1 if unmapped
|
2021-04-28 12:59:37 +02:00
|
|
|
* @throws NullPointerException if this mappingdata does not hold block state mappings
|
2021-04-27 13:25:18 +02:00
|
|
|
*/
|
|
|
|
int getNewBlockStateId(int id);
|
2020-08-16 16:24:06 +02:00
|
|
|
|
2021-04-27 13:25:18 +02:00
|
|
|
/**
|
|
|
|
* Returns the mapped block id, or -1 if unmapped.
|
|
|
|
*
|
|
|
|
* @param id unmapped block id
|
|
|
|
* @return mapped block id, or -1 if unmapped
|
2021-04-28 12:59:37 +02:00
|
|
|
* @throws NullPointerException if this mappingdata does not hold block mappings
|
2021-04-27 13:25:18 +02:00
|
|
|
*/
|
|
|
|
int getNewBlockId(int id);
|
2020-08-16 16:24:06 +02:00
|
|
|
|
2021-04-27 13:25:18 +02:00
|
|
|
/**
|
|
|
|
* Returns the mapped item id, or -1 if unmapped.
|
|
|
|
*
|
|
|
|
* @param id unmapped item id
|
|
|
|
* @return mapped item id, or -1 if unmapped
|
2021-04-28 12:59:37 +02:00
|
|
|
* @throws NullPointerException if this mappingdata does not hold item mappings
|
2021-04-27 13:25:18 +02:00
|
|
|
*/
|
|
|
|
int getNewItemId(int id);
|
2020-08-16 16:24:06 +02:00
|
|
|
|
2021-04-27 13:25:18 +02:00
|
|
|
/**
|
|
|
|
* Returns the backwards mapped item id, or -1 if unmapped.
|
|
|
|
*
|
|
|
|
* @param id mapped item id
|
|
|
|
* @return backwards mapped item id, or -1 if unmapped
|
2021-04-28 12:59:37 +02:00
|
|
|
* @throws NullPointerException if this mappingdata does not hold item mappings
|
2021-04-27 13:25:18 +02:00
|
|
|
*/
|
|
|
|
int getOldItemId(int id);
|
2020-08-16 16:24:06 +02:00
|
|
|
|
2021-04-27 13:25:18 +02:00
|
|
|
/**
|
|
|
|
* Returns the mapped particle id, or -1 if unmapped.
|
|
|
|
*
|
|
|
|
* @param id unmapped particle id
|
|
|
|
* @return mapped particle id, or -1 if unmapped
|
2021-04-28 12:59:37 +02:00
|
|
|
* @throws NullPointerException if this mappingdata does not hold particle mappings
|
2021-04-27 13:25:18 +02:00
|
|
|
*/
|
|
|
|
int getNewParticleId(int id);
|
2020-08-16 16:24:06 +02:00
|
|
|
|
2021-06-06 16:18:15 +02:00
|
|
|
/**
|
|
|
|
* Returns a list of tags to send if present.
|
|
|
|
*
|
|
|
|
* @param type registry tag type
|
|
|
|
* @return list of tags to send if present, else null
|
|
|
|
*/
|
|
|
|
@Nullable List<TagData> getTags(RegistryType type);
|
|
|
|
|
2023-03-01 22:56:06 +01:00
|
|
|
@Nullable BiMappings getItemMappings();
|
2020-08-16 16:24:06 +02:00
|
|
|
|
2021-04-27 13:25:18 +02:00
|
|
|
@Nullable ParticleMappings getParticleMappings();
|
2020-08-16 16:24:06 +02:00
|
|
|
|
2021-04-27 13:25:18 +02:00
|
|
|
@Nullable Mappings getBlockMappings();
|
2020-08-16 16:24:06 +02:00
|
|
|
|
2021-09-16 00:26:23 +02:00
|
|
|
@Nullable Mappings getBlockEntityMappings();
|
|
|
|
|
2021-04-27 13:25:18 +02:00
|
|
|
@Nullable Mappings getBlockStateMappings();
|
2020-08-16 16:24:06 +02:00
|
|
|
|
2021-04-27 13:25:18 +02:00
|
|
|
@Nullable Mappings getSoundMappings();
|
2020-08-16 16:24:06 +02:00
|
|
|
|
2021-04-27 13:25:18 +02:00
|
|
|
@Nullable Mappings getStatisticsMappings();
|
2022-03-16 19:09:39 +01:00
|
|
|
|
2023-03-22 18:49:18 +01:00
|
|
|
@Nullable Mappings getMenuMappings();
|
|
|
|
|
2022-03-24 18:44:53 +01:00
|
|
|
@Nullable Mappings getEnchantmentMappings();
|
|
|
|
|
2022-04-01 16:54:07 +02:00
|
|
|
@Nullable FullMappings getEntityMappings();
|
|
|
|
|
|
|
|
@Nullable FullMappings getArgumentTypeMappings();
|
2022-04-20 19:42:43 +02:00
|
|
|
|
|
|
|
@Nullable Mappings getPaintingMappings();
|
2020-08-16 16:24:06 +02:00
|
|
|
}
|