Duels/duels-api/src/main/java/me/realized/duels/api/request/Request.java at 98cbd7b29ecc4be9fbd2812463c98a8a484d0bb1 · Realizedd/Duels · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
package me.realized.duels.api.request;

import java.util.UUID;
import me.realized.duels.api.arena.Arena;
import me.realized.duels.api.kit.Kit;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * Represents a Request sent.
 */
public interface Request {

    /**
     * The {@link UUID} of sender of this {@link Request}.
     *
     * @return Never-null {@link UUID} of the sender of this {@link Request}.
     */
    @NotNull
    UUID getSender();


    /**
     * The {@link UUID} of the receiver of this {@link Request}.
     *
     * @return Never-null {@link UUID} of the receiver of this {@link Request}.
     */
    @NotNull
    UUID getTarget();


    /**
     * The {@link Kit} for this {@link Request} or null if no {@link Kit} was selected.
     *
     * @return {@link Kit} for this {@link Request} or null if no {@link Kit} was selected.
     */
    @Nullable
    Kit getKit();


    /**
     * The {@link Arena} for this {@link Request} or null if no {@link Arena} was selected.
     *
     * @return {@link Arena} for this {@link Request} or null if no {@link Arena} was selected.
     */
    @Nullable
    Arena getArena();


    /**
     * Whether or not item betting is enabled for this {@link Request}.
     *
     * @return True if item betting is enabled for this {@link  Request}. False otherwise.
     */
    boolean canBetItems();


    /**
     * The bet for this {@link Request}.
     *
     * @return Bet amount for this {@link Request} or 0 if not specified.
     */
    double getBet();
}