Index (CurseForgeGradle 1.2.4 API)

A B C D E F G H I L M N P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

addEmbedded(Object...) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Marks another project as being embedded within this file.
addEnvironment(Object...) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Marks the file as supporting a given environment.
addGameVersion(Object...) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Marks the file as supporting a given game versions.
addIncompatibility(Object...) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Marks another project as being incompatible with this file.
addJavaVersion(Object...) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Marks the file as supporting the given Java versions.
addModLoader(Object...) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Marks the file as supporting a given modloader.
addOptional(Object...) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Marks another project as being optional.
addRelation(Object, Object) - Method in class net.darkhax.curseforgegradle.UploadArtifact
addRelation(Object, Object, Object) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Adds a relationship between this artifact and another project on CurseForge.
addRelations(Object, Object...) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Adds a relationship between this artifact and multiple other projects on CurseForge.
addRelationship(String, String, String) - Method in class net.darkhax.curseforgegradle.api.metadata.ProjectRelations: Adds a new project relationship.
addRequirement(Object...) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Marks another project as being required for this file to work properly.
addTool(Object...) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Marks another project as being a tool for this file.
apiEndpoint - Variable in class net.darkhax.curseforgegradle.TaskPublishCurseForge: The game specific API endpoint.
apiToken - Variable in class net.darkhax.curseforgegradle.TaskPublishCurseForge: The API token used to publish files on your behalf.
apply() - Method in class net.darkhax.curseforgegradle.TaskPublishCurseForge: This method is called when a gradle defined implementation of this task has been invoked.
apply(Project) - Method in class net.darkhax.curseforgegradle.CurseForgeGradlePlugin

B

beginUpload(String, String) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Triggers the post request to the API that will begin the upload of the artifact.

C

changelog - Variable in class net.darkhax.curseforgegradle.api.metadata.Metadata: The changelog string.
changelog - Variable in class net.darkhax.curseforgegradle.UploadArtifact: An optional changelog for this file.
CHANGELOG_HTML - Static variable in class net.darkhax.curseforgegradle.Constants: The value for an HTML changelog.
CHANGELOG_MARKDOWN - Static variable in class net.darkhax.curseforgegradle.Constants: The value for a Markdown changelog.
CHANGELOG_TEXT - Static variable in class net.darkhax.curseforgegradle.Constants: The value for a plain text changelog.
changelogType - Variable in class net.darkhax.curseforgegradle.api.metadata.Metadata: The changelog type.
changelogType - Variable in class net.darkhax.curseforgegradle.UploadArtifact: The type of changelog being defined.
Constants - Class in net.darkhax.curseforgegradle: This class contains all constants repeatedly used by the plugin.
Constants() - Constructor for class net.darkhax.curseforgegradle.Constants
CurseForgeGradlePlugin - Class in net.darkhax.curseforgegradle: The main plugin class that gets applied by user scripts.
CurseForgeGradlePlugin() - Constructor for class net.darkhax.curseforgegradle.CurseForgeGradlePlugin

D

debugMode - Variable in class net.darkhax.curseforgegradle.TaskPublishCurseForge: Determines if publishing should actually happen.
detectVersions(GameVersions) - Method in class net.darkhax.curseforgegradle.VersionDetector: Initiates the detection of game versions.
disableVersionDetection() - Method in class net.darkhax.curseforgegradle.TaskPublishCurseForge: Disables automatic version detection for all artifacts published through the current task.
displayName - Variable in class net.darkhax.curseforgegradle.api.metadata.Metadata: The display name.
displayName - Variable in class net.darkhax.curseforgegradle.UploadArtifact: The display name for the file on CurseForge.

E

equals(Object) - Method in class net.darkhax.curseforgegradle.api.versions.Version

F

fetch(String, String) - Static method in class net.darkhax.curseforgegradle.CurseForgeGradlePlugin: Creates an HTTP reader with an optional API token that is specified in a format accepted by the CurseForge API.

G

