Wale
  • Welcome!
  • General
    • Getting Started
    • Requirements
    • Detailed plan overview
    • FAQ
  • Wale Documentation
    • Installation
    • Master Configuration
    • Templates
    • Nodes
    • Teams
  • API Documentation
    • Getting Started
    • Events
      • Node Notification
      • Service Notification
      • Network Full
      • Channel Message
    • Listener
    • Executors
      • Channel Executor
      • Player Executor
      • Service Executor
  • Getting Support
    • Discord
    • Tickets
Powered by GitBook
On this page
  1. API Documentation
  2. Executors

Player Executor

The PlayerExecutor is used to perform interactions with players, such as sending messages, connecting to servers, or retrieving information.

1. Methods

1.1 getPlayer(String)

WalePlayer getPlayer(String uuid);

Description: This method is used to retrieve player information based on the UUID as a string.

1.2 getPlayer(UUID)

WalePlayer getPlayer(UUID uuid);

Description: This method is used to retrieve player information based on the UUID.

1.3 getPlayerByName(String)

WalePlayer getPlayerByName(String name);

Description: This method is used to retrieve player information based on the player name.

1.4 getPlayerCounts()

KeyValuePair<Integer, Integer> getPlayerCounts();

Description: This method is used to retrieve the number of players (current, max).

1.5 connect(String, String)

void connect(String uuid, String serviceId);

Description: This method is used to connect a player to a service.

1.6 disconnect(String, String)

void disconnect(String uuid, String parsedBaseComponent)

In the API, you will often encounter parsedBaseComponent or similar terms. This refers to the BaseComponents of Bungee-Chat in JSON format. There is a ComponentSerializer provided by BungeeCord that can directly build these components into JSON format.

Description: This method is used to disconnect a player from the BungeeCord server.

1.7 sendMesasge(String, String)

void sendMessage(String uuid, String message);

Description: This method is used to send a chat message to the player.

1.8 sendMesasge(String, String[])

void sendMessage(String uuid, String[] message);

Description: This method is used to send multiple chat messages to the player.

1.9 broadcastMessage(String[], String[])

void broadcastMessage(String[] message, String[] permissions);

Description: This method is used to send multiple chat messages to all players. Permissions are optional.

1.10 broadcastMessage(String, String[])

void broadcastMessage(String message, String[] permissions);

Description: This method is used to send a chat message to all players. Permissions are optional.

1.11 broadcastMessage(String, String[])

void broadcastMessage(String message, String[] permissions);

Description: This method is used to send a chat message to all players. Permissions are optional.

1.12 broadcastBaseComponents(String[], String[])

void broadcastBaseComponents(String[] parsedBaseComponents, String[] permissions);

Description: This method is used to send BaseComponents to all players. Permissions are optional.

1.13 broadcastBaseComponents(String, String[])

void broadcastBaseComponents(String parsedBaseComponents, String[] permissions);

Description: This method is used to send a single BaseComponent to all players. Permissions are optional.

1.14 sendBaseComponents(String, String)

void sendBaseComponents(String uuid, String parsedBaseComponents);

Description: This method is used to send a BaseComponent to a specific player using their UUID as a string.

PreviousChannel ExecutorNextService Executor

Last updated 1 year ago