HS-Workspace

https://hs-workspace.github.io/Wiki/
Admin
HS-Workspace creates Minecraft server plugins such as Extra Storage and Hyronic Friends to provide...
Tokens:7,780
Snippets:136
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Custom Item Examples

Source: https://hs-workspace.github.io/Wiki/extra-storage/custom-item/index.print.html

Examples of item identifiers for supported plugins.

```text
ITEMSADDER:your_item
```

```text
ORAXEN:onyx_axe
```

```text
NEXO:my_item
```

--------------------------------

### Get Friend List

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Retrieve the list of all friends.

```java
List<Friend> getList();
```

--------------------------------

### Get Blocked Players

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Retrieve the list of blocked players.

```java
BlockedList getBlockedList();
```

--------------------------------

### Get Mailbox

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Access the user's mailbox.

```java
Mailbox getMailbox();
```

--------------------------------

### Get Attached Items

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Retrieve items attached to a mail.

```java
List<ItemStack> getAttachedItem();
```

--------------------------------

### Get Online Friends

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Retrieve the list of currently online friends.

```java
List<Friend> getOnlineFriends();
```

--------------------------------

### Send Mail

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Create and send a new mail instance.

```java
Mail mail = new MailImpl(UUID sender, UUID target, String content, ItemStack... items);
mail.send();
```

--------------------------------

### Add Friend

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Immediately add a player to the friend list.

```java
void addFriend(UUID target);
```

--------------------------------

### Custom Item Format

Source: https://hs-workspace.github.io/Wiki/extra-storage/custom-item/index.print.html

The required format for referencing custom items from supported plugins.

```text
<type>:<id>
```

--------------------------------

### PlaceholderAPI Placeholders

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/placeholder/index.print.html

A list of available placeholders for use with the PlaceholderAPI plugin to retrieve friend and interaction data.

```APIDOC
## PlaceholderAPI Placeholders

### Description
These placeholders are designed for use with the PlaceholderAPI plugin to display information about a player's friend list, blocked list, and interaction permissions.

### Available Placeholders
- `%hfriends_friendlist_size%` - Shows the number of players on your friend list.
- `%hfriends_friendlist_max%` - Shows the maximum number of friends a player can have on the list (-1 means unlimited).
- `%hfriends_friendlist_is_max%` - Shows whether the player has reached the maximum number of friends.
- `%hfriends_blockedlist_size%` - Shows the number of players on your blocked list.
- `%hfriends_has_unread_mail%` - Shows whether the player has unread mails.
- `%hfriends_has_waiting_request` - Shows whether the player has requests waiting to respond.
- `%hfriends_is_friend_<player>%` - Checks whether a player is your friend.
- `%hfriends_is_blocked_<player>%` - Checks whether a player is blocked by you.
- `%hfriends_can_teleport_to_<player>%` - Checks whether you can teleport to a player.
- `%hfriends_can_send_msg_to_<player>%` - Checks whether you can send private message to a player.
- `%hfriends_can_send_mail_to_<player>%` - Checks whether you can send mail to a player.
```

--------------------------------

### BlockedList Management

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Methods for managing blocked players.

```APIDOC
## BlockedList Methods

### Methods
- `BlockedList getBlockedList()`: Retrieves the current blocked list.
- `void block(UUID target)`: Blocks a specific player.
- `void unblock(UUID target)`: Unblocks a specific player.
```

--------------------------------

### Send Friend Request

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Send a friend request to a target player.

```java
void sendRequest(UUID target);
```

--------------------------------

### Friend Teleportation Settings

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Methods to manage teleportation permissions between friends.

```APIDOC
## Friend Teleportation Methods

### Methods
- `boolean canTeleportTo()`: Checks if the friend allows teleportation to them.
- `boolean canTeleport()`: Checks if the friend can teleport to you.
- `boolean setCanTeleport(boolean canTeleport)`: Sets whether the friend can teleport to you.
```

--------------------------------

### Manage Friend Requests

