Class: Discorb::ApplicationCommand::Command::GroupCommand

Inherits:
Discorb::ApplicationCommand::Command show all
Defined in:
lib/discorb/app_command/command.rb

Overview

Represents the command with subcommands.

Direct Known Subclasses

SubcommandGroup

Instance Attribute Summary collapse

Attributes inherited from Discorb::ApplicationCommand::Command

#block, #default_permission, #dm_permission, #guild_ids, #name, #type, #type_raw

Instance Method Summary collapse

Methods inherited from DiscordModel

#==, #eql?, #inspect

Instance Attribute Details

#commands ⇒ Array<Discorb::ApplicationCommand::Command> (readonly)

Returns The subcommands of the command.

Returns:



254
255
256
 
# File 'lib/discorb/app_command/command.rb', line 254

def commands
  @commands
end

#description ⇒ Hash{String => String} (readonly)

Returns The description of the command.

Returns:

  • (Hash{String => String}) —

    The description of the command.



256
257
258
 
# File 'lib/discorb/app_command/command.rb', line 256

def description
  @description
end

Instance Method Details

#group(command_name, description) {|group| ... } ⇒ Discorb::ApplicationCommand::Command::SubcommandGroup

Add new subcommand group.

Parameters:

  • command_name (String) —

    Group name.

  • description (String) —

    Group description.

Yields:

  • Block to yield with the command.

Yield Parameters:

Returns:

See Also:



332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/discorb/app_command/command.rb', line 332

def group(command_name, description)
  command =
    Discorb::ApplicationCommand::Command::SubcommandGroup.new(
      command_name,
      description,
      self,
      @client
    )
  yield command if block_given?
  @commands << command
  command
end

#slash(command_name, description, options = {}, dm_permission: true, default_permission: nil, &block) ⇒ Discorb::ApplicationCommand::Command::ChatInputCommand

Add new subcommand.

Parameters:

  • command_name (String, Hash{Symbol => String}) —

    Command name. If hash is passed, it must be a pair of Language code and Command name, and :default key is required. You can use _ instead of - in language code.

  • description (String, Hash{Symbol => String}) —

    Command description. If hash is passed, it must be a pair of Language code and Command description, and :default key is required.

  • options (Hash{String => Hash{:description => String, :optional => Boolean, :type => Object}}) (defaults to: {}) —

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

    | Key | Type | Description | | --- | --- | --- | | :name_localizations | Hash=> String | Localizations of option name. | | :description | String | Hash{Symbol => String} | Description of the option. If hash is passed, it must be a pair of Language code and description, and :default key is required. You can use _ instead of - in language code. | | :required | Boolean(true | false) | Whether the argument is required. optional will be used if not specified. | | :optional | Boolean(true | false) | Whether the argument is optional. required will be used if not specified. | | :type | Object | Type of the option. | | :choices | Hash{String => String, Integer, Float} | Type of the option. | | :choices_localizations | Hash{String => Hash{Symbol => String}} | Localization of the choice. Key must be the name of a choice. | | :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) | | :length | Range | Range of length of the option. Only valid for :string. |

  • guild_ids (Array<#to_s>, false, nil) —

    Guild IDs to set the command to. false to global command, nil to use default.

  • dm_permission (Boolean) (defaults to: true) —

    Whether the command is available in DM.

  • default_permission (Discorb::Permission) (defaults to: nil) —

    The default permission of the command.

  • block (Proc) —

    Command block.

Returns:



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/discorb/app_command/command.rb', line 294

def slash(
  command_name,
  description,
  options = {},
  dm_permission: true,
  default_permission: nil,
  &block
)
  command =
    Discorb::ApplicationCommand::Command::ChatInputCommand.new(
      command_name,
      description,
      options,
      [],
      block,
      1,
      self,
      dm_permission,
      default_permission
    )
  @client.callable_commands << command
  @commands << command
  command
end

#to_s ⇒ String

Returns the command name.

Returns:

  • (String) —

    The command name.



350
351
352
 
# File 'lib/discorb/app_command/command.rb', line 350

def to_s
  @name["default"]
end