com.github.lazoyoung.craftgames.api.module

Interface ItemModule

public ItemModule

Constructor Detail

ItemModule

public ItemModule()

Method Detail

spawnItem

@Deprecated
void spawnItem(@NotNull
                            java.lang.String tag,
                            @NotNull
                            org.bukkit.inventory.ItemStack itemStack)

Deprecated.

Spawn a floating item.

Parameters:

tag - Name of the coordinate tag designating the spawnpoint.

itemStack - ItemStack which represents attribute of the item.

spawnItem

@NotNull
org.bukkit.entity.Item spawnItem(@NotNull
                                           org.bukkit.Location location,
                                           @NotNull
                                           org.bukkit.inventory.ItemStack item)

Spawn a floating item.

Parameters:

location - Location of spawnpoint.

item - ItemStack which represents attribute of the item.

Returns:

Item entity that is spawned.

Throws:

MapNotFound - is thrown if location indicates a world which is not loaded.

getItemTag

@Nullable
ItemTag getItemTag(@NotNull
                              java.lang.String name)

Get class ItemTag by searching for name.

One tag stores ItemStack information for one item. Tags are created via '/itag create' in editor mode.

See Also:

class ItemTag, name, ItemStack

getLootTable

@Nullable
org.bukkit.loot.LootTable getLootTable(@NotNull
                                                  java.lang.String key)

Find LootTable by the key.

ex) (game_dir)/datapack/loot_tables/test/loot.json -> test/loot

See Also:

LootTable, key

allowKit

void allowKit(boolean respawn)

Let the players select kit inside lobby.

Parameters:

respawn - True if players waiting for respawn should be able to select kit as well.

preventItemDrop

void preventItemDrop()

Prevent players from dropping items.

lockInventory

@Deprecated
void lockInventory()

Deprecated.

Lock inventory so that players won't be able to move items in it.

lockPlayerInventory

void lockPlayerInventory(@NotNull
                         int... slots)

Lock specific slots of the inventory.

Items in locked slots cannot be dropped, moved or dragged by the player.

See Also:

slots

setDefaultKit

void setDefaultKit(@Nullable
                   java.lang.String name)

Default kit is assigned to players who don't select anything.

To assign kit per team, see TeamModule.setKit

Parameters:

name - The name of kit. Pass null to assign nothing.

See Also:

TeamModule.setKit

selectKit

void selectKit(@Nullable
               java.lang.String name,
               @NotNull
               org.bukkit.entity.Player player)

Select the player's kit.

Upon death, player's state is restored again with this kit. You can still use this function even if you disallow players to select one.

Parameters:

name - The kit name. (Pass null to de-select)

Throws:

IllegalArgumentException - is thrown if kit cannot be located or is not allowed for the player.

See Also:

player, allowKit

applyKit

void applyKit(@NotNull
              org.bukkit.entity.Player player)

Apply the selected kit to the player.

After clearing up the inventory, contents are supplied.

See Also:

player

saveKit

void saveKit(@NotNull
             java.lang.String name,
             @NotNull
             org.bukkit.entity.Player player)

Save kit with the given name. If there's an existing kit, this will overwrite it.

The Player's inventory and point effects are captured.

Parameters:

name - Name of the kit.

See Also:

name, Player