team.unnamed.creative.overlay

Interface ResourceContainer

All Known Subinterfaces:

Overlay, ResourcePack

All Known Implementing Classes:

ResourceContainerImpl

@ApiStatus.NonExtendable
public interface ResourceContainer

Method Summary

Modifier and Type	Method and Description
void	atlas(@NotNull Atlas atlas) Adds/updates an atlas to this resource container.
@Nullable Atlas	atlas(@NotNull net.kyori.adventure.key.Key key) Gets the atlas with the given key.
@NotNull java.util.Collection<Atlas>	atlases() Gets all the atlases in this resource container.
void	blockState(@NotNull BlockState state) Adds/updates a block state to this resource container.
@Nullable BlockState	blockState(@NotNull net.kyori.adventure.key.Key key) Gets the block state with the given key.
@NotNull java.util.Collection<BlockState>	blockStates() Gets all the block states in this resource container.
void	font(@NotNull Font font) Adds/updates a font to this resource container.
@Nullable Font	font(@NotNull net.kyori.adventure.key.Key key) Gets the font with the given key.
default void	font(@NotNull net.kyori.adventure.key.Key key, FontProvider... providers) Adds/updates a font to this resource container.
default void	font(@NotNull net.kyori.adventure.key.Key key, @NotNull java.util.List<FontProvider> providers) Adds/updates a font to this resource container.
@NotNull java.util.Collection<Font>	fonts() Gets all the fonts in this resource container.
@Nullable Language	language(@NotNull net.kyori.adventure.key.Key key) Gets the language with the given key.
void	language(@NotNull Language language) Adds/updates a language to this resource container.
@NotNull java.util.Collection<Language>	languages() Gets all the languages in this resource container.
void	merge(@NotNull ResourceContainer other, @NotNull MergeStrategy strategy) Merges the given other resource container with this resource container.
@Nullable Model	model(@NotNull net.kyori.adventure.key.Key key) Gets the model with the given key.
void	model(@NotNull Model model) Adds/updates a model to this resource container.
@NotNull java.util.Collection<Model>	models() Gets all the models in this resource container.
default void	part(@NotNull ResourcePackPart part) Adds the given resource pack part to this resource container.
boolean	removeAtlas(@NotNull net.kyori.adventure.key.Key key) Removes the atlas with the given key.
boolean	removeBlockState(@NotNull net.kyori.adventure.key.Key key) Removes the block state with the given key.
boolean	removeFont(@NotNull net.kyori.adventure.key.Key key) Removes the font with the given key.
boolean	removeLanguage(@NotNull net.kyori.adventure.key.Key key) Removes the language with the given key.
boolean	removeModel(@NotNull net.kyori.adventure.key.Key key) Removes the model with the given key.
boolean	removeSound(@NotNull net.kyori.adventure.key.Key key) Removes the sound with the given key.
default boolean	removeSoundEvent(@NotNull net.kyori.adventure.key.Key key) Removes the sound event with the given key.
boolean	removeSoundRegistry(@NotNull java.lang.String namespace) Removes the sound registry with the given namespace.
boolean	removeTexture(@NotNull net.kyori.adventure.key.Key key) Removes the texture with the given key.
boolean	removeUnknownFile(@NotNull java.lang.String path) Removes the unknown file with the given path.
@Nullable Sound	sound(@NotNull net.kyori.adventure.key.Key key) Gets the sound with the given key.
default void	sound(@NotNull net.kyori.adventure.key.Key key, @NotNull Writable data) Adds/updates a sound to this resource container.
void	sound(@NotNull Sound sound) Adds/updates a sound to this resource container.
default @Nullable SoundEvent	soundEvent(@NotNull net.kyori.adventure.key.Key key) Gets the sound event with the given key.
default void	soundEvent(@NotNull SoundEvent soundEvent) Adds/updates a sound event to this resource container.
default @NotNull java.util.Collection<SoundEvent>	soundEvents() Gets all the sound events in this resource container.
@NotNull java.util.Collection<SoundRegistry>	soundRegistries() Gets all the sound registries in this resource container.
void	soundRegistry(@NotNull SoundRegistry soundRegistry) Adds/updates a sound registry to this resource container.
@Nullable SoundRegistry	soundRegistry(@NotNull java.lang.String namespace) Gets the sound registry with the given namespace.
@NotNull java.util.Collection<Sound>	sounds() Gets all the sounds in this resource container.
@Nullable Texture	texture(@NotNull net.kyori.adventure.key.Key key) Gets the texture with the given key.
default void	texture(@NotNull net.kyori.adventure.key.Key key, @NotNull Writable data) Adds/updates a texture to this resource container.
default void	texture(@NotNull net.kyori.adventure.key.Key key, @NotNull Writable data, @NotNull Metadata meta) Adds/updates a texture to this resource container.
void	texture(@NotNull Texture texture) Adds/updates a texture to this resource container.
@NotNull java.util.Collection<Texture>	textures() Gets all the textures in this resource container.
@Nullable Writable	unknownFile(@NotNull java.lang.String path) Gets the unknown file with the given path.
void	unknownFile(@NotNull java.lang.String path, @NotNull Writable data) Adds/updates an unknown file to this resource container.
@NotNull java.util.Map<java.lang.String,Writable>	unknownFiles() Gets all the unknown files in this resource container.

