org.spongepowered.api.event.message.PlayerChatEvent 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.event.message;

import net.kyori.adventure.audience.ForwardingAudience;
import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.spongepowered.api.entity.living.player.PlayerChatFormatter;
import org.spongepowered.api.event.Cancellable;

import java.util.Optional;

/**
 * Fired when the {@link Component} being sent to a {@link PlayerChatFormatter} was
 * due to chatting.
 */
public interface PlayerChatEvent extends AudienceMessageEvent, Cancellable {

    /**
     * Gets the original formatter that this message will be sent through.
     *
     * @return The original formatter used
     */
    PlayerChatFormatter originalChatFormatter();

    /**
     * Gets the current formatter that this message will be sent through.
     *
     * @return The formatter the message in this event will be sent through
     */
    Optional chatFormatter();

    /**
     * Sets the formatter for this message to go trough.
     * If the target audience is a {@link net.kyori.adventure.audience.ForwardingAudience}
     * the {@link PlayerChatFormatter} will be applied to each of its {@link ForwardingAudience#audiences()}
     *
     * @param router The router to set
     */
    void setChatFormatter(@Nullable PlayerChatFormatter router);

    /**
     * Gets the original chat message.
     *
     * This message is the original chat message, without any formatting
     * whatsoever.
     *
     * In Vanilla, this is equivalent to what a player typed into the
     * chat box (no name prefix or other elements).
     *
     * @return The original chat message
     */
    @Override
    Component originalMessage();

    /**
     * Gets the chat message.
     *
     * @return The chat message
     */
    @Override
    Component message();

    /**
     * Sets the chat message.
     *
     * @param message The chat message
     */
    @Override
    void setMessage(final Component message);

}