An IBlockState object represents a block’s current state.
Importing the package
It might be required for you to import the package if you encounter any issues, so better be safe than sorry and add the import.
Calling an IBlockState
There are several methods that return an IBlockState
- Using the Bracket Handler
- Using the
IBlockState.getBlockState()static method. (See below for more information)
- Using the
getMatchingBlockStates()method on an IBlockStateMatcher object to retrieve an array of IBlockStates.
- Using the
withProperty()method on another IBlockState object.
Resolving an IBlockState At Runtime
There may be times at which your script may rely on interaction with a block from a mod that has not been loaded yet, such as inside block events in ContentTweaker or another pre-init script loader. If you attempt to use a Bracket Handler for a block that has not yet been registered, the handler will fail to resolve and your script will not work.
To avoid this, you can use the static
IBlockState.getBlockState() method to resolve an IBlockState at runtime.
static IBlockState getBlockState(String blockname, String... properties) Parameters:
- String blockname → A string in the format “modid:blockname” as it would appear in the BlockState Bracket Handler
- String… properties → Zero or more strings of
"name=value"pairs of properties to apply to this blockstate. Any unspecified properties will use the same value as in the default blockstate for the specified block name.
Returns an IBlockState of the specified
blockname with the specified
properties, or the default blockstate if no properties are specified.
ZenMethods and ZenGetters
|block||IBlock||Returns the refered block|
|meta||int||Returns the refered block’s metadata|
|commandString||String||Returns a possible Bracket Handler for this state|
boolean isReplaceable(IWorld world, IBlockPos pos);
Returns a boolean that sais whether the block can be replaced or not.
Getting or changing Properties
You can get a list of all registered properties, either as list with all property names or as map that maps the properties to their value.
You can also check which values are possible for a given property name.
You can also use
withProperty to create a new IBlockState object with that property changed.
List<String> getPropertyNames(); String getPropertyValue(String name); List<String> getAllowedValuesForProperty(String name); IBlockState withProperty(String name, String value);
Comparing two IBlockState objects
You can either use
int compare(IBlockState other); or the ZenCompare Tokens
The return different types though:
state.compare(other)returns an int that is 0 if they are equal
state == otherreturns a bool that is true of they are equal
Getting an explicit Blockstate Matcher
Returns an IBlockStateMatcher that matches the given block.