Skip to content

File player_kick_event.h

File List > endstone > event > player > player_kick_event.h

Go to the documentation of this file

// Copyright (c) 2024, The Endstone Project. (https://endstone.dev) All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include <string>
#include <utility>

#include "endstone/event/player/player_event.h"

namespace endstone {

class PlayerKickEvent : public PlayerEvent {
public:
    explicit PlayerKickEvent(Player &player, std::string reason) : PlayerEvent(player), reason_(std::move(reason)) {}
    ~PlayerKickEvent() override = default;

    inline static const std::string NAME = "PlayerKickEvent";
    [[nodiscard]] std::string getEventName() const override
    {
        return NAME;
    }

    [[nodiscard]] bool isCancellable() const override
    {
        return true;
    }

    [[nodiscard]] std::string getReason() const
    {
        return reason_;
    }

    void setReason(std::string reason)
    {
        reason_ = std::move(reason);
    }

private:
    std::string reason_;
};

}  // namespace endstone