Source: https://hs-workspace.github.io/Wiki/index.print.html

Methods for sending and finding pending friend requests.

```java
void sendRequest(UUID target);
```

```java
Optional<Request> findWaitingRequest(UUID target, boolean checkExpire);
```

--------------------------------

### Define PreMailRespondEvent

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer/event/index.print.html

Triggered when mail is ready to be responded to. Allows modification of the mail status.

```java
public final class PreMailRespondEvent extends BaseEvent implements Cancellable {
    private final Mail mail;
    private Mail.Status status;
    private boolean cancelled;

    public PreMailRespondEvent(Mail mail, Mail.Status status) {
        this.mail = mail;
        this.status = status;
        this.cancelled = false;
    }

    public Mail getMail() {
        return mail;
    }

    public Mail.Status getStatus() {
        return status;
    }

    public void setStatus(Mail.Status status) {
        this.status = status;
    }

    @Override
    public boolean isCancelled() {
        return cancelled;
    }

    @Override
    public void setCancelled(boolean cancel) {
        this.cancelled = cancel;
    }
}
```

--------------------------------

### Find User Data

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Retrieve player data using a UUID or OfflinePlayer object.

```java
Optional<User> FriendAPI.findUser(UUID);
Optional<User> FriendAPI.findUser(OfflinePlayer);
```

--------------------------------

### Manage Friend Requests and Status

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/index.print.html

Methods for sending requests, finding pending requests, and modifying friend list status.

```java
void sendRequest(UUID target);
```

```java
Optional<Request> findWaitingRequest(UUID target, boolean checkExpire);
```

```java
void addFriend(UUID target);
```

```java
void unfriend(UUID target);
```

--------------------------------

### FriendList Management

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Methods for managing and retrieving friend lists.

```APIDOC
## FriendList Methods

### Methods
- `List<Friend> getList()`: Returns the list of all friends.
- `List<Friend> getOnlineFriends()`: Returns the list of online friends.
- `void addFriend(UUID target)`: Adds a player to the friend list.
- `void unfriend(UUID target)`: Removes a player from the friend list.
```

--------------------------------

### Mail System

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Methods for managing mail, including sending, receiving, and item handling.

```APIDOC
## Mail System Methods

### Methods
- `Mailbox getMailbox()`: Retrieves the user's mailbox.
- `void mail.send()`: Sends a constructed mail.
- `List<ItemStack> getAttachedItem()`: Gets items attached to a mail.
- `boolean revokeItem(ItemStack item)`: Revokes an item from a sent mail.
- `boolean revokeAllItems()`: Revokes all items from a sent mail.
- `boolean takeItem(ItemStack item)`: Takes an item from a received mail.
- `boolean takeAllItems()`: Takes all items from a received mail.
```

--------------------------------

### Unblock Player

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Unblock a specific player by their UUID.

```java
void unblock(UUID target);
```

--------------------------------

### Manage Blocked Players

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/index.print.html

Methods to retrieve the blocked list and perform block or unblock actions.

```java
BlockedList getBlockedList();
```

```java
void block(UUID target);
```

```java
void unblock(UUID target);
```

--------------------------------

### Manage Mailbox and Mail Content

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/index.print.html

Methods to access the mailbox, send mail, and manage attached items.

```java
Mailbox getMailbox();
```

```java
Mail mail = new MailImpl(UUID sender, UUID target, String content, ItemStack... items);
mail.send();
```

```java
List<ItemStack> getAttachedItem();
```

--------------------------------

### Teleport Permissions

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Methods to check or set teleportation permissions between friends.

```java
boolean canTeleportTo();
```

```java
boolean canTeleport();
```

```java
boolean setCanTeleport(boolean canTeleport);
```

--------------------------------

### Mail Permissions

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Check or set whether a player can receive mail from friends.

```java
boolean canMail(); // Checks whether the player can receive the mail of their friend or not.
void setCanMail(boolean canMail); // Sets whether the player can receive the mail of their friend or not.
```

