BlockPermutation¶
文档版本:1.21.60.21
BlockPermutation类。代表方块的置换。
属性¶
type
type:BlockType- 该置换所包含的方块类型。
方法¶
getAllStates
获取该置换中包含的所有可用的方块状态。
- 返回值:
Record<string, boolean | int32 | string> - 一个记录了该置换所有可用方块状态的对象。
getItemStack
创建一个基于该方块置换的物品堆叠。
amount:int32=1∈[1,255]- 该物品堆叠所含物品的数量。
- 返回值:
ItemStack|undefined - 创建出的物品堆叠对象。
getState
获取该置换中一个指定的方块状态。
stateName:string- 要获取的状态的标识符。
- 返回值:
boolean|int32|string|undefined - 如果该置换含有这个状态,返回此状态的值,否则返回
undefined。
getTags
获取该置换对应方块所拥有的标签。
- 返回值:
string[] - 一个包含对应方块所有标签的数组。
hasTag
检查该置换对应方块是否拥有给定标签。
tag:string- 要检查的标签。
- 返回值:
boolean - 如果对应方块有这个标签,返回
true。
matches
测试该置换的内容是否与给定内容相同。若不传入方块状态,则只对方块类型进行测试。
blockName:string- 要测试的方块类型的名称。
states?:Record<string, boolean | int32 | string>=null- 要测试的方块状态。
- 返回值:
boolean - 如果该置换的内容与给定内容相同,返回
true。
resolve
根据方块名称和方块状态创建一个方块置换。
static resolve(blockName: string, states?: Record<string, boolean | int32 | string>): BlockPermutation
blockName:string- 置换中的方块类型的名称。
states?:Record<string, boolean | int32 | string>=null- 置换中的方块状态。
- 返回值:
BlockPermutation - 创建出的方块置换。
withState
通过修改指定方块状态创建一个派生自该置换的方块置换。
name:string- 派生置换中要修改的方块状态的标识符。
value:boolean|int32|string- 派生置换中要修改的方块状态的值。
- 返回值:
BlockPermutation - 创建出的派生置换。