Shield

open class Shield: Sword

Shield class that extends Sword

Properties

commandAliases
Object pointing command aliases to their respected full name
Declaration
Swift

public var commandAliases = [String: (casePreserved: String, target: String)]()
commands
Object pointing command names to their Command Object
Declaration
Swift

public var commands = [String: Commandable]()
shieldOptions
Shield Options structure
Declaration
Swift

public var shieldOptions: ShieldOptions

Initializer


                    
                    
                    init(token:with:and:)

Creates a Shield class to use commands with

Declaration

Swift

public init(
    token: String,
    with swordOptions: SwordOptions = SwordOptions(),
    and shieldOptions: ShieldOptions = ShieldOptions()
  )

Functions


                    
                    
                    register(_:)

Registers a command

Declaration

Swift

public func register(_ command: Commandable)


                    
                    
                    register(_:with:_:)

Registers a command

Declaration

Swift

public func register(
    _ commandName: String,
    with options: CommandOptions = CommandOptions(),
    _ function: @escaping (Message, [String]) -> ()
  )


                    
                    
                    register(_:with:message:)

Registers a command

Declaration

Swift

public func register(
    _ commandName: String,
    with options: CommandOptions = CommandOptions(),
    message: String
  )

unregister(_:)
Unregisters a command
Declaration
Swift

public func unregister(_ commandName: String)