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 something lights a block on fire
025 *
026 * @author The TridentSDK Team
027 * @since 0.3-alpha-DP
028 */
029public class BlockIgniteEvent extends BlockEvent implements Cancellable {
030    private final Cause cause;
031    private boolean cancelled;
032
033    /**
034     * @param block Block associated with this event
035     * @param cause Cause of this event
036     */
037    public BlockIgniteEvent(Block block, Cause cause) {
038        super(block);
039        this.cause = cause;
040    }
041
042    @Override
043    public boolean isIgnored() {
044        return cancelled;
045    }
046
047    @Override
048    public void cancel(boolean cancelled) {
049        this.cancelled = cancelled;
050    }
051
052    /**
053     * Returns the cause of this event
054     *
055     * @return Cause of this event
056     */
057    public Cause cause() {
058        return this.cause;
059    }
060
061    /**
062     * Cause of block ignition
063     */
064    public enum Cause {
065        FIRE_SPREAD,
066        PLAYER,
067        LIGHTENING,
068        LAVA,
069        FIREBALL
070    }
071}