View on GitHub
ExecutableCommand Protocol Reference
-
Closure type this command will execute.
Declaration
Swift
associatedtype Execute -
Closure to execute when command is invoked.
Declaration
Swift
var closure: Execute { get } -
Used for FunctionBuilder Copy On Write.
Declaration
Swift
func copyWith(name: String, group: String?, alias: [String], hookWhitelist: [HookID], permissionChecks: [CommandPermissionChecker], closure: Execute) -> Self -
readableArgumentsExtension methodHuman readable string of arguments required for this command.
command.readableArguments // "<a:Int> <b:Int> [c:String]"Declaration
Swift
var readableArguments: String? { get } -
triggerExtension methodTrigger of the command.
Synonym for
ExecutableCommand.nameDeclaration
Swift
var trigger: String { get } -
helpExtension methodHuman readable help string explaining command usage.
Declaration
Swift
var help: String { get } -
fullTriggerExtension methodDeclaration
Swift
var fullTrigger: String { get } -
onHook(_:Extension method) Adds a hook to the whitelist.
See
hookWhitelistDeclaration
Swift
func onHook(_ hook: HookID) -> SelfParameters
hookHookID to whitelist.
-
alias(_:Extension method) Adds an alias to this command.
See
aliasDeclaration
Swift
func alias(_ string: String) -> SelfParameters
stringAlias to add.
-
check(_:Extension method) Adds a check to this command.
See
permissionChecksDeclaration
Swift
func check(_ c: CommandPermissionChecker) -> SelfParameters
cCheck to add.
-
group(_:Extension method) Sets the group of this command.
See
groupDeclaration
Swift
func group(_ group: String) -> SelfParameters
groupGroup to add.
-
execute(_:Extension method) -
executables()Extension methodDeclaration
Swift
func executables() -> [_ExecutableCommand]
SwiftHooks Docs (83% documented)