程序包 net.md_5.bungee.api.chat

类 BaseComponent

java.lang.Object
net.md_5.bungee.api.chat.BaseComponent
直接已知子类:
KeybindComponent, ScoreComponent, SelectorComponent, TextComponent, TranslatableComponent
public abstract class BaseComponent extends Object

  • 构造器详细资料

    • BaseComponent

      @Deprecated public BaseComponent()
      已过时。
      仅供内部使用, 将被移除
      默认构造器.

  • 方法详细资料

    • copyFormatting

      public void copyFormatting(BaseComponent component)
      复制指定 BaseComponent 的事件和格式. 已设置的格式将被替换.

      原文:Copies the events and formatting of a BaseComponent. Already set formatting will be replaced.

      参数:
      component - 要复制的组件

    • copyFormatting

      public void copyFormatting(BaseComponent component, boolean replace)
      复制指定 BaseComponent 的事件和格式.

      原文:Copies the events and formatting of a BaseComponent.

      参数:
      component - 要复制的组件
      replace - 已设置的格式是否被新的组件替换

    • copyFormatting

      public void copyFormatting(BaseComponent component, ComponentBuilder.FormatRetention retention, boolean replace)
      复制某个 BaseComponent 中的指定格式.

      原文:Copies the specified formatting of a BaseComponent.

      参数:
      component - 要复制的组件
      retention - 要复制的格式
      replace - 已设置的格式是否被新的组件替换

    • retain

      public void retain(ComponentBuilder.FormatRetention retention)
      仅保留指定的格式.

      原文:Retains only the specified formatting.

      参数:
      retention - 要保留的格式

    • duplicate

      public abstract BaseComponent duplicate()
      克隆本组件并返回克隆副本.

      原文:Clones the BaseComponent and returns the clone.

      返回:
      该组件的副本

    • duplicateWithoutFormatting

      @Deprecated public BaseComponent duplicateWithoutFormatting()
      已过时。
      不鼓励使用本 API, 建议使用传统克隆副本
      克隆本组件并返回克隆副本, 不保留原副本的格式.

      原文:Clones the BaseComponent without formatting and returns the clone.

      返回:
      该组件的副本

    • toLegacyText

      public static String toLegacyText(BaseComponent... components)
      将聊天组件转化为颜色代码文本.

      原文:Converts the components to a string that uses the old formatting codes (ChatColor.COLOR_CHAR

      参数:
      components - 要转化的组件
      返回:
      旧版颜色代码文本

    • toPlainText

      public static String toPlainText(BaseComponent... components)
      将聊天组件转化为字符串, 丢弃所有格式.

      原文:Converts the components into a string without any formatting

      参数:
      components - 要转化的组件
      返回:
      纯文本

    • getColor

      public ChatColor getColor()
      Returns the color of this component. This uses the parent's color if this component doesn't have one. ChatColor.WHITE is returned if no color is found.
      返回:
      the color of this component

    • getColorRaw

      public ChatColor getColorRaw()
      Returns the color of this component without checking the parents color. May return null
      返回:
      the color of this component

    • getFont

      public String getFont()
      Returns the font of this component. This uses the parent's font if this component doesn't have one.
      返回:
      the font of this component, or null if default font

    • getFontRaw

      public String getFontRaw()
      Returns the font of this component without checking the parents font. May return null
      返回:
      the font of this component

    • isBold

      public boolean isBold()
      Returns whether this component is bold. This uses the parent's setting if this component hasn't been set. false is returned if none of the parent chain has been set.
      返回:
      whether the component is bold

    • isBoldRaw

      public Boolean isBoldRaw()
      Returns whether this component is bold without checking the parents setting. May return null
      返回:
      whether the component is bold

    • isItalic

      public boolean isItalic()
      Returns whether this component is italic. This uses the parent's setting if this component hasn't been set. false is returned if none of the parent chain has been set.
      返回:
      whether the component is italic

    • isItalicRaw

      public Boolean isItalicRaw()
      Returns whether this component is italic without checking the parents setting. May return null
      返回:
      whether the component is italic

    • isUnderlined

      public boolean isUnderlined()
      Returns whether this component is underlined. This uses the parent's setting if this component hasn't been set. false is returned if none of the parent chain has been set.
      返回:
      whether the component is underlined

    • isUnderlinedRaw

      public Boolean isUnderlinedRaw()
      Returns whether this component is underlined without checking the parents setting. May return null
      返回:
      whether the component is underlined

    • isStrikethrough

      public boolean isStrikethrough()
      Returns whether this component is strikethrough. This uses the parent's setting if this component hasn't been set. false is returned if none of the parent chain has been set.
      返回:
      whether the component is strikethrough

    • isStrikethroughRaw

      public Boolean isStrikethroughRaw()
      Returns whether this component is strikethrough without checking the parents setting. May return null
      返回:
      whether the component is strikethrough

    • isObfuscated

      public boolean isObfuscated()
      Returns whether this component is obfuscated. This uses the parent's setting if this component hasn't been set. false is returned if none of the parent chain has been set.
      返回:
      whether the component is obfuscated

    • isObfuscatedRaw

      public Boolean isObfuscatedRaw()
      Returns whether this component is obfuscated without checking the parents setting. May return null
      返回:
      whether the component is obfuscated

    • setExtra

      public void setExtra(List<BaseComponent> components)

    • addExtra

      public void addExtra(String text)
      Appends a text element to the component. The text will inherit this component's formatting
      参数:
      text - the text to append

    • addExtra

      public void addExtra(BaseComponent component)
      Appends a component to the component. The text will inherit this component's formatting
      参数:
      component - the component to append

    • hasFormatting

      public boolean hasFormatting()
      Returns whether the component has any formatting or events applied to it
      返回:
      Whether any formatting or events are applied

    • toPlainText

      public String toPlainText()
      Converts the component into a string without any formatting
      返回:
      the string as plain text

    • toLegacyText

      public String toLegacyText()
      Converts the component to a string that uses the old formatting codes (ChatColor.COLOR_CHAR
      返回:
      the string in the old format

    • setColor

      public void setColor(ChatColor color)
      该组件及其子组件的颜色(除非子组件定义了自己的颜色覆盖母组件的颜色).

    • setFont

      public void setFont(String font)
      该组件及其子组件的字体(除非子组件定义了自己的字体覆盖母组件的字体).

    • setBold

      public void setBold(Boolean bold)
      该组件及其子组件是否加粗(子组件可定义它们各自的颜色及其格式来覆盖母组件的设定, 下同).

    • setItalic

      public void setItalic(Boolean italic)
      该组件及其子组件是否为斜体(可覆盖).

    • setUnderlined

      public void setUnderlined(Boolean underlined)
      该组件及其子组件是否添加下划线(可覆盖).

    • setStrikethrough

      public void setStrikethrough(Boolean strikethrough)
      该组件及其子组件是否添加删除线(可覆盖).

    • setObfuscated

      public void setObfuscated(Boolean obfuscated)
      该组件及其子组件是否为随机字符(可覆盖).

    • setInsertion

      public void setInsertion(String insertion)
      当按住shift键点击此组件(包含子组件)时, 向聊天消息输入框插入的文本.

    • setClickEvent

      public void setClickEvent(ClickEvent clickEvent)
      当此组件(含子组件)被点击时执行的动作.

    • setHoverEvent

      public void setHoverEvent(HoverEvent hoverEvent)
      当鼠标光标悬浮在此组件(含子组件)时执行的动作.

    • toString

      public String toString()
      覆盖:
      toString 在类中 Object

    • equals

      public boolean equals(Object o)
      覆盖:
      equals 在类中 Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      覆盖:
      hashCode 在类中 Object

    • getInsertion

      public String getInsertion()
      当按住shift键点击此组件(包含子组件)时, 向聊天消息输入框插入的文本.

    • getExtra

      public List<BaseComponent> getExtra()
      继承该组件的格式和事件的附加组件.

    • getClickEvent

      public ClickEvent getClickEvent()
      当此组件(含子组件)被点击时执行的动作.

    • getHoverEvent

      public HoverEvent getHoverEvent()
      当鼠标光标悬浮在此组件(含子组件)时执行的动作.