From c29912ac0645d1eac885d86d28cedd3fa2e4601b Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Sun, 24 Sep 2023 15:34:55 +0000 Subject: [PATCH] Update JavaDocs (0b3a380) --- allclasses-index.html | 31 +- allpackages-index.html | 7 +- constant-values.html | 7 +- deprecated-list.html | 92 ++++++ help-doc.html | 12 +- index-all.html | 75 ++++- index.html | 9 +- member-search-index.js | 2 +- overview-summary.html | 6 +- overview-tree.html | 8 +- type-search-index.js | 2 +- us/teaminceptus/vortexsidebars/Sidebar.html | 24 +- .../vortexsidebars/class-use/Sidebar.html | 7 +- .../vortexsidebars/package-summary.html | 7 +- .../vortexsidebars/package-tree.html | 7 +- .../vortexsidebars/package-use.html | 7 +- .../vortexsidebars/text/AnimatedText.html | 7 +- .../vortexsidebars/text/Field.html | 28 +- .../vortexsidebars/text/FieldText.html | 109 +++++-- .../vortexsidebars/text/FunctionText.html | 266 ++++++++++++++++++ us/teaminceptus/vortexsidebars/text/Text.html | 9 +- .../vortexsidebars/text/TextColor.html | 12 +- .../text/class-use/AnimatedText.html | 7 +- .../vortexsidebars/text/class-use/Field.html | 36 ++- .../text/class-use/FieldText.html | 7 +- .../text/class-use/FunctionText.html | 63 +++++ .../vortexsidebars/text/class-use/Text.html | 69 ++++- .../text/class-use/TextColor.html | 7 +- .../vortexsidebars/text/package-summary.html | 27 +- .../vortexsidebars/text/package-tree.html | 8 +- .../vortexsidebars/text/package-use.html | 11 +- 31 files changed, 818 insertions(+), 151 deletions(-) create mode 100644 deprecated-list.html create mode 100644 us/teaminceptus/vortexsidebars/text/FunctionText.html create mode 100644 us/teaminceptus/vortexsidebars/text/class-use/FunctionText.html diff --git a/allclasses-index.html b/allclasses-index.html index 1b4a289..d07fdea 100644 --- a/allclasses-index.html +++ b/allclasses-index.html @@ -1,11 +1,11 @@ - -All Classes and Interfaces (VortexSidebars 1.0.1 API) + +All Classes and Interfaces (VortexSidebars 1.1.0 API) - + @@ -37,6 +37,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -64,22 +65,28 @@

    All Classes and Interfaces<
    AnimatedText
     
    Field
    -
    -
    Represents a Field that holds an output.
    +
    Deprecated. +
    Use FunctionText instead.
    FieldText
    -
     
    -
    Sidebar
    +
    Deprecated. +
    Use FunctionText instead.
    +
    +
    FunctionText
    -
    Represents a Sidebar that can be displayed to players.
    +
    Works as a text object but with a lambda.
    -
    Text
    +
    Sidebar
    +
    Represents a Sidebar that can be displayed to players.
    +
    +
    Text
    +
    Simple object that holds a String, used in order to allow for AnimatedText and FieldText
    -
    TextColor
    -
    -
    An alternative to ChatColor that allows custom hex colors
    +
    TextColor
    +
    +
    An alternative to ChatColor that allows for custom hex colors.
    diff --git a/allpackages-index.html b/allpackages-index.html index cec5bf0..b4ad386 100644 --- a/allpackages-index.html +++ b/allpackages-index.html @@ -1,11 +1,11 @@ - -All Packages (VortexSidebars 1.0.1 API) + +All Packages (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/constant-values.html b/constant-values.html index 38cfbf9..995e097 100644 --- a/constant-values.html +++ b/constant-values.html @@ -1,11 +1,11 @@ - -Constant Field Values (VortexSidebars 1.0.1 API) + +Constant Field Values (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/deprecated-list.html b/deprecated-list.html new file mode 100644 index 0000000..66e2b5a --- /dev/null +++ b/deprecated-list.html @@ -0,0 +1,92 @@ + + + + +Deprecated List (VortexSidebars 1.1.0 API) + + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Deprecated API

    +

    Contents

    + +
    + +
    +
    +
    +

    Copyright © 2023. All rights reserved.

    +
    +
    +
    + + diff --git a/help-doc.html b/help-doc.html index 4ad5165..3a4bd8c 100644 --- a/help-doc.html +++ b/help-doc.html @@ -1,11 +1,11 @@ - -API Help (VortexSidebars 1.0.1 API) + +API Help (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -70,6 +71,7 @@

    JavaDoc Help

  • Other Files
  • Use
  • Tree (Class Hierarchy)
    • +
  • Deprecated API
  • Constant Field Values
  • All Packages
  • All Classes and Interfaces
    • @@ -162,6 +164,10 @@

    Tree (Class Hierarchy)

  • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
    • +
    +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +

    Constant Field Values

    The Constant Field Values page lists the static final fields and their values.

    diff --git a/index-all.html b/index-all.html index cdbb9c5..a21d5df 100644 --- a/index-all.html +++ b/index-all.html @@ -1,11 +1,11 @@ - -Index (VortexSidebars 1.0.1 API) + +Index (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -117,22 +118,47 @@

    F

    Field - Class in us.teaminceptus.vortexsidebars.text
    -
    Represents a Field that holds an output.
    +
    Deprecated. +
    Use FunctionText instead. +

    + Note: there are no current plans to remove Field or FieldText. +

    +
    Field(Callable<Object>) - Constructor for class us.teaminceptus.vortexsidebars.text.Field
    +
    Deprecated.
    Usage: new Field(() -> someFunction())
    FieldText - Class in us.teaminceptus.vortexsidebars.text
    -
     
    +
    +
    Deprecated. +
    Use FunctionText instead. +

    + Note: there are no current plans to remove Field or FieldText. +

    +
    +
    FieldText(Field) - Constructor for class us.teaminceptus.vortexsidebars.text.FieldText
    -
     
    +
    +
    Deprecated.
    + 
    FieldText(Field, Text, Text) - Constructor for class us.teaminceptus.vortexsidebars.text.FieldText
    -
     
    +
    +
    Deprecated.
    + 
    fromHex(String) - Static method in interface us.teaminceptus.vortexsidebars.text.TextColor
    Converts a Hex Code to a Color Code.
    +
    FunctionText - Class in us.teaminceptus.vortexsidebars.text
    +
    +
    Works as a text object but with a lambda.
    +
    +
    FunctionText(Callable<String>) - Constructor for class us.teaminceptus.vortexsidebars.text.FunctionText
    +
     
    +
    FunctionText(Callable<String>, Text, Text) - Constructor for class us.teaminceptus.vortexsidebars.text.FunctionText
    +
     

    G

    @@ -141,6 +167,10 @@

    G

    getDelay() - Method in class us.teaminceptus.vortexsidebars.text.AnimatedText
     
    getField() - Method in class us.teaminceptus.vortexsidebars.text.FieldText
    +
    +
    Deprecated.
    + 
    +
    getFunction() - Method in class us.teaminceptus.vortexsidebars.text.FunctionText
     
    getLines() - Method in class us.teaminceptus.vortexsidebars.Sidebar
    @@ -149,10 +179,22 @@

    G

    getPlayers() - Method in class us.teaminceptus.vortexsidebars.Sidebar
     
    getPrefix() - Method in class us.teaminceptus.vortexsidebars.text.FieldText
    +
    +
    Deprecated.
    + 
    +
    getPrefix() - Method in class us.teaminceptus.vortexsidebars.text.FunctionText
     
    getSuffix() - Method in class us.teaminceptus.vortexsidebars.text.FieldText
    +
    +
    Deprecated.
    + 
    +
    getSuffix() - Method in class us.teaminceptus.vortexsidebars.text.FunctionText
     
    getText() - Method in class us.teaminceptus.vortexsidebars.text.FieldText
    +
    +
    Deprecated.
    + 
    +
    getText() - Method in class us.teaminceptus.vortexsidebars.text.FunctionText
     
    getText() - Method in class us.teaminceptus.vortexsidebars.text.Text
    @@ -168,6 +210,7 @@

    G

    getValue() - Method in class us.teaminceptus.vortexsidebars.text.Field
    +
    Deprecated.
    Fetches the output of the function.
    GOLD - Static variable in interface us.teaminceptus.vortexsidebars.text.TextColor
    @@ -222,13 +265,27 @@

    S

    setDelay(int) - Method in class us.teaminceptus.vortexsidebars.text.AnimatedText
     
    +
    setField(Field) - Method in class us.teaminceptus.vortexsidebars.text.FieldText
    +
    +
    Deprecated.
    + 
    +
    setFunction(Callable<String>) - Method in class us.teaminceptus.vortexsidebars.text.FunctionText
    +
     
    setIndex(int) - Method in class us.teaminceptus.vortexsidebars.text.AnimatedText
     
    setPaused(boolean) - Method in class us.teaminceptus.vortexsidebars.text.AnimatedText
     
    setPrefix(Text) - Method in class us.teaminceptus.vortexsidebars.text.FieldText
    +
    +
    Deprecated.
    + 
    +
    setPrefix(Text) - Method in class us.teaminceptus.vortexsidebars.text.FunctionText
     
    setSuffix(Text) - Method in class us.teaminceptus.vortexsidebars.text.FieldText
    +
    +
    Deprecated.
    + 
    +
    setSuffix(Text) - Method in class us.teaminceptus.vortexsidebars.text.FunctionText
     
    setText(String) - Method in class us.teaminceptus.vortexsidebars.text.Text
    @@ -254,6 +311,8 @@

    S

    Creates a new Sidebar.
    +
    Sidebar(Plugin, Text, List<Text>, long) - Constructor for class us.teaminceptus.vortexsidebars.Sidebar
    +
     
    STRIKETHROUGH - Static variable in interface us.teaminceptus.vortexsidebars.text.TextColor
     
    @@ -269,7 +328,7 @@

    T

    TextColor - Interface in us.teaminceptus.vortexsidebars.text
    -
    An alternative to ChatColor that allows custom hex colors
    +
    An alternative to ChatColor that allows for custom hex colors.

    U

    diff --git a/index.html b/index.html index 9827201..2271e26 100644 --- a/index.html +++ b/index.html @@ -1,11 +1,11 @@ - -Overview (VortexSidebars 1.0.1 API) + +Overview (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -49,7 +50,7 @@
    -

    VortexSidebars 1.0.1 API

    +

    VortexSidebars 1.1.0 API

    Packages
    diff --git a/member-search-index.js b/member-search-index.js index ea604e8..886cc9a 100644 --- a/member-search-index.js +++ b/member-search-index.js @@ -1 +1 @@ -memberSearchIndex = [{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"addLine(Text)","u":"addLine(us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"addLine(Text, int)","u":"addLine(us.teaminceptus.vortexsidebars.text.Text,int)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"addPlayer(Player)","u":"addPlayer(org.bukkit.entity.Player)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"AnimatedText(Plugin, List, int)","u":"%3Cinit%3E(org.bukkit.plugin.Plugin,java.util.List,int)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"AnimatedText(Plugin, List, int, int)","u":"%3Cinit%3E(org.bukkit.plugin.Plugin,java.util.List,int,int)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"AQUA"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"BLACK"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"BLUE"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"BOLD"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"clearLines()"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"clearPlayers()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"CYAN"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"DARK_BLUE"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"DARK_GRAY"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"DARK_GREEN"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"DARK_RED"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Text","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Field","l":"Field(Callable)","u":"%3Cinit%3E(java.util.concurrent.Callable)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"FieldText(Field)","u":"%3Cinit%3E(us.teaminceptus.vortexsidebars.text.Field)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"FieldText(Field, Text, Text)","u":"%3Cinit%3E(us.teaminceptus.vortexsidebars.text.Field,us.teaminceptus.vortexsidebars.text.Text,us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"fromHex(String)","u":"fromHex(java.lang.String)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"getCurrentIndex()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"getDelay()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"getField()"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"getLines()"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"getPlayers()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"getPrefix()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"getSuffix()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"getText()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Text","l":"getText()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"getTexts()"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"getTitle()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Field","l":"getValue()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"GOLD"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"GRAY"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"GREEN"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Text","l":"hashCode()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"isPaused()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"ITALIC"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"OBFUSCATE"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"PINK"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"PURPLE"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"RED"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"removeLine(int)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"removeLine(Text)","u":"removeLine(us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"removePlayer(Player)","u":"removePlayer(org.bukkit.entity.Player)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"setDelay(int)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"setIndex(int)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"setPaused(boolean)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"setPrefix(Text)","u":"setPrefix(us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"setSuffix(Text)","u":"setSuffix(us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Text","l":"setText(String)","u":"setText(java.lang.String)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"setTexts(List)","u":"setTexts(java.util.List)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"setTitle(Text)","u":"setTitle(us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"Sidebar(Plugin, Text)","u":"%3Cinit%3E(org.bukkit.plugin.Plugin,us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"Sidebar(Plugin, Text, List)","u":"%3Cinit%3E(org.bukkit.plugin.Plugin,us.teaminceptus.vortexsidebars.text.Text,java.util.List)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"STRIKETHROUGH"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Text","l":"Text(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"UNDERLINE"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"WHITE"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"YELLOW"}];updateSearchResults(); \ No newline at end of file +memberSearchIndex = [{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"addLine(Text)","u":"addLine(us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"addLine(Text, int)","u":"addLine(us.teaminceptus.vortexsidebars.text.Text,int)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"addPlayer(Player)","u":"addPlayer(org.bukkit.entity.Player)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"AnimatedText(Plugin, List, int)","u":"%3Cinit%3E(org.bukkit.plugin.Plugin,java.util.List,int)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"AnimatedText(Plugin, List, int, int)","u":"%3Cinit%3E(org.bukkit.plugin.Plugin,java.util.List,int,int)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"AQUA"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"BLACK"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"BLUE"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"BOLD"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"clearLines()"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"clearPlayers()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"CYAN"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"DARK_BLUE"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"DARK_GRAY"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"DARK_GREEN"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"DARK_RED"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Text","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Field","l":"Field(Callable)","u":"%3Cinit%3E(java.util.concurrent.Callable)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"FieldText(Field)","u":"%3Cinit%3E(us.teaminceptus.vortexsidebars.text.Field)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"FieldText(Field, Text, Text)","u":"%3Cinit%3E(us.teaminceptus.vortexsidebars.text.Field,us.teaminceptus.vortexsidebars.text.Text,us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"fromHex(String)","u":"fromHex(java.lang.String)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FunctionText","l":"FunctionText(Callable)","u":"%3Cinit%3E(java.util.concurrent.Callable)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FunctionText","l":"FunctionText(Callable, Text, Text)","u":"%3Cinit%3E(java.util.concurrent.Callable,us.teaminceptus.vortexsidebars.text.Text,us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"getCurrentIndex()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"getDelay()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"getField()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FunctionText","l":"getFunction()"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"getLines()"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"getPlayers()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"getPrefix()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FunctionText","l":"getPrefix()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"getSuffix()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FunctionText","l":"getSuffix()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"getText()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FunctionText","l":"getText()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Text","l":"getText()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"getTexts()"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"getTitle()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Field","l":"getValue()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"GOLD"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"GRAY"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"GREEN"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Text","l":"hashCode()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"isPaused()"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"ITALIC"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"OBFUSCATE"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"PINK"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"PURPLE"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"RED"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"removeLine(int)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"removeLine(Text)","u":"removeLine(us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"removePlayer(Player)","u":"removePlayer(org.bukkit.entity.Player)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"setDelay(int)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"setField(Field)","u":"setField(us.teaminceptus.vortexsidebars.text.Field)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FunctionText","l":"setFunction(Callable)","u":"setFunction(java.util.concurrent.Callable)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"setIndex(int)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"setPaused(boolean)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"setPrefix(Text)","u":"setPrefix(us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FunctionText","l":"setPrefix(Text)","u":"setPrefix(us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FieldText","l":"setSuffix(Text)","u":"setSuffix(us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"FunctionText","l":"setSuffix(Text)","u":"setSuffix(us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Text","l":"setText(String)","u":"setText(java.lang.String)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"AnimatedText","l":"setTexts(List)","u":"setTexts(java.util.List)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"setTitle(Text)","u":"setTitle(us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"Sidebar(Plugin, Text)","u":"%3Cinit%3E(org.bukkit.plugin.Plugin,us.teaminceptus.vortexsidebars.text.Text)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"Sidebar(Plugin, Text, List)","u":"%3Cinit%3E(org.bukkit.plugin.Plugin,us.teaminceptus.vortexsidebars.text.Text,java.util.List)"},{"p":"us.teaminceptus.vortexsidebars","c":"Sidebar","l":"Sidebar(Plugin, Text, List, long)","u":"%3Cinit%3E(org.bukkit.plugin.Plugin,us.teaminceptus.vortexsidebars.text.Text,java.util.List,long)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"STRIKETHROUGH"},{"p":"us.teaminceptus.vortexsidebars.text","c":"Text","l":"Text(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"UNDERLINE"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"WHITE"},{"p":"us.teaminceptus.vortexsidebars.text","c":"TextColor","l":"YELLOW"}];updateSearchResults(); \ No newline at end of file diff --git a/overview-summary.html b/overview-summary.html index 76cd423..5ac1c39 100644 --- a/overview-summary.html +++ b/overview-summary.html @@ -1,11 +1,11 @@ - -VortexSidebars 1.0.1 API + +VortexSidebars 1.1.0 API - + diff --git a/overview-tree.html b/overview-tree.html index 8cde9a5..de3957c 100644 --- a/overview-tree.html +++ b/overview-tree.html @@ -1,11 +1,11 @@ - -Class Hierarchy (VortexSidebars 1.0.1 API) + +Class Hierarchy (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -67,6 +68,7 @@

    Class Hierarchy

    diff --git a/type-search-index.js b/type-search-index.js index 892e95a..c3638ae 100644 --- a/type-search-index.js +++ b/type-search-index.js @@ -1 +1 @@ -typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"us.teaminceptus.vortexsidebars.text","l":"AnimatedText"},{"p":"us.teaminceptus.vortexsidebars.text","l":"Field"},{"p":"us.teaminceptus.vortexsidebars.text","l":"FieldText"},{"p":"us.teaminceptus.vortexsidebars","l":"Sidebar"},{"p":"us.teaminceptus.vortexsidebars.text","l":"Text"},{"p":"us.teaminceptus.vortexsidebars.text","l":"TextColor"}];updateSearchResults(); \ No newline at end of file +typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"us.teaminceptus.vortexsidebars.text","l":"AnimatedText"},{"p":"us.teaminceptus.vortexsidebars.text","l":"Field"},{"p":"us.teaminceptus.vortexsidebars.text","l":"FieldText"},{"p":"us.teaminceptus.vortexsidebars.text","l":"FunctionText"},{"p":"us.teaminceptus.vortexsidebars","l":"Sidebar"},{"p":"us.teaminceptus.vortexsidebars.text","l":"Text"},{"p":"us.teaminceptus.vortexsidebars.text","l":"TextColor"}];updateSearchResults(); \ No newline at end of file diff --git a/us/teaminceptus/vortexsidebars/Sidebar.html b/us/teaminceptus/vortexsidebars/Sidebar.html index db13867..1195274 100644 --- a/us/teaminceptus/vortexsidebars/Sidebar.html +++ b/us/teaminceptus/vortexsidebars/Sidebar.html @@ -1,11 +1,11 @@ - -Sidebar (VortexSidebars 1.0.1 API) + +Sidebar (VortexSidebars 1.1.0 API) - + @@ -37,6 +37,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -102,6 +103,11 @@

    Constructor Summary

    Creates a new Sidebar.
    +
    Sidebar(@NotNull Plugin plugin, + @NotNull Text title, + @Nullable List<Text> lines, + long updateDelay)
    +
     
    @@ -225,6 +231,18 @@

    Sidebar

    +
  • +
    +

    Sidebar

    +
    public Sidebar(@NotNull + @NotNull Plugin plugin, + @NotNull + @NotNull Text title, + @Nullable + @Nullable List<Text> lines, + long updateDelay)
    +
    +
    • diff --git a/us/teaminceptus/vortexsidebars/class-use/Sidebar.html b/us/teaminceptus/vortexsidebars/class-use/Sidebar.html index 4a0735e..5468a7b 100644 --- a/us/teaminceptus/vortexsidebars/class-use/Sidebar.html +++ b/us/teaminceptus/vortexsidebars/class-use/Sidebar.html @@ -1,11 +1,11 @@ - -Uses of Class us.teaminceptus.vortexsidebars.Sidebar (VortexSidebars 1.0.1 API) + +Uses of Class us.teaminceptus.vortexsidebars.Sidebar (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/us/teaminceptus/vortexsidebars/package-summary.html b/us/teaminceptus/vortexsidebars/package-summary.html index fe69880..a180d30 100644 --- a/us/teaminceptus/vortexsidebars/package-summary.html +++ b/us/teaminceptus/vortexsidebars/package-summary.html @@ -1,11 +1,11 @@ - -us.teaminceptus.vortexsidebars (VortexSidebars 1.0.1 API) + +us.teaminceptus.vortexsidebars (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/us/teaminceptus/vortexsidebars/package-tree.html b/us/teaminceptus/vortexsidebars/package-tree.html index 4f777c3..5643871 100644 --- a/us/teaminceptus/vortexsidebars/package-tree.html +++ b/us/teaminceptus/vortexsidebars/package-tree.html @@ -1,11 +1,11 @@ - -us.teaminceptus.vortexsidebars Class Hierarchy (VortexSidebars 1.0.1 API) + +us.teaminceptus.vortexsidebars Class Hierarchy (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/us/teaminceptus/vortexsidebars/package-use.html b/us/teaminceptus/vortexsidebars/package-use.html index 2a0a3e3..6a2413b 100644 --- a/us/teaminceptus/vortexsidebars/package-use.html +++ b/us/teaminceptus/vortexsidebars/package-use.html @@ -1,11 +1,11 @@ - -Uses of Package us.teaminceptus.vortexsidebars (VortexSidebars 1.0.1 API) + +Uses of Package us.teaminceptus.vortexsidebars (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/us/teaminceptus/vortexsidebars/text/AnimatedText.html b/us/teaminceptus/vortexsidebars/text/AnimatedText.html index d38c539..0d2ae97 100644 --- a/us/teaminceptus/vortexsidebars/text/AnimatedText.html +++ b/us/teaminceptus/vortexsidebars/text/AnimatedText.html @@ -1,11 +1,11 @@ - -AnimatedText (VortexSidebars 1.0.1 API) + +AnimatedText (VortexSidebars 1.1.0 API) - + @@ -37,6 +37,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/us/teaminceptus/vortexsidebars/text/Field.html b/us/teaminceptus/vortexsidebars/text/Field.html index e2f3a43..cfe8d5f 100644 --- a/us/teaminceptus/vortexsidebars/text/Field.html +++ b/us/teaminceptus/vortexsidebars/text/Field.html @@ -1,11 +1,11 @@ - -Field (VortexSidebars 1.0.1 API) + +Field (VortexSidebars 1.1.0 API) - + @@ -37,6 +37,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -77,8 +78,15 @@

    Class Field

    -
    public class Field +
    @Deprecated +public class Field extends Object
    +
    Deprecated. +
    Use FunctionText instead. +

    + Note: there are no current plans to remove Field or FieldText. +

    +
    Represents a Field that holds an output.
    @@ -93,6 +101,7 @@

    Constructor Summary

    Description
    Field(@NotNull Callable<Object> function)
    +
    Deprecated.
    Usage: new Field(() -> someFunction())
    @@ -103,15 +112,16 @@

    Constructor Summary

    Method Summary

    -
    +
    Modifier and Type
    Method
    Description
    -
    @Nullable Object
    -
    getValue()
    -
    +
    @Nullable Object
    +
    getValue()
    +
    +
    Deprecated.
    Fetches the output of the function.
    @@ -136,6 +146,7 @@

    Constructor Details

    Field

    public Field(@NotNull @NotNull Callable<Object> function)
    +
    Deprecated.
    Usage: new Field(() -> someFunction())
    Parameters:
    @@ -156,6 +167,7 @@

    Method Details

    getValue

    @Nullable public @Nullable Object getValue()
    +
    Deprecated.
    Fetches the output of the function.
    Returns:
    diff --git a/us/teaminceptus/vortexsidebars/text/FieldText.html b/us/teaminceptus/vortexsidebars/text/FieldText.html index 55ce33d..cd1b9dc 100644 --- a/us/teaminceptus/vortexsidebars/text/FieldText.html +++ b/us/teaminceptus/vortexsidebars/text/FieldText.html @@ -1,11 +1,11 @@ - -FieldText (VortexSidebars 1.0.1 API) + +FieldText (VortexSidebars 1.1.0 API) - + @@ -37,6 +37,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -79,8 +80,15 @@

    Class FieldText

    -
    public class FieldText +
    @Deprecated +public class FieldText extends Text
    +
    Deprecated. +
    Use FunctionText instead. +

    + Note: there are no current plans to remove Field or FieldText. +

    +
    @@ -106,32 +118,48 @@

    Constructor Summary

    Method Summary

    -
    +
    Modifier and Type
    Method
    Description
    -
    @NotNull Field
    -
    getField()
    -
     
    -
    @NotNull Text
    -
    getPrefix()
    -
     
    -
    @NotNull Text
    -
    getSuffix()
    -
     
    -
    String
    -
    getText()
    -
    +
    @NotNull Field
    +
    getField()
    +
    +
    Deprecated.
    + 
    +
    @NotNull Text
    +
    getPrefix()
    +
    +
    Deprecated.
    + 
    +
    @NotNull Text
    +
    getSuffix()
    +
    +
    Deprecated.
    + 
    +
    String
    +
    getText()
    +
    +
    Deprecated.
    Fetches the stored Text.
    -
    void
    -
    setPrefix(@NotNull Text newPrefix)
    -
     
    -
    void
    -
    setSuffix(@NotNull Text newSuffix)
    -
     
    +
    void
    +
    setField(@NotNull Field newField)
    +
    +
    Deprecated.
    + 
    +
    void
    +
    setPrefix(@NotNull Text newPrefix)
    +
    +
    Deprecated.
    + 
    +
    void
    +
    setSuffix(@NotNull Text newSuffix)
    +
    +
    Deprecated.
    + 
    @@ -157,6 +185,7 @@

    Constructor Details

    FieldText

    public FieldText(@NotNull @NotNull Field field)
    +
    Deprecated.
    Parameters:
    field - the Field (automatically updates when the value changes)
    @@ -166,9 +195,13 @@

    FieldText

  • FieldText

    -
    public FieldText(Field field, - Text prefix, - Text suffix)
    +
    public FieldText(@NotNull + @NotNull Field field, + @NotNull + @NotNull Text prefix, + @NotNull + @NotNull Text suffix)
    +
    Deprecated.
    • @@ -184,6 +217,7 @@

    Method Details

    getPrefix

    @NotNull public @NotNull Text getPrefix()
    +
    Deprecated.
    Returns:
    the Text ("" if not set) before the Field
    @@ -195,6 +229,7 @@

    getPrefix

    setPrefix

    public void setPrefix(@NotNull @NotNull Text newPrefix)
    +
    Deprecated.
    Parameters:
    newPrefix - the Text to put before the Field (e.g. "Players: ") when displaying
    @@ -206,6 +241,7 @@

    setPrefix

    getSuffix

    @NotNull public @NotNull Text getSuffix()
    +
    Deprecated.
    Returns:
    the Text ("" if not set) after the Field
    @@ -217,6 +253,7 @@

    getSuffix

    setSuffix

    public void setSuffix(@NotNull @NotNull Text newSuffix)
    +
    Deprecated.
    Parameters:
    newSuffix - the Text to put after the Field (e.g. "/100") when displaying
    @@ -227,6 +264,7 @@

    setSuffix

    getText

    public String getText()
    +
    Deprecated.
    Description copied from class: Text
    Fetches the stored Text.
    @@ -242,12 +280,21 @@

    getText

    getField

    @NotNull public @NotNull Field getField()
    +
    Deprecated.
    Returns:
    the Field without the prefix or suffix
    +
  • +
    +

    setField

    +
    public void setField(@NotNull + @NotNull Field newField)
    +
    Deprecated.
    +
    +
    • diff --git a/us/teaminceptus/vortexsidebars/text/FunctionText.html b/us/teaminceptus/vortexsidebars/text/FunctionText.html new file mode 100644 index 0000000..742ca5c --- /dev/null +++ b/us/teaminceptus/vortexsidebars/text/FunctionText.html @@ -0,0 +1,266 @@ + + + + +FunctionText (VortexSidebars 1.1.0 API) + + + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package us.teaminceptus.vortexsidebars.text
    +

    Class FunctionText

    +
    +
    java.lang.Object +
    us.teaminceptus.vortexsidebars.text.Text +
    us.teaminceptus.vortexsidebars.text.FunctionText
    +
    +
    +
    +
    +
    public class FunctionText +extends Text
    +
    Works as a text object but with a lambda. + Calls the function and updates accordingly every time + the value is requested.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        FunctionText

        +
        public FunctionText(@NotNull + @NotNull Callable<String> function)
        +
        +
        Parameters:
        +
        function - the lambda to call (must return String).
        +
        +
        +
        • +
      • +
        +

        FunctionText

        +
        public FunctionText(Callable<String> function, + Text prefix, + Text suffix)
        +
        +
        Parameters:
        +
        function - the lambda to call (must return String).
        +
        prefix - the Text to put before the function.
        +
        suffix - the Text to put after the function.
        +
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      + +
      +
      • +
    +
    + +
    +
    +
    +

    Copyright © 2023. All rights reserved.

    +
    +
    +
    + + diff --git a/us/teaminceptus/vortexsidebars/text/Text.html b/us/teaminceptus/vortexsidebars/text/Text.html index 558494e..71b4f8f 100644 --- a/us/teaminceptus/vortexsidebars/text/Text.html +++ b/us/teaminceptus/vortexsidebars/text/Text.html @@ -1,11 +1,11 @@ - -Text (VortexSidebars 1.0.1 API) + +Text (VortexSidebars 1.1.0 API) - + @@ -37,6 +37,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -78,7 +79,7 @@

    Class Text

    Direct Known Subclasses:
    -
    AnimatedText, FieldText
    +
    AnimatedText, FieldText, FunctionText
    public class Text diff --git a/us/teaminceptus/vortexsidebars/text/TextColor.html b/us/teaminceptus/vortexsidebars/text/TextColor.html index f80148d..7c3402a 100644 --- a/us/teaminceptus/vortexsidebars/text/TextColor.html +++ b/us/teaminceptus/vortexsidebars/text/TextColor.html @@ -1,11 +1,11 @@ - -TextColor (VortexSidebars 1.0.1 API) + +TextColor (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -71,7 +72,10 @@

    Interface TextColor

    public interface TextColor
    -
    An alternative to ChatColor that allows custom hex colors
    +
    An alternative to ChatColor that allows for custom hex colors. + WARNING: Hex colors only work for players on 1.16.1+. + For players below 1.16.1, it will show the color of whatever the last digit of the hex code is (e.g. if the hex code is #fd3baa, players below 1.16.1 would be shown lime because a is the chat color for lime). + In some cases it will display as that color for players 1.16.1 and above, and the reason for this is currently unknown. If someone could find what's causing it and make an issue on GitHub, that would be greatly appreciated.
      diff --git a/us/teaminceptus/vortexsidebars/text/class-use/AnimatedText.html b/us/teaminceptus/vortexsidebars/text/class-use/AnimatedText.html index 5bdef95..9261ff0 100644 --- a/us/teaminceptus/vortexsidebars/text/class-use/AnimatedText.html +++ b/us/teaminceptus/vortexsidebars/text/class-use/AnimatedText.html @@ -1,11 +1,11 @@ - -Uses of Class us.teaminceptus.vortexsidebars.text.AnimatedText (VortexSidebars 1.0.1 API) + +Uses of Class us.teaminceptus.vortexsidebars.text.AnimatedText (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
    • Class
    • Use
    • Tree
      • +
    • Deprecated
    • Index
    • Help
    diff --git a/us/teaminceptus/vortexsidebars/text/class-use/Field.html b/us/teaminceptus/vortexsidebars/text/class-use/Field.html index 87658f9..1bf9622 100644 --- a/us/teaminceptus/vortexsidebars/text/class-use/Field.html +++ b/us/teaminceptus/vortexsidebars/text/class-use/Field.html @@ -1,11 +1,11 @@ - -Uses of Class us.teaminceptus.vortexsidebars.text.Field (VortexSidebars 1.0.1 API) + +Uses of Class us.teaminceptus.vortexsidebars.text.Field (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -70,7 +71,20 @@

    Uses of Description

    @NotNull Field
    FieldText.getField()
    -
     
    +
    +
    Deprecated.
    + 
    + +
    Methods in us.teaminceptus.vortexsidebars.text with parameters of type Field
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    FieldText.setField(@NotNull Field newField)
    +
    +
    Deprecated.
    + 
    Constructors in us.teaminceptus.vortexsidebars.text with parameters of type Field
    @@ -79,12 +93,16 @@

    Uses of Description

     
    FieldText(@NotNull Field field)
    -
     
    +
    +
    Deprecated.
    + 
     
    -
    FieldText(Field field, - Text prefix, - Text suffix)
    -
     
    +
    FieldText(@NotNull Field field, + @NotNull Text prefix, + @NotNull Text suffix)
    +
    +
    Deprecated.
    + 
    diff --git a/us/teaminceptus/vortexsidebars/text/class-use/FieldText.html b/us/teaminceptus/vortexsidebars/text/class-use/FieldText.html index e9e622b..4a92859 100644 --- a/us/teaminceptus/vortexsidebars/text/class-use/FieldText.html +++ b/us/teaminceptus/vortexsidebars/text/class-use/FieldText.html @@ -1,11 +1,11 @@ - -Uses of Class us.teaminceptus.vortexsidebars.text.FieldText (VortexSidebars 1.0.1 API) + +Uses of Class us.teaminceptus.vortexsidebars.text.FieldText (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/us/teaminceptus/vortexsidebars/text/class-use/FunctionText.html b/us/teaminceptus/vortexsidebars/text/class-use/FunctionText.html new file mode 100644 index 0000000..254ec20 --- /dev/null +++ b/us/teaminceptus/vortexsidebars/text/class-use/FunctionText.html @@ -0,0 +1,63 @@ + + + + +Uses of Class us.teaminceptus.vortexsidebars.text.FunctionText (VortexSidebars 1.1.0 API) + + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    us.teaminceptus.vortexsidebars.text.FunctionText

    +
    +No usage of us.teaminceptus.vortexsidebars.text.FunctionText
    +
    +
    +

    Copyright © 2023. All rights reserved.

    +
    +
    +
    + + diff --git a/us/teaminceptus/vortexsidebars/text/class-use/Text.html b/us/teaminceptus/vortexsidebars/text/class-use/Text.html index 0ea0955..dcad0db 100644 --- a/us/teaminceptus/vortexsidebars/text/class-use/Text.html +++ b/us/teaminceptus/vortexsidebars/text/class-use/Text.html @@ -1,11 +1,11 @@ - -Uses of Class us.teaminceptus.vortexsidebars.text.Text (VortexSidebars 1.0.1 API) + +Uses of Class us.teaminceptus.vortexsidebars.text.Text (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -132,6 +133,12 @@

    Uses of
    Creates a new Sidebar.
    +
     
    +
    Sidebar(@NotNull Plugin plugin, + @NotNull Text title, + @Nullable List<Text> lines, + long updateDelay)
    +
     
    Constructor parameters in us.teaminceptus.vortexsidebars with type arguments of type Text
    @@ -145,6 +152,12 @@

    Uses of
    Creates a new Sidebar.

    +
     
    +
    Sidebar(@NotNull Plugin plugin, + @NotNull Text title, + @Nullable List<Text> lines, + long updateDelay)
    +
     

    @@ -161,7 +174,16 @@

    Uses of  
    class 
    FieldText
    -
     
    +
    +
    Deprecated. +
    Use FunctionText instead.
    +
    +
    +
    class 
    +
    FunctionText
    +
    +
    Works as a text object but with a lambda.
    +
    Methods in us.teaminceptus.vortexsidebars.text that return Text
    @@ -170,9 +192,19 @@

    Uses of Description

    @NotNull Text
    FieldText.getPrefix()
    -
     
    +
    +
    Deprecated.
    + 
    @NotNull Text
    -
    FieldText.getSuffix()
    +
    FunctionText.getPrefix()
    +
     
    +
    @NotNull Text
    +
    FieldText.getSuffix()
    +
    +
    Deprecated.
    + 
    +
    @NotNull Text
    +
    FunctionText.getSuffix()
     
    Methods in us.teaminceptus.vortexsidebars.text with parameters of type Text
    @@ -182,9 +214,19 @@

    Uses of Description
    void
    FieldText.setPrefix(@NotNull Text newPrefix)
    -
     
    +
    +
    Deprecated.
    + 
    +
    void
    +
    FunctionText.setPrefix(@NotNull Text newPrefix)
    +
     
    +
    void
    +
    FieldText.setSuffix(@NotNull Text newSuffix)
    +
    +
    Deprecated.
    + 
    void
    -
    FieldText.setSuffix(@NotNull Text newSuffix)
    +
    FunctionText.setSuffix(@NotNull Text newSuffix)
     
    Constructors in us.teaminceptus.vortexsidebars.text with parameters of type Text
    @@ -193,10 +235,17 @@

    Uses of Constructor
    Description
     
    -
    FieldText(Field field, +
    FieldText(@NotNull Field field, + @NotNull Text prefix, + @NotNull Text suffix)
    +
    +
    Deprecated.
    + 
    +
     
    +
    FunctionText(Callable<String> function, Text prefix, Text suffix)
    -
     
    +
     
    diff --git a/us/teaminceptus/vortexsidebars/text/class-use/TextColor.html b/us/teaminceptus/vortexsidebars/text/class-use/TextColor.html index 1459b20..1dd1a47 100644 --- a/us/teaminceptus/vortexsidebars/text/class-use/TextColor.html +++ b/us/teaminceptus/vortexsidebars/text/class-use/TextColor.html @@ -1,11 +1,11 @@ - -Uses of Interface us.teaminceptus.vortexsidebars.text.TextColor (VortexSidebars 1.0.1 API) + +Uses of Interface us.teaminceptus.vortexsidebars.text.TextColor (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/us/teaminceptus/vortexsidebars/text/package-summary.html b/us/teaminceptus/vortexsidebars/text/package-summary.html index 006f715..a896194 100644 --- a/us/teaminceptus/vortexsidebars/text/package-summary.html +++ b/us/teaminceptus/vortexsidebars/text/package-summary.html @@ -1,11 +1,11 @@ - -us.teaminceptus.vortexsidebars.text (VortexSidebars 1.0.1 API) + +us.teaminceptus.vortexsidebars.text (VortexSidebars 1.1.0 API) - + @@ -37,6 +37,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -88,18 +89,24 @@

    Package us
    AnimatedText
     
    Field
    -
    -
    Represents a Field that holds an output.
    +
    Deprecated. +
    Use FunctionText instead.
    FieldText
    -
     
    -
    Text
    +
    Deprecated. +
    Use FunctionText instead.
    +
    +
    FunctionText
    +
    Works as a text object but with a lambda.
    +
    +
    Text
    +
    Simple object that holds a String, used in order to allow for AnimatedText and FieldText
    -
    TextColor
    -
    -
    An alternative to ChatColor that allows custom hex colors
    +
    TextColor
    +
    +
    An alternative to ChatColor that allows for custom hex colors.
    diff --git a/us/teaminceptus/vortexsidebars/text/package-tree.html b/us/teaminceptus/vortexsidebars/text/package-tree.html index 60c1c32..b89c616 100644 --- a/us/teaminceptus/vortexsidebars/text/package-tree.html +++ b/us/teaminceptus/vortexsidebars/text/package-tree.html @@ -1,11 +1,11 @@ - -us.teaminceptus.vortexsidebars.text Class Hierarchy (VortexSidebars 1.0.1 API) + +us.teaminceptus.vortexsidebars.text Class Hierarchy (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -65,6 +66,7 @@

    Class Hierarchy

    diff --git a/us/teaminceptus/vortexsidebars/text/package-use.html b/us/teaminceptus/vortexsidebars/text/package-use.html index e3dcbb0..788655e 100644 --- a/us/teaminceptus/vortexsidebars/text/package-use.html +++ b/us/teaminceptus/vortexsidebars/text/package-use.html @@ -1,11 +1,11 @@ - -Uses of Package us.teaminceptus.vortexsidebars.text (VortexSidebars 1.0.1 API) + +Uses of Package us.teaminceptus.vortexsidebars.text (VortexSidebars 1.1.0 API) - + @@ -33,6 +33,7 @@
  • Class
  • Use
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -83,7 +84,9 @@

    Us
    Description
    Field
    -
    Represents a Field that holds an output.
    +
    Deprecated. +
    Use FunctionText instead.
    +
    Text