001/*
002 * Trident - A Multithreaded Server Alternative
003 * Copyright 2014 The TridentSDK Team
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *    http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package net.tridentsdk.event.block;
019
020import net.tridentsdk.base.Block;
021import net.tridentsdk.event.Cancellable;
022
023/**
024 * Called when a liquid flows from a block to another
025 *
026 * @author The TridentSDK Team
027 * @since 0.3-alpha-DP
028 */
029public class BlockFlowEvent extends BlockEvent implements Cancellable {
030    private final Block to;
031    private boolean cancelled;
032
033    /**
034     * @param from Block where the liquid is flowing from
035     * @param to   Block where the liquid is flowing too
036     */
037    public BlockFlowEvent(Block from, Block to) {
038        super(from);
039        this.to = to;
040    }
041
042    /**
043     * Return where the block is flowing too
044     *
045     * @return Block where the liquid is flowing too
046     */
047    public Block to() {
048        return this.to;
049    }
050
051    /**
052     * Return where the liquid is flowing from
053     *
054     * @return Block where the liquid is flowing from
055     */
056    public Block from() {
057        return super.block();
058    }
059
060    @Override
061    public boolean isIgnored() {
062        return cancelled;
063    }
064
065    @Override
066    public void cancel(boolean cancelled) {
067        this.cancelled = cancelled;
068    }
069}