Skip to content

Commit 00f25e7

Browse files
author
TheProgramSrc
committed
ChangeLog:
• Updated README.md • Updated JavaDocs
1 parent b1392aa commit 00f25e7

File tree

80 files changed

+1081
-391
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+1081
-391
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# SuperCoreAPI
22
Create the best plugins with better code, control and more!
33

4+
[Examples](https://github.com/TheProgramSrc/SuperCoreAPI/tree/examples)
5+
46
## Available extensions:
57

68
### [Global](https://github.com/TheProgramSrc/SuperCoreAPI/tree/master/src/main/java/xyz/theprogramsrc/supercoreapi/global)

pom.xml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!--
3-
~ Copyright (c) 2020.
4-
~ Created by TheProgramSrc (https://theprogramsrc.xyz)
5-
-->
6-
72
<project xmlns="http://maven.apache.org/POM/4.0.0"
83
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
94
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
105
<modelVersion>4.0.0</modelVersion>
116

127
<groupId>xyz.theprogramsrc</groupId>
138
<artifactId>SuperCoreAPI</artifactId>
14-
<version>3.1.0</version>
9+
<version>3.1.1</version>
1510
<packaging>jar</packaging>
1611

1712
<name>SuperCoreAPI</name>

src/main/java/xyz/theprogramsrc/supercoreapi/Recall.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
/*
2-
* Copyright (c) 2020.
3-
* Created by TheProgramSrc (https://theprogramsrc.xyz)
4-
*/
5-
61
package xyz.theprogramsrc.supercoreapi;
72

3+
/**
4+
* Runnable with a specific object
5+
* @param <OBJ> the object
6+
*/
87
public interface Recall<OBJ> {
98

109
void run(OBJ obj);

src/main/java/xyz/theprogramsrc/supercoreapi/SuperModule.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
import java.io.File;
44

5+
/**
6+
* Representation of a Plugin Module
7+
* @param <LISTENER> The listener of the plugin
8+
*/
59
public abstract class SuperModule<LISTENER> {
610

711
protected SuperPlugin<?> plugin;
@@ -10,6 +14,9 @@ public SuperModule(SuperPlugin<?> plugin){
1014
this.plugin = plugin;
1115
}
1216

17+
/**
18+
* Executed on the module load
19+
*/
1320
public void onLoad(){
1421

1522
}

src/main/java/xyz/theprogramsrc/supercoreapi/SuperPlugin.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/*
2-
* Copyright (c) 2020.
3-
* Created by TheProgramSrc (https://theprogramsrc.xyz)
4-
*/
5-
61
package xyz.theprogramsrc.supercoreapi;
72

83
import xyz.theprogramsrc.supercoreapi.global.dependencies.DependencyManager;
@@ -12,6 +7,10 @@
127
import java.io.File;
138
import java.util.List;
149

10+
/**
11+
* Representation of a Plugin
12+
* @param <PLUGIN> the plugin bootstrap ({@link net.md_5.bungee.api.plugin.Plugin} or {@link org.bukkit.plugin.java.JavaPlugin})
13+
*/
1514
public interface SuperPlugin<PLUGIN> {
1615

1716
/**

src/main/java/xyz/theprogramsrc/supercoreapi/SuperUtils.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/*
2-
* Copyright (c) 2020.
3-
* Created by TheProgramSrc (https://theprogramsrc.xyz)
4-
*/
5-
61
package xyz.theprogramsrc.supercoreapi;
72

83
import org.bukkit.command.defaults.BukkitCommand;
@@ -11,6 +6,10 @@
116
import java.util.Collection;
127
import java.util.stream.Collectors;
138

9+
/**
10+
* Representation of a set of utils for
11+
* a plugin
12+
*/
1413
public interface SuperUtils {
1514

1615
/**

src/main/java/xyz/theprogramsrc/supercoreapi/bungee/BungeeModule.java

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/*
2-
* Copyright (c) 2020.
3-
* Created by TheProgramSrc (https://theprogramsrc.xyz)
4-
*/
5-
61
package xyz.theprogramsrc.supercoreapi.bungee;
72

83
import net.md_5.bungee.api.ProxyServer;
@@ -27,10 +22,18 @@ protected void listener(Listener... listeners) {
2722
((BungeePlugin)this.plugin).listener(listeners);
2823
}
2924

25+
/**
26+
* Gets the BungeeCord Plugin Settings
27+
* @return The Plugin Settings
28+
*/
3029
protected Settings getSettings(){
3130
return ((BungeePlugin)this.plugin).getSettings();
3231
}
3332

33+
/**
34+
* Gets the proxy
35+
* @return The proxy
36+
*/
3437
protected ProxyServer getProxy(){
3538
return ((BungeePlugin)this.plugin).getProxy();
3639
}

src/main/java/xyz/theprogramsrc/supercoreapi/bungee/BungeePlugin.java

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/*
2-
* Copyright (c) 2020.
3-
* Created by TheProgramSrc (https://theprogramsrc.xyz)
4-
*/
5-
61
package xyz.theprogramsrc.supercoreapi.bungee;
72

83
import net.md_5.bungee.api.chat.TextComponent;

src/main/java/xyz/theprogramsrc/supercoreapi/bungee/commands/CommandResult.java

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
/*
2-
* Copyright (c) 2020.
3-
* Created by TheProgramSrc (https://theprogramsrc.xyz)
4-
*/
5-
61
package xyz.theprogramsrc.supercoreapi.bungee.commands;
72

3+
/**
4+
* Representation of the possible results of a command
5+
*/
86
public enum CommandResult {
97
COMPLETED,
108
INVALID_ARGS,

src/main/java/xyz/theprogramsrc/supercoreapi/bungee/events/BungeeEventManager.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
import xyz.theprogramsrc.supercoreapi.bungee.BungeeModule;
44
import xyz.theprogramsrc.supercoreapi.bungee.BungeePlugin;
55

6+
/**
7+
* This manages the customized events
8+
*/
69
public class BungeeEventManager extends BungeeModule {
710

811
public BungeeEventManager(BungeePlugin plugin) {

0 commit comments

Comments
 (0)