Package org.bukkit.block
Interface Banner
- All Superinterfaces:
BlockState
,Metadatable
,PersistentDataHolder
,TileState
public interface Banner extends TileState
Represents a captured state of a banner.
-
Method Summary
Modifier and Type Method Description void
addPattern(Pattern pattern)
Adds a new pattern on top of the existing patternsDyeColor
getBaseColor()
Returns the base color for this bannerPattern
getPattern(int i)
Returns the pattern at the specified indexList<Pattern>
getPatterns()
Returns a list of patterns on this bannerint
numberOfPatterns()
Returns the number of patterns on this bannerPattern
removePattern(int i)
Removes the pattern at the specified indexvoid
setBaseColor(DyeColor color)
Sets the base color for this banner.void
setPattern(int i, Pattern pattern)
Sets the pattern at the specified indexvoid
setPatterns(List<Pattern> patterns)
Sets the patterns used on this bannerMethods inherited from interface org.bukkit.block.BlockState
getBlock, getBlockData, getChunk, getData, getLightLevel, getLocation, getLocation, getRawData, getType, getWorld, getX, getY, getZ, isPlaced, setBlockData, setData, setRawData, setType, update, update, update
Methods inherited from interface org.bukkit.metadata.Metadatable
getMetadata, hasMetadata, removeMetadata, setMetadata
-
Method Details
-
getBaseColor
Returns the base color for this banner- Returns:
- the base color
-
setBaseColor
Sets the base color for this banner. Only valid for shield pseudo banners, otherwise base depends on block type- Parameters:
color
- the base color
-
getPatterns
Returns a list of patterns on this banner- Returns:
- the patterns
-
setPatterns
Sets the patterns used on this banner- Parameters:
patterns
- the new list of patterns
-
addPattern
Adds a new pattern on top of the existing patterns- Parameters:
pattern
- the new pattern to add
-
getPattern
Returns the pattern at the specified index- Parameters:
i
- the index- Returns:
- the pattern
-
removePattern
Removes the pattern at the specified index- Parameters:
i
- the index- Returns:
- the removed pattern
-
setPattern
Sets the pattern at the specified index- Parameters:
i
- the indexpattern
- the new pattern
-
numberOfPatterns
int numberOfPatterns()Returns the number of patterns on this banner- Returns:
- the number of patterns
-