Method Detail

atlas

void atlas(@NotNull
           @NotNull Atlas atlas)

Adds/updates an atlas to this resource container.

Note that there can't be two atlases with the same key, so if there was an atlas with the same key as the new given atlas, it will be replaced by the given one.

Parameters:

atlas - The atlas to add/update

Since:

1.0.0

atlas

@Nullable
@Nullable Atlas atlas(@NotNull
                                 @NotNull net.kyori.adventure.key.Key key)

Gets the atlas with the given key.

Parameters:

key - The atlas key

Returns:

The atlas, null if not found

Since:

1.0.0

removeAtlas

boolean removeAtlas(@NotNull
                    @NotNull net.kyori.adventure.key.Key key)

Removes the atlas with the given key.

Parameters:

key - The atlas key

Returns:

True if the atlas existed and was removed, false otherwise

Since:

1.3.0

atlases

@NotNull
@NotNull java.util.Collection<Atlas> atlases()

Gets all the atlases in this resource container.

Returns:

The atlases

Since:

1.0.0

blockState

void blockState(@NotNull
                @NotNull BlockState state)

Adds/updates a block state to this resource container.

Note that there can't be two block states with the same key, so if there was a block state with the same key as the new given block state, it will be replaced by the given one.

Parameters:

state - The block state to add/update

Since:

1.0.0

blockState

@Nullable
@Nullable BlockState blockState(@NotNull
                                           @NotNull net.kyori.adventure.key.Key key)

Gets the block state with the given key.

Parameters:

key - The block state key

Returns:

The block state, null if not found

Since:

1.0.0

removeBlockState

boolean removeBlockState(@NotNull
                         @NotNull net.kyori.adventure.key.Key key)

Removes the block state with the given key.

Parameters:

key - The block state key

Returns:

True if the block state existed and was removed, false otherwise

Since:

1.3.0

blockStates

@NotNull
@NotNull java.util.Collection<BlockState> blockStates()

Gets all the block states in this resource container.

Returns:

The block states

Since:

1.0.0

font

void font(@NotNull
          @NotNull Font font)

Adds/updates a font to this resource container.

Note that there can't be two fonts with the same key, so if there was a font with the same key as the new given font, it will be replaced by the given one.

Parameters:

font - The font to add/update

Since:

1.0.0

font

@Nullable
@Nullable Font font(@NotNull
                               @NotNull net.kyori.adventure.key.Key key)

Gets the font with the given key.

Parameters:

key - The font key

Returns:

The font, null if not found

Since:

1.0.0

removeFont

boolean removeFont(@NotNull
                   @NotNull net.kyori.adventure.key.Key key)

Removes the font with the given key.

Parameters:

key - The font key

Returns:

True if the font existed and was removed, false otherwise

Since:

1.3.0

fonts

@NotNull
@NotNull java.util.Collection<Font> fonts()

Gets all the fonts in this resource container.

Returns:

The fonts

Since:

1.0.0

font

default void font(@NotNull
                  @NotNull net.kyori.adventure.key.Key key,
                  @NotNull
                  FontProvider... providers)

Adds/updates a font to this resource container.

Note that there can't be two fonts with the same key, so if there was a font with the same key as the new given font, it will be replaced by the given one.

Parameters:

key - The font key

providers - The font providers

Since:

1.0.0

font

default void font(@NotNull
                  @NotNull net.kyori.adventure.key.Key key,
                  @NotNull
                  @NotNull java.util.List<FontProvider> providers)

Adds/updates a font to this resource container.

Note that there can't be two fonts with the same key, so if there was a font with the same key as the new given font, it will be replaced by the given one.

