Usage

class Usage<T>(arguments: List<Argument<*, T>>, description: String?, permission: Permission?, action: ContextAction<T>?)
Content copied to clipboard

Command usage and definition

Constructors

Usage
Link copied to clipboard
fun <T> Usage(arguments: List<Argument<*, T>>, description: String? = null, permission: Permission? = null, action: ContextAction<T>? = null)
Content copied to clipboard

Properties

action
Link copied to clipboard
val action: ContextAction<T>? = null
Content copied to clipboard

What will be executed if you enter this definition.

arguments
Link copied to clipboard
val arguments: List<Argument<*, T>>
Content copied to clipboard

A list of arguments. This is also used for the definition.

description
Link copied to clipboard
val description: String? = null
Content copied to clipboard

Explanation of usage and definition. Used in the default help message.

permission
Link copied to clipboard
val permission: Permission? = null
Content copied to clipboard

The privileges required to execute this definition. The default is specified by the FlyLibBuilder defaultPermission.