2021-03-09 17:51:48 +00:00
|
|
|
/*
|
2022-01-01 19:03:05 +00:00
|
|
|
* Copyright (c) 2019-2022 GeyserMC. http://geysermc.org
|
2021-03-09 17:51:48 +00:00
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*
|
|
|
|
* @author GeyserMC
|
|
|
|
* @link https://github.com/GeyserMC/Geyser
|
|
|
|
*/
|
|
|
|
|
2021-11-23 02:57:09 +00:00
|
|
|
package org.geysermc.geyser.api.connection;
|
2021-03-09 17:51:48 +00:00
|
|
|
|
2023-04-15 16:54:30 +00:00
|
|
|
import org.checkerframework.checker.index.qual.NonNegative;
|
|
|
|
import org.checkerframework.checker.nullness.qual.NonNull;
|
|
|
|
import org.checkerframework.checker.nullness.qual.Nullable;
|
2022-01-15 17:56:40 +00:00
|
|
|
import org.geysermc.api.connection.Connection;
|
2023-07-02 21:00:46 +00:00
|
|
|
import org.geysermc.geyser.api.bedrock.camera.CameraShake;
|
2022-01-16 21:09:53 +00:00
|
|
|
import org.geysermc.geyser.api.command.CommandSource;
|
2023-04-15 16:54:30 +00:00
|
|
|
import org.geysermc.geyser.api.entity.type.GeyserEntity;
|
|
|
|
import org.geysermc.geyser.api.entity.type.player.GeyserPlayerEntity;
|
|
|
|
|
2023-07-02 21:00:46 +00:00
|
|
|
import java.util.Set;
|
2023-04-15 16:54:30 +00:00
|
|
|
import java.util.concurrent.CompletableFuture;
|
2021-03-09 17:51:48 +00:00
|
|
|
|
2021-07-22 02:14:00 +00:00
|
|
|
/**
|
2022-01-16 04:54:08 +00:00
|
|
|
* Represents a player connection used in Geyser.
|
2021-07-22 02:14:00 +00:00
|
|
|
*/
|
2022-01-16 21:09:53 +00:00
|
|
|
public interface GeyserConnection extends Connection, CommandSource {
|
2023-04-15 16:54:30 +00:00
|
|
|
/**
|
|
|
|
* @param javaId the Java entity ID to look up.
|
|
|
|
* @return a {@link GeyserEntity} if present in this connection's entity tracker.
|
|
|
|
*/
|
|
|
|
@NonNull
|
|
|
|
CompletableFuture<@Nullable GeyserEntity> entityByJavaId(@NonNegative int javaId);
|
|
|
|
|
|
|
|
/**
|
2023-07-02 21:00:46 +00:00
|
|
|
* Displays a player entity as emoting to this client.
|
2023-04-15 16:54:30 +00:00
|
|
|
*
|
|
|
|
* @param emoter the player entity emoting.
|
2023-07-02 21:00:46 +00:00
|
|
|
* @param emoteId the emote ID to send to this client.
|
2023-04-15 16:54:30 +00:00
|
|
|
*/
|
|
|
|
void showEmote(@NonNull GeyserPlayerEntity emoter, @NonNull String emoteId);
|
2023-07-02 21:00:46 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Shakes the client's camera.<br><br>
|
|
|
|
* If the camera is already shaking with the same {@link CameraShake} type, then the additional intensity
|
|
|
|
* will be layered on top of the existing intensity, with their own distinct durations.<br>
|
|
|
|
* If the existing shake type is different and the new intensity/duration are not positive, the existing shake only
|
|
|
|
* switches to the new type. Otherwise, the existing shake is completely overridden.
|
|
|
|
*
|
|
|
|
* @param intensity the intensity of the shake. The client has a maximum total intensity of 4.
|
|
|
|
* @param duration the time in seconds that the shake will occur for
|
|
|
|
* @param type the type of shake
|
|
|
|
*/
|
|
|
|
void shakeCamera(float intensity, float duration, @NonNull CameraShake type);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Stops all camera shake of any type.
|
|
|
|
*/
|
|
|
|
void stopCameraShake();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds the given fog IDs to the fog cache, then sends all fog IDs in the cache to the client.
|
|
|
|
* <p>
|
|
|
|
* Fog IDs can be found <a href="https://wiki.bedrock.dev/documentation/fog-ids.html">here</a>
|
|
|
|
*
|
|
|
|
* @param fogNameSpaces the fog IDs to add. If empty, the existing cached IDs will still be sent.
|
|
|
|
*/
|
|
|
|
void sendFog(String... fogNameSpaces);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Removes the given fog IDs from the fog cache, then sends all fog IDs in the cache to the client.
|
|
|
|
*
|
|
|
|
* @param fogNameSpaces the fog IDs to remove. If empty, all fog IDs will be removed.
|
|
|
|
*/
|
|
|
|
void removeFog(String... fogNameSpaces);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns an immutable copy of all fog affects currently applied to this client.
|
|
|
|
*/
|
|
|
|
@NonNull
|
|
|
|
Set<String> fogEffects();
|
2021-11-20 21:34:30 +00:00
|
|
|
}
|