StackedObject

All Known Subinterfaces:

AsyncStackedObject<T>, StackedBarrel, StackedEntity, StackedItem, StackedSpawner
```
public interface StackedObject<T>
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`canStackInto(StackedObject stackedObject)` Deprecated. See runStackCheck
`org.bukkit.Location`	`getLocation()` Get the location of the object.
`int`	`getMergeRadius()` Get the merge radius of the object.
`int`	`getStackAmount()` Get the stack amount
`int`	`getStackLimit()` Get the stack limit
`org.bukkit.World`	`getWorld()` Get the world of the object.
`boolean`	`isBlacklisted()` Checks if an object is blacklisted.
`boolean`	`isCached()` Whether or not the object is cached.
`boolean`	`isSimilar(StackedObject stackedObject)` Checks if this object is similar to another object.
`boolean`	`isWhitelisted()` Checks if an object is whitelisted.
`boolean`	`isWorldDisabled()` Checks if the world of the object is disabled.
`void`	`remove()` Remove the stack object from cache and the server
`java.util.Optional<T>`	`runStack()` Stack this object into other objects around it.
`StackResult`	`runStack(StackedObject stackedObject)` Stack this object into another object. !
`void`	`runStackAsync(java.util.function.Consumer<java.util.Optional<T>> result)` Deprecated. This object is not async. The async methods were moved to AsyncStackedObject. You can use runStack() as a replacement.
`StackCheckResult`	`runStackCheck(StackedObject stackedObject)` Checks if this object can stack into another object.
`UnstackResult`	`runUnstack(int amount)` Unstack this object.
`UnstackResult`	`runUnstack(int amount, org.bukkit.entity.Entity entity)` Unstack this object.
`void`	`setStackAmount(int stackAmount, boolean updateName)` Update the stack amount
`void`	`spawnStackParticle(boolean checkEnabled)` Spawn the stacking particle of the object.
`T`	`tryStack()` Deprecated. See runStackAsync(Consumer)
`boolean`	`tryStackInto(StackedObject stackedObject)` Deprecated. See runStackAsync(StackedObject, Consumer)
`boolean`	`tryUnstack(int amount)` Deprecated. See runUnstack
`void`	`updateName()` Update the name of the object.

- Method Detail
  - getLocation
```
org.bukkit.Location getLocation()
```
    Get the location of the object.
  - getWorld
```
org.bukkit.World getWorld()
```
    Get the world of the object.
  - getStackAmount
```
int getStackAmount()
```
    Get the stack amount
    
    Returns:
    
    stack amount
  - setStackAmount
```
void setStackAmount(int stackAmount,
                    boolean updateName)
```
    Update the stack amount
    
    Parameters:
    
    stackAmount - a new stack amount
    
    updateName - should the name of the object get updated or not
  - getStackLimit
```
int getStackLimit()
```
    Get the stack limit
    
    Returns:
    
    stack limit
  - getMergeRadius
```
int getMergeRadius()
```
    Get the merge radius of the object.
    
    Returns:
    
    merge radius
  - isBlacklisted
```
boolean isBlacklisted()
```
    Checks if an object is blacklisted.
    
    Returns:
    
    True if the object is blacklisted, otherwise false.
  - isWhitelisted
```
boolean isWhitelisted()
```
    Checks if an object is whitelisted.
    
    Returns:
    
    True if the object is whitelisted, otherwise false.
  - isWorldDisabled
```
boolean isWorldDisabled()
```
    Checks if the world of the object is disabled.
    
    Returns:
    
    True if the world is disabled, otherwise false.
  - isCached
```
boolean isCached()
```
    Whether or not the object is cached. The object will be cached if: 1) The system of stacking is not disabled in the config 2) The object is not blacklisted. 3) The object is whitelisted. 4) The object is not in a disabled world.
  - remove
```
void remove()
```
    Remove the stack object from cache and the server
  - updateName
```
void updateName()
```
    Update the name of the object.
  - canStackInto
```
@Deprecated
boolean canStackInto(StackedObject stackedObject)
```
    Deprecated. See runStackCheck
    
    Checks if this object can stack into another object.
    
    Parameters:
    
    stackedObject - other object to check
  - runStackCheck
```
StackCheckResult runStackCheck(StackedObject stackedObject)
```
    Checks if this object can stack into another object.
    
    Parameters:
    
    stackedObject - other object to check
    
    Returns:
    
    The result for the operation.
  - runStackAsync
```
@Deprecated
void runStackAsync(java.util.function.Consumer<java.util.Optional<T>> result)
```
    Deprecated. This object is not async. The async methods were moved to AsyncStackedObject. You can use runStack() as a replacement.
    
    Stack this object into other objects around it.
    
    Parameters:
    
    result - The object that this object was stacked into.
  - runStack
```
java.util.Optional<T> runStack()
```
    Stack this object into other objects around it.
  - tryStack
```
@Deprecated
T tryStack()
```
    Deprecated. See runStackAsync(Consumer)
    
    Stack this object into other objects around it.
    
    Returns:
    
    The object that this object was stacked into (nullable)
  - runStack
```
StackResult runStack(StackedObject stackedObject)
```
    Stack this object into another object. !Usage of this method can cause issues!
    
    Parameters:
    
    stackedObject - another object to stack into
    
    Returns:
    
    The result for the stacking operation.
  - tryStackInto
```
@Deprecated
boolean tryStackInto(StackedObject stackedObject)
```
    Deprecated. See runStackAsync(StackedObject, Consumer)
    
    Stack this object into another object.
    
    Parameters:
    
    stackedObject - another object to stack into
    
    Returns:
    
    True if success, otherwise false.
  - runUnstack
```
UnstackResult runUnstack(int amount)
```
    Unstack this object.
    
    Parameters:
    
    amount - unstack by this amount
    
    Returns:
    
    The result for the unstacking operation.
  - runUnstack
```
UnstackResult runUnstack(int amount,
                         org.bukkit.entity.Entity entity)
```
    Unstack this object.
    
    Parameters:
    
    amount - unstack by this amount
    
    entity - The entity that caused the unstack of the object.
    
    Returns:
    
    The result for the unstacking operation.
  - tryUnstack
```
@Deprecated
boolean tryUnstack(int amount)
```
    Deprecated. See runUnstack
    
    Unstack this object.
    
    Parameters:
    
    amount - unstack by this amount
    
    Returns:
    
    True if success, otherwise false.
  - isSimilar
```
boolean isSimilar(StackedObject stackedObject)
```
    Checks if this object is similar to another object.
    
    Parameters:
    
    stackedObject - the object to check
    
    Returns:
    
    True if they are similar objects, otherwise false
  - spawnStackParticle
```
void spawnStackParticle(boolean checkEnabled)
```
    Spawn the stacking particle of the object.
    
    Parameters:
    
    checkEnabled - When true, the particle will be spawned only if enabled in the config.

Interface StackedObject<T>

Method Summary

Method Detail

getLocation

getWorld

getStackAmount

setStackAmount

getStackLimit

getMergeRadius

isBlacklisted

isWhitelisted

isWorldDisabled

isCached

remove

updateName

canStackInto

runStackCheck

runStackAsync

runStack

tryStack

runStack

tryStackInto

runUnstack

runUnstack

tryUnstack

isSimilar

spawnStackParticle