API dos Plugins

Aprenda a integrar seus plugins com a API da yStore e acesse funcionalidades avançadas dos nossos plugins.

Os plugins da yStore possuem uma API pública que pode ser usada por outros plugins para interagir com as funcionalidades avançadas.

Adicionar ao seu arquivo de build

Aqui está um exemplo de como adicionar a API ao seu arquivo de build. Selecione sua ferramenta de build abaixo.

Última versão estável

Versão atual do yPlugins: Carregando versão...

Ao configurar seu arquivo de build, substitua VERSION nos exemplos abaixo pela versão exibida aqui.

Adicione o seguinte repositório e dependência ao seu arquivo pom.xml:

<repositories>
  <repository>
    <id>ystoreplugins</id>
    <url>https://repo.ystoreplugins.com.br/releases/</url>
  </repository>
</repositories>

<dependencies>
  <dependency>
    <groupId>com.ystoreplugins</groupId>
    <artifactId>yplugins</artifactId>
    <version>VERSION</version>
    <scope>provided</scope>
  </dependency>
</dependencies>

Adicione o seguinte repositório e dependência ao seu arquivo build.gradle:

repositories {
maven {
name 'ystoreplugins'
url 'https://repo.ystoreplugins.com.br/releases/'

}
}

dependencies {
compileOnly 'com.ystoreplugins:yplugins:VERSION'

}

Adicione o seguinte repositório e dependência ao seu arquivo build.gradle.kts:

repositories {
maven("https://repo.ystoreplugins.com.br/releases/") {
name = "ystoreplugins"

}
}

dependencies {
compileOnly("com.ystoreplugins:yplugins:VERSION")

}

Adicionar yPlugins como dependência

Se você deseja usar a API no seu plugin, você precisará adicionar o yPlugin correspondente como dependência do seu plugin. Isso é usado para que o yPlugin seja carregado ANTES do seu plugin, permitindo que você use a API no seu método onEnable(). No exemplo abaixo, usaremos uma dependência leve (soft dependency), para que seu plugin ainda funcione se o yPlugin não estiver instalado, mas para usar a API, o yPlugin precisará estar instalado.

Adicione a seguinte dependência ao seu arquivo plugin.yml:

softdepend: [ "NomeDoYPlugin" ]

BungeeCord usa softDepends ao invés de softdepend como Bukkit/Spigot. Adicione a seguinte dependência ao seu arquivo bungee.yml ou plugin.yml:

softDepends: [ "NomeDoYPlugin" ]

Adicione a seguinte dependência à anotação do arquivo de entrada do seu plugin:

@Plugin(dependencies = {@Dependency(id = "nomedoyplugin", optional = true)})

Métodos e classes

Para consultar os metódos e classes dos plugins com API e seus exemplos basta clica no plugin escolhido.

Tendo problemas?

Certifique-se de importar todas as suas classes se você ver a mensagem "Cannot find symbol" ou "Cannot resolve symbol"
Certifique-se de obter a API usando o método fornecido pelo yPlugin específico e que você tenha o campo apropriado no início da sua classe.
Certifique-se de adicionar a dependência ao seu arquivo de build conforme descrito acima.

Adicionar ao seu arquivo de build

Adicionar yPlugins como dependência

Métodos e classes

Tendo problemas?

Nesta página