index.md

subkt / myaa.subkt.tasks / Swap

Swap

open class Swap : ASSTask (source)

Task to enable/disable honorifics and the like using the same syntax as Daiz's autoswapper.

On the lines whose style name matches styles, e.g. Karen{**-chan} will turn into Karen{*}-chan{*}, and {*}Miu{Nee-nee} will become {}Nee-nee{*Miu}. Further, any line where the effect line contains the string specified by lineMarker will be commented if it is not a comment already, and will otherwise be uncommented.

A predefined task instance can be accessed through Subs.swap.

Example usage:

Constructors

Name	Summary
<init>	Swap() Task to enable/disable honorifics and the like using the same syntax as Daiz's autoswapper.

Properties

Name	Summary
delimiter	val delimiter: Property<String!>! The delimiter used in expressions like Karen{**-chan}. Defaults to *.
from	val from: ConfigurableFileCollection! Specifies the source ASS file.
lineMarker	val lineMarker: Property<String!>! Lines with an effect field matching this string will be toggled between being commented and uncommented. Defaults to ***. styles has no bearing on this operation.
styles	val styles: Property<Any> Only lines with a style name matching the specified pattern will have their contents swapped. Defaults to `Regex("Main

Inherited Properties

Name	Summary
includeExtraData	val includeExtraData: Property<Boolean!>! Whether to include the Aegisub Extradata section.
includeProjectGarbage	val includeProjectGarbage: Property<Boolean!>! Whether to include the Aegisub Project Garbage section.
out	val out: ConfigurableFileCollection The location to save the ASS file. Defaults to an automatically generated file in the build directory.
removeComments	val removeComments: Property<Boolean!>! Whether to remove comments from the output file.

Functions

Name	Summary
buildAss	open fun buildAss(): ASSFile Constructs the ASS file to save. Must be implemented by subtypes.

Inherited Functions

Name	Summary
run	open fun run(): Unit

Extension Properties

Name	Summary
batch	val Task.batch: String The same as entry if this is a batch task; error otherwise.
currentTask	val Task.currentTask: String The name of this task.
entry	val Task.entry: String The entry (batch or episode) this task corresponds to.
episode	val Task.episode: String The same as entry if this is an episode task; error otherwise.
episodes	val Task.episodes: List<String> The episodes this task corresponds to. A single-item list containing episode if this is an episode task; a list of the episodes for the batch given by batch otherwise.
isBatch	val Task.isBatch: Boolean True if this task is a batch task.
release	val Task.release: String The release this task was generated for.
taskGroup	val <T : Task> T.taskGroup: TaskGroup<T> The TaskGroup instance this task belongs to.

Extension Functions

Name	Summary
defaultProperty	fun <T> Task.defaultProperty(default: T): Property<T> Returns a Property with a default value set.
evaluate	fun Task.evaluate(expression: String): Provider<List<String>!>! Evaluates a string using Velocity, splits it on `
evaluateTemplate	fun Task.evaluateTemplate(expression: String): Provider<String!>! Like evaluate but only processes the template syntax, without globbing.
get	fun Task.get(propertyName: String): Provider<String!>! Searches for the given property in the Subs object's SubProperties instance, evaluates its value using evaluate, and returns a single string, assuming that the resulting list contains only one element.
getAs	fun <T> Task.getAs(propertyName: String): Provider<T>! Searches for the given property in the Subs object's SubProperties instance, evaluates its value using evaluate, and returns a single string, cast to the given type using String.asType, assuming that the resulting list contains only one element.
getFile	fun Task.getFile(filename: String): Provider<String!>! fun Task.getFile(filename: Provider<String>): Provider<String!>! Reads the specified file and processes it using Velocity.
getList	fun Task.getList(propertyName: String): Provider<List<String>> Searches for the given property in the Subs object's SubProperties instance, and evaluates its value using evaluate.
getListAs	fun <T> Task.getListAs(propertyName: String): Provider<List<T>!>! Searches for the given property in the Subs object's SubProperties instance, evaluates its value using evaluate, and casts the list elements to the given type using String.asType.
getRaw	fun Task.getRaw(propertyName: String): String Searches for the given property in the Subs object's SubProperties instance, and returns the raw string. Raises an error if not found.
getRawMaybe	fun Task.getRawMaybe(propertyName: String): String? Searches for the given property in the Subs object's SubProperties instance, and returns the raw string, possibly null.
outputFile	fun Task.outputFile(extension: String): ConfigurableFileCollection Returns a ConfigurableFileCollection containing a single file taskName.extension located in the build directory.
propertyExists	fun Task.propertyExists(propertyName: String): Boolean Returns true if the given property exists in the Subs object's SubProperties instance for the given context.