Structure (Bukkit 1.12.2-R0.1-SNAPSHOT API 中文文档)

所有超级接口:

BlockState, Metadatable
```
public interface Structure
extends BlockState
```
Represents a structure block that can save and load blocks from a file. They can only be used by OPs, and are not obtainable in survival.

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`java.lang.String`	`getAuthor()` Get the name of who created this structure.
`float`	`getIntegrity()` Get the integrity of this structure.
`java.lang.String`	`getMetadata()` Get the metadata function this structure block will perform when activated.
`Mirror`	`getMirror()` How this structure is mirrored.
`BlockVector`	`getRelativePosition()` The relative position of the structure outline based on the position of the structure block.
`StructureRotation`	`getRotation()` Get how this structure is rotated.
`long`	`getSeed()` The seed used to determine how many blocks are removed upon loading of this structure.
`java.lang.String`	`getStructureName()` The name of this structure.
`BlockVector`	`getStructureSize()` The distance to the opposite corner of this structure.
`UsageMode`	`getUsageMode()` Get the `UsageMode` of this structure block.
`boolean`	`isBoundingBoxVisible()` Get if this structure block is currently showing the bounding box.
`boolean`	`isIgnoreEntities()` Get if this structure block should ignore entities.
`boolean`	`isShowAir()` Check if this structure block is currently showing all air blocks
`void`	`setAuthor(LivingEntity livingEntity)` Set the name of whoever created this structure using a `LivingEntity`.
`void`	`setAuthor(java.lang.String author)` Set the name of whoever created this structure.
`void`	`setBoundingBoxVisible(boolean showBoundingBox)` Set if this structure box should show the bounding box.
`void`	`setIgnoreEntities(boolean ignoreEntities)` While in `UsageMode.SAVE` mode, this will ignore any entities when saving the structure.
`void`	`setIntegrity(float integrity)` Set the integrity of the structure.
`void`	`setMetadata(java.lang.String metadata)` Only applicable while in `UsageMode.DATA`.
`void`	`setMirror(Mirror mirror)` Sets the mirroring of the structure.
`void`	`setRelativePosition(BlockVector vector)` Set the relative position from the structure block.
`void`	`setRotation(StructureRotation rotation)` Set how this structure is rotated.
`void`	`setSeed(long seed)` The seed used to determine which blocks will be removed upon loading.
`void`	`setShowAir(boolean showAir)` Set if the structure outline should show air blocks.
`void`	`setStructureName(java.lang.String name)` Set the name of this structure.
`void`	`setStructureSize(BlockVector vector)` Set the maximum size of this structure from the origin point.
`void`	`setUsageMode(UsageMode mode)` Set the `UsageMode` of this structure block.

从接口继承的方法 org.bukkit.block.BlockState
getBlock, getChunk, getData, getLightLevel, getLocation, getLocation, getRawData, getType, getTypeId, getWorld, getX, getY, getZ, isPlaced, setData, setRawData, setType, setTypeId, update, update, update

从接口继承的方法 org.bukkit.metadata.Metadatable
getMetadata, hasMetadata, removeMetadata, setMetadata

- 方法详细资料
  - getStructureName
```
java.lang.String getStructureName()
```
    The name of this structure.
    
    返回:
    
    structure name
  - setStructureName
```
void setStructureName(java.lang.String name)
```
    Set the name of this structure. This is case-sensitive. The name of the structure in the UsageMode.SAVE structure block MUST match the name within the UsageMode.CORNER block or the size calculation will fail.
    
    参数:
    
    name - the case-sensitive name of this structure
  - getAuthor
```
java.lang.String getAuthor()
```
    Get the name of who created this structure.
    
    返回:
    
    the name of whoever created this structure.
  - setAuthor
```
void setAuthor(java.lang.String author)
```
    Set the name of whoever created this structure.
    
    参数:
    
    author - whoever created this structure
  - setAuthor
```
void setAuthor(LivingEntity livingEntity)
```
    Set the name of whoever created this structure using a LivingEntity.
    
    参数:
    
    livingEntity - the entity who created this structure
  - getRelativePosition
```
BlockVector getRelativePosition()
```
    The relative position of the structure outline based on the position of the structure block. Maximum allowed distance is 32 blocks in any direction.
    
    返回:
    
    a Location which contains the relative distance this structure is from the structure block.
  - setRelativePosition
```
void setRelativePosition(BlockVector vector)
```
    Set the relative position from the structure block. Maximum allowed distance is 32 blocks in any direction.
    
    参数:
    
    vector - the BlockVector containing the relative origin coordinates of this structure.
  - getStructureSize
