ProcessingLibraryProperties

abstract class ProcessingLibraryProperties @Inject constructor(objects: ObjectFactory)

Configures the Processing Library properties

Constructors

Link copied to clipboard
@Inject
constructor(objects: ObjectFactory)

Properties

Link copied to clipboard
@get:Input
abstract val authors: Property<String>

List of authors.

Link copied to clipboard
@get:Input
abstract val categories: SetProperty<LibraryCategory>

The categories of your library. (Use category instead if single)

Link copied to clipboard
@get:Internal
var category: LibraryCategory

The category of your library. (Use categories instead if multiple)

Link copied to clipboard
@get:Input
abstract val maxRevision: Property<Int>
Link copied to clipboard
@get:Input
abstract val minRevision: Property<Int>
Link copied to clipboard
@get:Input
abstract val name: Property<String>

The name of your library as you want it formatted.

Link copied to clipboard
@get:Input
abstract val paragraph: Property<String>

Additional information suitable for the Processing website. The value of 'sentence' will always be prepended, so you should start by writing the second sentence here. If your library only works on certain operating systems, mention it here.

Link copied to clipboard
@get:Input
abstract val prettyVersion: Property<String>

The version as the user will see it. If blank, the version attribute will be used here. This should be a single word, with no spaces.

Link copied to clipboard
@get:Internal
var revisionRange: IntRange

The min and max revision of Processing compatible with your library. Note that these fields use the revision and not the version of Processing, parsable as an int. For example, the revision number for 2.2.1 is 227. You can find the revision numbers in the release tags: Processing 4 tags Only use maxRevision (or minRevision), when your library is known to break in a later (or earlier) release. Otherwise, use the default value 0.

Link copied to clipboard
@get:Input
abstract val sentence: Property<String>

A short sentence (or fragment) to summarize the library's function. This will be shown from inside the PDE when the library is being installed. Avoid repeating the name of your library here. Also, avoid saying anything redundant like mentioning that it's a library. This should start with a capitalized letter, and end with a period.

Link copied to clipboard
@get:Input
abstract val url: Property<String>

A web page for your library, NOT a direct link to where to download it.

Link copied to clipboard
@get:Input
abstract val version: Property<Int>

A version number that increments once with each release. This is used to compare different versions of the same library, and check if an update is available. You should think of it as a counter, counting the total number of releases you've had.

Functions

Link copied to clipboard
fun author(action: Action<LibraryAuthor>)

Configure solo author

Link copied to clipboard
fun authors(action: Action<LibraryAuthorContainer>)

Configure authors