--------------------------------

### FriendAPI.findUser

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Retrieves user data for a specific player.

```APIDOC
## FriendAPI.findUser

### Signature
`Optional<User> FriendAPI.findUser(UUID)`
`Optional<User> FriendAPI.findUser(OfflinePlayer)`

### Description
Retrieves the User object associated with the provided UUID or OfflinePlayer instance.
```

--------------------------------

### Mailbox and Mail Operations

Source: https://hs-workspace.github.io/Wiki/index.print.html

Methods for managing mail, sending messages, and handling attached items.

```APIDOC
## Mail Operations

### Description
Methods for sending mail and managing items within mail.

### Methods
- `Mailbox getMailbox()`: Retrieves the user's mailbox.
- `void send()`: Sends a constructed Mail object.
- `List<ItemStack> getAttachedItem()`: Gets items attached to a mail.
- `boolean revokeItem(ItemStack item)` / `revokeAllItems()`: Sender methods to reclaim items.
- `boolean takeItem(ItemStack item)` / `takeAllItems()`: Receiver methods to claim items.
```

--------------------------------

### Define PreMailSendEvent

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer/event/index.print.html

Triggered before mail is sent. Implements Cancellable to allow blocking the mail delivery.

```java
public final class PreMailSendEvent extends BaseEvent implements Cancellable {
    private final Mail mail;
    private boolean cancelled;

    public PreMailSendEvent(Mail mail) {
        this.mail = mail;
        this.cancelled = false;
    }

    public Mail getMail() {
        return mail;
    }

    @Override
    public boolean isCancelled() {
        return cancelled;
    }

    @Override
    public void setCancelled(boolean cancel) {
        this.cancelled = cancel;
    }
}
```

--------------------------------

### Manage Friend Lists

Source: https://hs-workspace.github.io/Wiki/index.print.html

Methods to retrieve, add, or remove friends from a list.

```java
List<Friend> getList();
```

```java
List<Friend> getOnlineFriends();
```

```java
void addFriend(UUID target);
```

```java
void unfriend(UUID target);
```

--------------------------------

### Block Player

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Block a specific player by their UUID.

```java
void block(UUID target);
```

--------------------------------

### Retrieve Friend Lists

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/index.print.html

Methods to fetch the full list of friends or only those currently online.

```java
List<Friend> getList();
```

```java
List<Friend> getOnlineFriends();
```

--------------------------------

### Mailbox Operations

Source: https://hs-workspace.github.io/Wiki/index.print.html

Methods for accessing the mailbox and managing mail content.

```java
Mailbox getMailbox();
```

```java
Mail mail = new MailImpl(UUID sender, UUID target, String content, ItemStack... items);
mail.send();
```

```java
List<ItemStack> getAttachedItem();
```

```java
boolean revokeItem(ItemStack item); // Revoke the specified item.
boolean revokeAllItems(); // Revoke all items contained in the letter.
```

```java
boolean takeItem(ItemStack item); // Take the specified item.
boolean takeAllItems(); // Take all items contained in the letter.
```

--------------------------------

### Friend Request Management

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Methods for sending and finding friend requests.

```APIDOC
## Friend Request Methods

### Methods
- `void sendRequest(UUID target)`: Sends a friend request to a player.
- `Optional<Request> findWaitingRequest(UUID target, boolean checkExpire)`: Finds a pending friend request.
```

--------------------------------

### Find Pending Request

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Locate a recently received friend request.

```java
Optional<Request> findWaitingRequest(UUID target, boolean checkExpire);
```

--------------------------------

### Define PreFriendRequestRespondEvent

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer/event/index.print.html

Triggered when a friend request is ready to be responded to. Allows modification of the request status.

