Record Class ScriptBrigadierCommand

java.lang.Object
java.lang.Record
org.skriptlang.skript.bukkit.command.custom.ScriptBrigadierCommand
Record Components:
script - The script this command is defined in.
node - The command node providing functionality for this command.
aliases - Aliases used to reference the command. Can be empty.
description - String describing the command.
namespace - An alternative namespace the command is registered under. If null, this command is registered under the default namespace (typically skript).
public record ScriptBrigadierCommand(Script script, com.mojang.brigadier.tree.LiteralCommandNode<io.papermc.paper.command.brigadier.CommandSourceStack> node, Collection<String> aliases, @Nullable String description, @Nullable String usage, @Nullable String namespace, @Nullable String permission) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScriptBrigadierCommand(Script script, com.mojang.brigadier.tree.LiteralCommandNode<io.papermc.paper.command.brigadier.CommandSourceStack> node, Collection<String> aliases, @Nullable String description, @Nullable String usage, @Nullable String namespace, @Nullable String permission)
    Creates an instance of a ScriptBrigadierCommand record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Collection<String>
    aliases()
    Returns the value of the aliases record component.
    @Nullable String
    description()
    Returns the value of the description record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    @Nullable String
    namespace()
    Returns the value of the namespace record component.
    com.mojang.brigadier.tree.LiteralCommandNode<io.papermc.paper.command.brigadier.CommandSourceStack>
    node()
    Returns the value of the node record component.
    @Nullable String
    permission()
    Returns the value of the permission record component.
    Script
    script()
    Returns the value of the script record component.
    final String
    toString()
    Returns a string representation of this record class.
    @Nullable String
    usage()
    Returns the value of the usage record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ScriptBrigadierCommand

      public ScriptBrigadierCommand(Script script, com.mojang.brigadier.tree.LiteralCommandNode<io.papermc.paper.command.brigadier.CommandSourceStack> node, Collection<String> aliases, @Nullable @Nullable String description, @Nullable @Nullable String usage, @Nullable @Nullable String namespace, @Nullable @Nullable String permission)
      Creates an instance of a ScriptBrigadierCommand record class.
      Parameters:
      script - the value for the script record component
      node - the value for the node record component
      aliases - the value for the aliases record component
      description - the value for the description record component
      usage - the value for the usage record component
      namespace - the value for the namespace record component
      permission - the value for the permission record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • script

      public Script script()
      Returns the value of the script record component.
      Returns:
      the value of the script record component

    • node

      public com.mojang.brigadier.tree.LiteralCommandNode<io.papermc.paper.command.brigadier.CommandSourceStack> node()
      Returns the value of the node record component.
      Returns:
      the value of the node record component

    • aliases

      public Collection<String> aliases()
      Returns the value of the aliases record component.
      Returns:
      the value of the aliases record component

    • description

      @Nullable public @Nullable String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • usage

      @Nullable public @Nullable String usage()
      Returns the value of the usage record component.
      Returns:
      the value of the usage record component

    • namespace

      @Nullable public @Nullable String namespace()
      Returns the value of the namespace record component.
      Returns:
      the value of the namespace record component

    • permission

      @Nullable public @Nullable String permission()
      Returns the value of the permission record component.
      Returns:
      the value of the permission record component