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.entity;
019
020import net.tridentsdk.entity.living.Player;
021import net.tridentsdk.event.Cancellable;
022import net.tridentsdk.event.player.PlayerEvent;
023
024/**
025 * Called when a player tries to start sprinting, even if hunger would otherwise prevent them from sprinting
026 */
027public class PlayerToggleSprintEvent extends PlayerEvent implements Cancellable {
028    private final boolean toggle;
029    private boolean cancelled;
030
031    public PlayerToggleSprintEvent(Player player, boolean toggle) {
032        super(player);
033        this.toggle = toggle;
034    }
035
036    /**
037     * @return true if the player is trying to sprint
038     */
039    public boolean sprintOn() {
040        return this.toggle;
041    }
042
043    /**
044     * @return true if the player is trying to stop sprinting
045     */
046    public boolean sprintOff() {
047        return !this.toggle;
048    }
049
050    @Override
051    public boolean isIgnored() {
052        return cancelled;
053    }
054
055    @Override
056    public void cancel(boolean cancelled) {
057        this.cancelled = cancelled;
058    }
059}