gameVersions - Variable in class net.darkhax.curseforgegradle.api.metadata.Metadata: The supported game versions.
gameVersions - Variable in class net.darkhax.curseforgegradle.UploadArtifact: A set of game versions associated with the artifact.
GameVersions - Class in net.darkhax.curseforgegradle.api.versions: Instances of this class are used to query the CurseForge API for valid game versions.
GameVersions(String, String, String) - Constructor for class net.darkhax.curseforgegradle.api.versions.GameVersions: Users should not be constructing this themselves.
getAdditionalArtifacts() - Method in class net.darkhax.curseforgegradle.UploadArtifact: Provides an immutable collection of additional artifacts for this file.
getArtifact() - Method in class net.darkhax.curseforgegradle.UploadArtifact
getCode() - Method in class net.darkhax.curseforgegradle.api.upload.ResponseError: Gets the error code.
getCurseFileId() - Method in class net.darkhax.curseforgegradle.UploadArtifact
getDetectedVersions() - Method in class net.darkhax.curseforgegradle.VersionDetector: Gets an immutable collection of all the detected game versions.
getGameVersionTypeID() - Method in class net.darkhax.curseforgegradle.api.versions.Version: Gets the version type ID.
getId() - Method in class net.darkhax.curseforgegradle.api.upload.ResponseSuccessful: Gets the file ID of the newly uploaded file.
getId() - Method in class net.darkhax.curseforgegradle.api.versions.Version: Gets the internal CurseForge version ID.
getId() - Method in class net.darkhax.curseforgegradle.api.versions.VersionType: Gets the version type ID.
getId() - Method in class net.darkhax.curseforgegradle.RelationSpecifics
getMessage() - Method in class net.darkhax.curseforgegradle.api.upload.ResponseError: Gets the error message.
getName() - Method in class net.darkhax.curseforgegradle.api.versions.Version: Gets the version name.
getName() - Method in class net.darkhax.curseforgegradle.api.versions.VersionType: Gets the version type name.
getObjectFactory() - Method in class net.darkhax.curseforgegradle.TaskPublishCurseForge
getRelations() - Method in class net.darkhax.curseforgegradle.api.metadata.ProjectRelations: Gets the set of project relationships.
getSlug() - Method in class net.darkhax.curseforgegradle.api.versions.Version: Gets the version slug.
getSlug() - Method in class net.darkhax.curseforgegradle.api.versions.VersionType: Gets the version type slug.
getType() - Method in class net.darkhax.curseforgegradle.RelationSpecifics
getUploadArtifacts() - Method in class net.darkhax.curseforgegradle.TaskPublishCurseForge
getVersion(String) - Method in class net.darkhax.curseforgegradle.api.versions.GameVersions: Gets a Version by it's name or slug.
GSON - Static variable in class net.darkhax.curseforgegradle.Constants: A GSON instance that is used by the plugin to serialize objects to JSON.

H

hashCode() - Method in class net.darkhax.curseforgegradle.api.versions.Version

I

id - Variable in class net.darkhax.curseforgegradle.api.metadata.Relation: The type of relationship.
isEnabled - Variable in class net.darkhax.curseforgegradle.VersionDetector: A flag that determines if the auto-detection is enabled.

L

logUploadMetadata(String) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Logs the URI this artifact would be uploaded to as well as the metadata for this artifact.

M

Metadata - Class in net.darkhax.curseforgegradle.api.metadata: A POJO that represents the metadata value in a CurseForge upload request.
Metadata() - Constructor for class net.darkhax.curseforgegradle.api.metadata.Metadata

N

net.darkhax.curseforgegradle - package net.darkhax.curseforgegradle
net.darkhax.curseforgegradle.api.metadata - package net.darkhax.curseforgegradle.api.metadata
net.darkhax.curseforgegradle.api.upload - package net.darkhax.curseforgegradle.api.upload
net.darkhax.curseforgegradle.api.versions - package net.darkhax.curseforgegradle.api.versions

P

parentFileID - Variable in class net.darkhax.curseforgegradle.api.metadata.Metadata: The parent file ID.
parseLong(Object) - Static method in class net.darkhax.curseforgegradle.TaskPublishCurseForge: Parses a long value from an object.
parseString(Object) - Static method in class net.darkhax.curseforgegradle.TaskPublishCurseForge: Gradle can be annoying and represent strings as non-string objects.
prepareForUpload(GameVersions) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Prepares the artifact for being uploaded.
PRETTY_GSON - Static variable in class net.darkhax.curseforgegradle.Constants: A GSON instance that is used by the plugin to serialize objects to JSON for use in more readable logging.
ProjectRelations - Class in net.darkhax.curseforgegradle.api.metadata: An object that serves as a container for relationships to other projects.
ProjectRelations() - Constructor for class net.darkhax.curseforgegradle.api.metadata.ProjectRelations

R