```java
public final class PreFriendRequestRespondEvent extends BaseEvent implements Cancellable {
    private final Request request;
    private Request.Status status;
    private boolean cancelled;

    public PreFriendRequestRespondEvent(Request request, Request.Status status) {
        this.request = request;
        this.status = status;
        this.cancelled = false;
    }

    public Request getRequest() {
        return request;
    }

    public Request.Status getStatus() {
        return status;
    }

    public void setStatus(Request.Status status) {
        this.status = status;
    }

    @Override
    public boolean isCancelled() {
        return cancelled;
    }

    @Override
    public void setCancelled(boolean cancel) {
        this.cancelled = cancel;
    }
}
```

--------------------------------

### Take Mail Items

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Methods for the receiver to take items from a received letter.

```java
boolean takeItem(ItemStack item); // Take the specified item.
boolean takeAllItems(); // Take all items contained in the letter.
```

--------------------------------

### Revoke or Take Mail Items

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/index.print.html

Methods for senders to revoke items or receivers to take items from a mail.

```java
boolean revokeItem(ItemStack item); // Revoke the specified item.
boolean revokeAllItems(); // Revoke all items contained in the letter.
```

```java
boolean takeItem(ItemStack item); // Take the specified item.
boolean takeAllItems(); // Take all items contained in the letter.
```

--------------------------------

### Define PreFriendRequestSendEvent

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer/event/index.print.html

Triggered before a friend request is sent. Implements Cancellable to allow blocking the request.

```java
public final class PreFriendRequestSendEvent extends BaseEvent implements Cancellable {
    private final Request request;
    private boolean cancelled;

    public PreFriendRequestSendEvent(Request request) {
        this.request = request;
        this.cancelled = false;
    }

    public Request getRequest() {
        return request;
    }

    @Override
    public boolean isCancelled() {
        return cancelled;
    }

    @Override
    public void setCancelled(boolean cancel) {
        this.cancelled = cancel;
    }
}
```

--------------------------------

### Mailbox Operations

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/index.print.html

Methods for managing mail, including sending, revoking, and taking items from letters.

```APIDOC
### Methods
Mailbox getMailbox()
void send()
List<ItemStack> getAttachedItem()
boolean revokeItem(ItemStack item)
boolean revokeAllItems()
boolean takeItem(ItemStack item)
boolean takeAllItems()
```

--------------------------------

### Unfriend Player

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Remove a player from the friend list.

```java
void unfriend(UUID target);
```

--------------------------------

### Define FriendTeleportEvent

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer/event/index.print.html

Triggered before a friend teleports to the user. Implements Cancellable to prevent the teleportation.

```java
public final class FriendTeleportEvent extends BaseEvent implements Cancellable {
    private final User user, target;
    private boolean cancelled;

    public FriendTeleportEvent(User user, User target) {
        this.user = user;
        this.target = target;
        this.cancelled = false;
    }

    public User getUser() {
        return user;
    }

    public User getTarget() {
        return target;
    }

    @Override
    public boolean isCancelled() {
        return cancelled;
    }

    @Override
    public void setCancelled(boolean cancel) {
        this.cancelled = cancel;
    }
}
```

--------------------------------

### Define AttachingItemToMailEvent

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer/event/index.print.html

Triggered before an item is attached to mail. Allows modification or cancellation of the attachment process.

```java
public final class AttachingItemToMailEvent extends BaseEvent implements Cancellable {
    private ItemStack item;
    private boolean cancelled;

    public AttachingItemToMailEvent(ItemStack item) {
        this.item = item;
        this.cancelled = false;
    }

    public ItemStack getAttachedItem() {
        return item;
    }

    public void setAttachedItem(ItemStack item) {
        this.item = item;
    }

    @Override
    public boolean isCancelled() {
        return cancelled;
    }

    @Override
    public void setCancelled(boolean cancel) {
        this.cancelled = cancel;
    }
}
```

--------------------------------

### Revoke Mail Items

Source: https://hs-workspace.github.io/Wiki/hyronic-friends/developer.html

Methods for the sender to revoke items from a sent letter.

```java
boolean revokeItem(ItemStack item); // Revoke the specified item.
boolean revokeAllItems(); // Revoke all items contained in the letter.
```
Tokens:
Raw