```
BlockVector getStructureSize()
```
    The distance to the opposite corner of this structure. The maximum structure size is 32x32x32. When a structure has successfully been calculated (i.e. it is within the maximum allowed distance) a white border surrounds the structure.
    
    返回:
    
    a BlockVector which contains the total size of the structure.
  - setStructureSize
```
void setStructureSize(BlockVector vector)
```
    Set the maximum size of this structure from the origin point. Maximum allowed size is 32x32x32.
    
    参数:
    
    vector - the BlockVector containing the size of this structure, based off of the origin coordinates.
  - setMirror
```
void setMirror(Mirror mirror)
```
    Sets the mirroring of the structure.
    
    参数:
    
    mirror - the new mirroring method
  - getMirror
```
Mirror getMirror()
```
    How this structure is mirrored.
    
    返回:
    
    the current mirroring method
  - setRotation
```
void setRotation(StructureRotation rotation)
```
    Set how this structure is rotated.
    
    参数:
    
    rotation - the new rotation
  - getRotation
```
StructureRotation getRotation()
```
    Get how this structure is rotated.
    
    返回:
    
    the new rotation
  - setUsageMode
```
void setUsageMode(UsageMode mode)
```
    Set the UsageMode of this structure block.
    
    参数:
    
    mode - the new mode to set.
  - getUsageMode
```
UsageMode getUsageMode()
```
    Get the UsageMode of this structure block.
    
    返回:
    
    the mode this block is currently in.
  - setIgnoreEntities
```
void setIgnoreEntities(boolean ignoreEntities)
```
    While in UsageMode.SAVE mode, this will ignore any entities when saving the structure.
    While in UsageMode.LOAD mode this will ignore any entities that were saved to file.
    
    参数:
    
    ignoreEntities - the flag to set
  - isIgnoreEntities
```
boolean isIgnoreEntities()
```
    Get if this structure block should ignore entities.
    
    返回:
    
    true if the appropriate UsageMode should ignore entities.
  - setShowAir
```
void setShowAir(boolean showAir)
```
    Set if the structure outline should show air blocks.
    
    参数:
    
    showAir - if the structure block should show air blocks
  - isShowAir
```
boolean isShowAir()
```
    Check if this structure block is currently showing all air blocks
    
    返回:
    
    true if the structure block is showing all air blocks
  - setBoundingBoxVisible
```
void setBoundingBoxVisible(boolean showBoundingBox)
```
    Set if this structure box should show the bounding box.
    
    参数:
    
    showBoundingBox - if the structure box should be shown
  - isBoundingBoxVisible
```
boolean isBoundingBoxVisible()
```
    Get if this structure block is currently showing the bounding box.
    
    返回:
    
    true if the bounding box is shown
  - setIntegrity
```
void setIntegrity(float integrity)
```
    Set the integrity of the structure. Integrity must be between 0.0 and 1.0 Lower integrity values will result in more blocks being removed when loading a structure. Integrity and getSeed() are used together to determine which blocks are randomly removed to mimic "decay."
    
    参数:
    
    integrity - the integrity of this structure
  - getIntegrity
```
float getIntegrity()
```
    Get the integrity of this structure.
    
    返回:
    
    the integrity of this structure
  - setSeed
```
void setSeed(long seed)
```
    The seed used to determine which blocks will be removed upon loading. getIntegrity() and seed are used together to determine which blocks are randomly removed to mimic "decay."
    
    参数:
    
    seed - the seed used to determine how many blocks will be removed
  - getSeed
```
long getSeed()
```
    The seed used to determine how many blocks are removed upon loading of this structure.
    
    返回:
    
    the seed used
  - setMetadata
```
void setMetadata(java.lang.String metadata)
```
    Only applicable while in UsageMode.DATA. Metadata are specific functions that can be applied to the structure location. Consult the Minecraft wiki for more information.
    
    参数:
    
    metadata - the function to perform on the selected location
  - getMetadata
```
java.lang.String getMetadata()
```
    Get the metadata function this structure block will perform when activated. Consult the Minecraft Wiki for more information.
    
    返回:
    
    the function that will be performed when this block is activated

接口 Structure

方法概要

从接口继承的方法 org.bukkit.block.BlockState

从接口继承的方法 org.bukkit.metadata.Metadatable

方法详细资料

getStructureName

setStructureName

getAuthor

setAuthor

setAuthor

getRelativePosition

setRelativePosition

getStructureSize

setStructureSize

setMirror

getMirror

setRotation

getRotation

setUsageMode

getUsageMode

setIgnoreEntities

isIgnoreEntities

setShowAir

isShowAir

setBoundingBoxVisible

isBoundingBoxVisible

setIntegrity

getIntegrity

setSeed

getSeed

setMetadata

getMetadata