Class: Discorb::ApplicationCommand::Command::SubcommandGroup

Inherits:
GroupCommand show all
Defined in:
lib/discorb/app_command/command.rb

Overview

Represents the subcommand group.

Instance Attribute Summary collapse

Attributes inherited from GroupCommand

#description

Attributes inherited from Discorb::ApplicationCommand::Command

#block, #guild_ids, #id_map, #name, #type, #type_raw

Instance Method Summary collapse

Methods inherited from GroupCommand

#group

Methods inherited from DiscordModel

#==, #eql?, #inspect

Instance Attribute Details

#commandsArray<Discorb::ApplicationCommand::Command::SlashCommand> (readonly)

Returns The subcommands of the command.

Returns:

  • The subcommands of the command.



296
297
298
# File 'lib/discorb/app_command/command.rb', line 296

def commands
  @commands
end

Instance Method Details

#slash(command_name, description, options = {}, &block) ⇒ Discorb::ApplicationCommand::Command::SlashCommand

Add new subcommand.

Parameters:

  • Command name.

  • Command description.

  • (defaults to: {})

    Command options. The key is the option name, the value is a hash with the following keys:

    Key Type Description
    :description String Description of the option.
    :required Whether the argument is required. optional will be used if not specified.
    :optional Whether the argument is optional. required will be used if not specified.
    :type Object Type of the option.
    :choice Hash{String => String, Integer, Float} Type of the option.
    :default Object Default value of the option.
    :channel_types Array<Class<Discorb::Channel>> Type of the channel option.
    :autocomplete Proc Autocomplete function.
    :range Range Range of the option. Only valid for numeric options. (:int, :float)
  • Guild IDs to set the command to. false to global command, nil to use default.

  • Command block.

Returns:

  • The added subcommand.



322
323
324
325
326
327
# File 'lib/discorb/app_command/command.rb', line 322

def slash(command_name, description, options = {}, &block)
  command = Discorb::ApplicationCommand::Command::SlashCommand.new(command_name, description, options, [], block, 1, @parent + " " + @name)
  @commands << command
  @client.bottom_commands << command
  command
end

#to_sObject



313
314
315
# File 'lib/discorb/app_command/command.rb', line 313

def to_s
  @parent + " " + @name
end