Parameters:

key - The font key

providers - The font providers

Since:

1.0.0

language

void language(@NotNull
              @NotNull Language language)

Adds/updates a language to this resource container.

Note that there can't be two languages with the same key, so if there was a language with the same key as the new given language, it will be replaced by the given one.

Parameters:

language - The language to add/update

Since:

1.0.0

language

@Nullable
@Nullable Language language(@NotNull
                                       @NotNull net.kyori.adventure.key.Key key)

Gets the language with the given key.

Parameters:

key - The language key

Returns:

The language, null if not found

Since:

1.0.0

removeLanguage

boolean removeLanguage(@NotNull
                       @NotNull net.kyori.adventure.key.Key key)

Removes the language with the given key.

Parameters:

key - The language key

Returns:

True if the language existed and was removed, false otherwise

Since:

1.3.0

languages

@NotNull
@NotNull java.util.Collection<Language> languages()

Gets all the languages in this resource container.

Returns:

The languages

Since:

1.0.0

model

void model(@NotNull
           @NotNull Model model)

Adds/updates a model to this resource container.

Note that there can't be two models with the same key, so if there was a model with the same key as the new given model, it will be replaced by the given one.

Parameters:

model - The model to add/update

Since:

1.0.0

model

@Nullable
@Nullable Model model(@NotNull
                                 @NotNull net.kyori.adventure.key.Key key)

Gets the model with the given key.

Parameters:

key - The model key

Returns:

The model, null if not found

Since:

1.0.0

removeModel

boolean removeModel(@NotNull
                    @NotNull net.kyori.adventure.key.Key key)

Removes the model with the given key.

Parameters:

key - The model key

Returns:

True if the model existed and was removed, false otherwise

Since:

1.3.0

models

@NotNull
@NotNull java.util.Collection<Model> models()

Gets all the models in this resource container.

Returns:

The models

Since:

1.0.0

soundRegistry

void soundRegistry(@NotNull
                   @NotNull SoundRegistry soundRegistry)

Adds/updates a sound registry to this resource container.

Note that there can't be two sound registries with the same namespace, so if there was a sound registry with the same namespace as the new given sound registry, it will be replaced by the given one.

Parameters:

soundRegistry - The sound registry to add/update

Since:

1.0.0

soundRegistry

@Nullable
@Nullable SoundRegistry soundRegistry(@NotNull
                                                 @NotNull java.lang.String namespace)

Gets the sound registry with the given namespace.

Parameters:

namespace - The sound registry namespace

Returns:

The sound registry, null if not found

Since:

1.0.0

removeSoundRegistry

boolean removeSoundRegistry(@NotNull
                            @NotNull java.lang.String namespace)

Removes the sound registry with the given namespace.

Parameters:

namespace - The sound registry namespace

Returns:

True if the sound registry existed and was removed, false otherwise

Since:

1.3.0

soundRegistries

@NotNull
@NotNull java.util.Collection<SoundRegistry> soundRegistries()

Gets all the sound registries in this resource container.

Returns:

The sound registries

Since:

1.0.0

soundEvent

default void soundEvent(@NotNull
                        @NotNull SoundEvent soundEvent)

Adds/updates a sound event to this resource container.

Note that there can't be two sound events with the same key, so if there was a sound event with the same key as the new given sound event, it will be replaced by the given one.

Parameters:

soundEvent - The sound event to add/update

Since:

1.0.0

soundEvent

@Nullable
default @Nullable SoundEvent soundEvent(@NotNull
                                                   @NotNull net.kyori.adventure.key.Key key)

Gets the sound event with the given key.

Parameters:

key - The sound event key

Returns:

The sound event, null if not found

Since:

1.0.0

removeSoundEvent

default boolean removeSoundEvent(@NotNull
                                 @NotNull net.kyori.adventure.key.Key key)

Removes the sound event with the given key.

Parameters:

key - The sound event key

Returns:

True if the sound event existed and was removed, false otherwise

Since:

1.3.0

soundEvents

@NotNull
default @NotNull java.util.Collection<SoundEvent> soundEvents()

Gets all the sound events in this resource container.

Returns:

The sound events

Since:

1.0.0

sound

void sound(@NotNull
           @NotNull Sound sound)

Adds/updates a sound to this resource container.

Note that there can't be two sounds with the same key, so if there was a sound with the same key as the new given sound, it will be replaced by the given one.

Parameters:

sound - The sound to add/update

Since:

1.0.0

sound

