org.spongepowered.api.block.BlockState Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
The newest version!
/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered 
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.spongepowered.api.block;

import org.spongepowered.api.Sponge;
import org.spongepowered.api.block.entity.BlockEntity;
import org.spongepowered.api.data.DataManipulator;
import org.spongepowered.api.data.DirectionRelativeDataHolder;
import org.spongepowered.api.data.value.Value;
import org.spongepowered.api.fluid.FluidState;
import org.spongepowered.api.state.State;
import org.spongepowered.api.state.StateMatcher;
import org.spongepowered.api.util.mirror.Mirror;
import org.spongepowered.api.util.rotation.Rotation;
import org.spongepowered.api.world.server.ServerLocation;

import java.util.Objects;
import java.util.function.Supplier;

/**
 * Represents a particular "state" that can exist at a {@link ServerLocation} with
 * a particular {@link BlockType} and various {@link org.spongepowered.api.data.value.Value.Immutable}s defining
 * the information for the "block". Note that normally, there may exist only
 * a single instance of a particular {@link BlockState} as they are immutable,
 * a particular instance may be cached for various uses.
 */
public interface BlockState extends State, DirectionRelativeDataHolder.Immutable {

    /**
     * Creates a new {@link Builder} for building {@link BlockState}s.
     *
     * @return The builder
     */
    static Builder builder() {
        return Sponge.game().builderProvider().provide(Builder.class);
    }

    static BlockState fromString(final String id) {
        Objects.requireNonNull(id);
        return Sponge.game().builderProvider().provide(Builder.class).fromString(id).build();
    }

    /**
     * Constructs a new builder to construct a {@link StateMatcher}.
     *
     * @param type The block type
     * @return The builder
     */
    static StateMatcher.Builder matcher(final Supplier type) {
        return BlockState.matcher(type.get());
    }

    /**
     * Constructs a new builder to construct a {@link StateMatcher}.
     *
     * @param type The block type
     * @return The builder
     */
    static StateMatcher.Builder matcher(final BlockType type) {
        return StateMatcher.blockStateMatcherBuilder().type(type);
    }

    /**
     * Gets the base type of block.
     *
     * The type does not include block data such as the contents of
     * inventories.
     *
     * @return The type of block
     */
    BlockType type();

    /**
     * Gets the associated {@link FluidState} for this block state.
     * Depending on whether this block state is considered "waterlogged"
     * or not, and with which fluid.
     *
     * @return The fluid state
     */
    FluidState fluidState();

    /**
     * Creates a new {@link BlockSnapshot} with this current {@link BlockState}
     * at the desired {@link ServerLocation}. If the {@link ServerLocation} has the same
     * {@link BlockState}, and the {@link BlockType} can house a
     * {@link BlockEntity}, the data from the block entity may be included in the
     * returned  {@link BlockSnapshot}.
     *
     * @param location The location for the snapshot
     * @return The newly created snapshot
     */
    BlockSnapshot snapshotFor(ServerLocation location);

    /**
     * Gets the appropriate {@link BlockState} for the desired {@link Rotation}. It may
     * return the same state, but some states may have extra logic associated with rotating
     * on its axis, much like mirroring.
     *
     * @param rotation The rotation
     * @return The rotated state if not this state
     */
    BlockState rotate(Rotation rotation);

    /**
     * Gets the appropriate {@link BlockState} for the desired {@link Rotation}. It may
     * return the same state, but some states may have extra logic associated with rotating
     * on its axis, much like mirroring.
     *
     * @param rotation The rotation
     * @return The rotated state if not this state
     */
    default BlockState rotate(final Supplier rotation) {
        return this.rotate(rotation.get());
    }

    /**
     * Gets the appropriate {@link BlockState} for the desired {@link Mirror}. It may
     * return the same state, but some states may have extra logic associated with mirroring
     * on its axis, much like rotation.
     *
     * @param mirror The mirror
     * @return The mirrored state if not this state
     */
    BlockState mirror(Mirror mirror);

    /**
     * Gets the appropriate {@link BlockState} for the desired {@link Mirror}. It may
     * return the same state, but some states may have extra logic associated with mirroring
     * on its axis, much like rotation.
     *
     * @param mirror The mirror
     * @return The mirrored state if not this state
     */
    default BlockState mirror(final Supplier mirror) {
        return this.mirror(mirror.get());
    }

    /**
     * Gets a string representation of this block state, including the block type and the properties.
     * Do not confuse with {@link #toString} which is implementation specific.
     *
     * @return A string representation of this block state.
     */
    String asString();

    /**
     * An {@link org.spongepowered.api.data.DataHolderBuilder.Immutable} for a {@link BlockState}. Just like the
     * {@link org.spongepowered.api.data.DataHolderBuilder.Immutable}, the {@link Value}s passed in to
     * create a {@link BlockState} are copied on creation.
     *
     * Note that upon creation, the {@link BlockType} must be set for validation
     * of {@link DataManipulator}s, otherwise exceptions may be thrown.
     */
    interface Builder extends State.Builder {

        /**
         * Sets the {@link BlockType} for the {@link BlockState} to build.
         *
         * The {@link BlockType} is used for some pre-validation on addition of
         * {@link DataManipulator}s through {@link #add(DataManipulator)}. It is
         * important to understand that not all manipulators are compatible with
         * all {@link BlockType}s.
         *
         * @param blockType The block type
         * @return This builder, for chaining
         */
        default Builder blockType(final Supplier blockType) {
            return this.blockType(blockType.get());
        }

        /**
         * Sets the {@link BlockType} for the {@link BlockState} to build.
         *
         * The {@link BlockType} is used for some pre-validation on addition of
         * {@link DataManipulator}s through {@link #add(DataManipulator)}. It is
         * important to understand that not all manipulators are compatible with
         * all {@link BlockType}s.
         *
         * @param blockType The block type
         * @return This builder, for chaining
         */
        Builder blockType(BlockType blockType);
    }
}