readString(Reader) - Static method in class net.darkhax.curseforgegradle.CurseForgeGradlePlugin
refresh(String) - Method in class net.darkhax.curseforgegradle.api.versions.GameVersions: Discards the current version data and refreshes it with new data from the API.
Relation - Class in net.darkhax.curseforgegradle.api.metadata: Represents a project relationship in the CurseForge upload metadata.
Relation(String, String, String) - Constructor for class net.darkhax.curseforgegradle.api.metadata.Relation: Creates a new project relationship.
RELATION_EMBEDDED - Static variable in class net.darkhax.curseforgegradle.Constants: The value for an embedded relationship.
RELATION_INCOMPATIBLE - Static variable in class net.darkhax.curseforgegradle.Constants: The value for an incompatible relationship.
RELATION_OPTIONAL - Static variable in class net.darkhax.curseforgegradle.Constants: The value for an optional relationship.
RELATION_REQUIRED - Static variable in class net.darkhax.curseforgegradle.Constants: The value for a required relationship.
RELATION_TOOL - Static variable in class net.darkhax.curseforgegradle.Constants: The value for a tool relationship.
relations - Variable in class net.darkhax.curseforgegradle.api.metadata.Metadata: The relationship metadata.
RelationSpecifics - Class in net.darkhax.curseforgegradle
RelationSpecifics(String, String) - Constructor for class net.darkhax.curseforgegradle.RelationSpecifics
RELEASE_TYPE_ALPHA - Static variable in class net.darkhax.curseforgegradle.Constants: The value for an alpha release.
RELEASE_TYPE_BETA - Static variable in class net.darkhax.curseforgegradle.Constants: The value for a beta release.
RELEASE_TYPE_RELEASE - Static variable in class net.darkhax.curseforgegradle.Constants: The value for a full release.
releaseType - Variable in class net.darkhax.curseforgegradle.api.metadata.Metadata: The release type.
releaseType - Variable in class net.darkhax.curseforgegradle.UploadArtifact: The type of release for this file.
resolveVersions(Set<String>) - Method in class net.darkhax.curseforgegradle.api.versions.GameVersions: Resolves a set of version names/slugs into their CurseForge API Ids.
ResponseError - Class in net.darkhax.curseforgegradle.api.upload: Represents a custom error message from the CurseForge API.
ResponseError() - Constructor for class net.darkhax.curseforgegradle.api.upload.ResponseError
ResponseSuccessful - Class in net.darkhax.curseforgegradle.api.upload: This POJO represents a response from the CurseForge API when a file has been successfully uploaded.
ResponseSuccessful() - Constructor for class net.darkhax.curseforgegradle.api.upload.ResponseSuccessful

S

setId(String) - Method in class net.darkhax.curseforgegradle.RelationSpecifics
setType(String) - Method in class net.darkhax.curseforgegradle.RelationSpecifics
slug - Variable in class net.darkhax.curseforgegradle.api.metadata.Relation: The slug of the project.

T

TaskPublishCurseForge - Class in net.darkhax.curseforgegradle: A Gradle task that can publish multiple files to CurseForge.
TaskPublishCurseForge() - Constructor for class net.darkhax.curseforgegradle.TaskPublishCurseForge: This task should not be constructed manually.
type - Variable in class net.darkhax.curseforgegradle.api.metadata.Relation: The type of relationship.

U

upload(Object, Object) - Method in class net.darkhax.curseforgegradle.TaskPublishCurseForge: Creates a new main level artifact that the plugin will attempt to publish during the TaskPublishCurseForge.publish() step.
upload(Object, Object, Action<UploadArtifact>) - Method in class net.darkhax.curseforgegradle.TaskPublishCurseForge: Creates a new main level artifact that the plugin will attempt to publish during the TaskPublishCurseForge.publish() step.
UploadArtifact - Class in net.darkhax.curseforgegradle: This class defines the script-time representation of an artifact being published to CurseForge.
UploadArtifact(Object, Long, ObjectFactory, Logger, UploadArtifact) - Constructor for class net.darkhax.curseforgegradle.UploadArtifact: These are created using a helper method from TaskPublishCurseForge.

V

VALID_CHANGELOG_TYPES - Static variable in class net.darkhax.curseforgegradle.Constants: An immutable set of all changelog types known to be valid.
VALID_RELATION_TYPES - Static variable in class net.darkhax.curseforgegradle.Constants: An immutable set of all relation types that are known to be valid.
VALID_RELEASE_TYPES - Static variable in class net.darkhax.curseforgegradle.Constants: An immutable set of all release types known to be valid.
Version - Class in net.darkhax.curseforgegradle.api.versions: Represents a valid game version result from a CurseForge API.
Version() - Constructor for class net.darkhax.curseforgegradle.api.versions.Version
VersionDetector - Class in net.darkhax.curseforgegradle: This class is responsible for detecting versions from properties in the build environment.
VersionType - Class in net.darkhax.curseforgegradle.api.versions: Represents a type of game version.
VersionType() - Constructor for class net.darkhax.curseforgegradle.api.versions.VersionType

W

withAdditionalFile(Object) - Method in class net.darkhax.curseforgegradle.UploadArtifact: Creates a new additional file that will be uploaded along with this main file.

A B C D E F G H I L M N P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values