@Nullable
@Nullable Sound sound(@NotNull
                                 @NotNull net.kyori.adventure.key.Key key)

Gets the sound with the given key.

Parameters:

key - The sound key

Returns:

The sound, null if not found

Since:

1.0.0

removeSound

boolean removeSound(@NotNull
                    @NotNull net.kyori.adventure.key.Key key)

Removes the sound with the given key.

Parameters:

key - The sound key

Returns:

True if the sound existed and was removed, false otherwise

Since:

1.3.0

sounds

@NotNull
@NotNull java.util.Collection<Sound> sounds()

Gets all the sounds in this resource container.

Returns:

The sounds

Since:

1.0.0

sound

default void sound(@NotNull
                   @NotNull net.kyori.adventure.key.Key key,
                   @NotNull
                   @NotNull Writable data)

Adds/updates a sound to this resource container.

Note that there can't be two sounds with the same key, so if there was a sound with the same key as the new given sound, it will be replaced by the given one.

Parameters:

key - The sound key

data - The sound data

Since:

1.0.0

texture

void texture(@NotNull
             @NotNull Texture texture)

Adds/updates a texture to this resource container.

Note that there can't be two textures with the same key, so if there was a texture with the same key as the new given texture, it will be replaced by the given one.

Parameters:

texture - The texture to add/update

Since:

1.0.0

texture

@Nullable
@Nullable Texture texture(@NotNull
                                     @NotNull net.kyori.adventure.key.Key key)

Gets the texture with the given key.

Parameters:

key - The texture key

Returns:

The texture, null if not found

Since:

1.0.0

removeTexture

boolean removeTexture(@NotNull
                      @NotNull net.kyori.adventure.key.Key key)

Removes the texture with the given key.

Parameters:

key - The texture key

Returns:

True if the texture existed and was removed, false otherwise

Since:

1.3.0

textures

@NotNull
@NotNull java.util.Collection<Texture> textures()

Gets all the textures in this resource container.

Returns:

The textures

Since:

1.0.0

texture

default void texture(@NotNull
                     @NotNull net.kyori.adventure.key.Key key,
                     @NotNull
                     @NotNull Writable data)

Adds/updates a texture to this resource container.

Note that there can't be two textures with the same key, so if there was a texture with the same key as the new given texture, it will be replaced by the given one.

Parameters:

key - The texture key

data - The texture data

Since:

1.0.0

texture

default void texture(@NotNull
                     @NotNull net.kyori.adventure.key.Key key,
                     @NotNull
                     @NotNull Writable data,
                     @NotNull
                     @NotNull Metadata meta)

Adds/updates a texture to this resource container.

Note that there can't be two textures with the same key, so if there was a texture with the same key as the new given texture, it will be replaced by the given one.

Parameters:

key - The texture key

data - The texture data

meta - The texture metadata

Since:

1.0.0

part

default void part(@NotNull
                  @NotNull ResourcePackPart part)

Adds the given resource pack part to this resource container.

Parameters:

part - The resource pack part

Since:

1.1.0

unknownFile

void unknownFile(@NotNull
                 @NotNull java.lang.String path,
                 @NotNull
                 @NotNull Writable data)

Adds/updates an unknown file to this resource container.

Note that there can't be two unknown files with the same path, so if there was an unknown file with the same path as the new given unknown file, it will be replaced by the given one.

Parameters:

path - The unknown file path

data - The unknown file data

Since:

1.0.0

unknownFile

@Nullable
@Nullable Writable unknownFile(@NotNull
                                          @NotNull java.lang.String path)

Gets the unknown file with the given path.

Parameters:

path - The unknown file path

Returns:

The unknown file, null if not found

Since:

1.0.0

removeUnknownFile

boolean removeUnknownFile(@NotNull
                          @NotNull java.lang.String path)

Removes the unknown file with the given path.

Parameters:

path - The unknown file path

Returns:

True if the unknown file existed and was removed, false otherwise

Since:

1.3.0

unknownFiles

@NotNull
@NotNull java.util.Map<java.lang.String,Writable> unknownFiles()

Gets all the unknown files in this resource container.

Returns:

The unknown files

Since:

1.0.0

merge

void merge(@NotNull
           @NotNull ResourceContainer other,
           @NotNull
           @NotNull MergeStrategy strategy)

Merges the given other resource container with this resource container.

Parameters:

other - The other resource container

strategy - The merge strategy

Throws:

MergeException - If the merge fails

Since:

1.4.0