API - montlikadani/RageMode GitHub Wiki

RageMode API

You can manually add the jar file to your build path as a library or you can use jitpack repository site to download the artifact and javadocs.

For javadoc

Manually included into build path

  • Download the RageMode jar file and add this jar to Javadoc Location
  • Rebuild and refresh the project

Using one of build environment

  • During the building of the project the javadoc will be included automatically to the dependencies.

Maven

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.github.montlikadani</groupId>
        <artifactId>RageMode</artifactId>
        <version>LATEST</version> <!-- Change the LATEST to the current version of this plugin -->
        <scope>provided</scope>
    </dependency>
</dependencies>

Gradle

repositories {
    maven { 
        url 'https://jitpack.io' 
    }
}

dependencies {
    implementation 'com.github.montlikadani:RageMode:LATEST' // Change the LATEST to the current version of this plugin
}

Events

RMGameCreateEvent

The event is called when creates a new game.

Example

@EventHandler
public void onRMGameCreate(RMGameCreateEvent e) {
    // do something
}

RMGameDeleteEvent

The event is called when deletes a game.

Example

@EventHandler
public void onRMGameDelete(RMGameDeleteEvent ev) {
    // do something
}

RMGameJoinAttemptEvent

The event is called when a player join a game.

Example

@EventHandler
public void onGameJoin(RMGameJoinAttemptEvent event) {
    event.getPlayer().sendMessage("You have joined to the game " + event.getGame().getName());
    event.setCancelled(true);
}

RMGameLeaveAttemptEvent

The event is called when a player leave from the game.

Example

@EventHandler
public void onGameLeave(RMGameLeaveAttemptEvent event) {
    event.getPlayer().sendMessage("You left the game " + event.getGame().getName());
}

SpectatorJoinToGameEvent

The event is called when a player want to spectator in a game.

Example

@EventHandler
public void onSpecJoin(SpectatorJoinToGameEvent event) {
    event.getPlayer().sendMessage("You have joined to " + event.getGame().getName() + " game in spectator mode.");
}

SpectatorLeaveGameEvent

The event is called when a spectator player leaves from a game.

Example

@EventHandler
public void onSpecLeft(SpectatorLeaveGameEvent event) {
    event.getPlayer().sendMessage("You has been left from " + event.getGame().getName() + " game.");
}

RMGameStartEvent

The event is called when starting the game.

Example

@EventHandler
public void onRMGameStart(RMGameStartEvent event) {
    for (PlayerManager pm : event.getGame().getPlayersFromList()) {
        Player player = pm.getPlayer();
        player.sendMessage("The game " + event.getGame().getName() + " has started!");
    }
}

RMGameStopEvent

The event is called when a game end.

Example

@EventHandler
public void onRMGameStop(RMGameStopEvent event) {
    for (PlayerManager pm : event.getGame().getPlayersFromList()) {
        Player player = pm.getPlayer();
        player.sendMessage("The game " + event.getGame().getName() + " has stopped!");
    }
}

PlayerKickedFromGame

The event is called when kicked a player from game.

Example

@EventHandler
public void onPlayerKickFromGame(PlayerKickedFromGame event) {
    event.getTarget().sendMessage("You were kicked from " + event.getGame().getName() + " game! By: " + event.getBySender());
}

PlayerWinEvent

The event is called when a player won a game.

Example

@EventHandler
public void onPlayerWinGame(PlayerWinEvent event) {
    event.getPlayer().sendMessage("You have won the game " + event.getGame().getName() + "!");
}

RMPlayerKilledEvent

The event is called when a player kills an other player in game.

Example

@EventHandler
public void onPlayerKilled(RMPlayerKilledEvent event) {
    event.getKiller().sendMessage("You were killed " + event.getPlayer() + ", with "
            + event.getTool().toString() + " tool!");
}

RMGameStatusChangeEvent

The event is called when changing the game status to a new.

Example

@EventHandler
public void onGameStatusChange(RMGameStatusChangeEvent event) {
    System.out.println("Game status changed to: " + event.getStatus().name());
}

RMPlayerRespawnedEvent

The event is called when the player respawned in game.

Example

@EventHandler
public void onPlayerRespawned(RMPlayerRespawnedEvent event) {
    event.getPlayer().sendMessage("You successfully respawned in " + event.getGame().getName() + " game!");
}

RMPlayerPreRespawnEvent

The event is called when the player want to respawn in game.

Example

@EventHandler
public void onPlayerPreRespawn(RMPlayerPreRespawnEvent event) {
    event.getPlayer().sendMessage("You wanted to respawn in " + event.getGame().getName() + " game, but not.");
    event.setCancelled(true);
}

RMPlayerBuyFromShopEvent

This event is called when a player bought from lobby shop.

Example

@EventHandler
public void onPlayerBuyFromShop(RMPlayerBuyFromShopEvent e) {
    if (e.getElements().getItem() != null)
        e.getPlayer().sendMessage("You bought an item " + e.getElements().getItem().getDisplayName());
}
⚠️ **GitHub.com Fallback** ⚠️