Index
All Classes and Interfaces|All Packages|Constant Field Values
B
- booleans() - Method in record class org.samo_lego.config2brigadier.common.util.ConfigFieldList
-
Returns the value of the
booleans
record component. - BrigadierDescription - Annotation Interface in org.samo_lego.config2brigadier.common.annotation
-
Adds description to the option, which is seen if user executes the config edit command but doesn't provide a value.
- BrigadierExcluded - Annotation Interface in org.samo_lego.config2brigadier.common.annotation
-
Indicates that this field should be excluded from generated command.
- buildEditCommand(LiteralCommandNode<CommandSourceStack>, String) - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Generates the command and attaches it to the provided child.
C
- CommandFeedback - Class in org.samo_lego.config2brigadier.common.command
-
Takes care of field editing and feedbacks for executed commands.
- CommandFeedback() - Constructor for class org.samo_lego.config2brigadier.common.command.CommandFeedback
- COMMENT_PREFIX - Static variable in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Default comment field prefix.
- CONFIG_STR - Static variable in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
- Config2Brigadier - Class in org.samo_lego.config2brigadier.common
- Config2Brigadier() - Constructor for class org.samo_lego.config2brigadier.common.Config2Brigadier
- ConfigFieldList - Record Class in org.samo_lego.config2brigadier.common.util
-
Creates an object containing lists with primitives,
Object
s and nestedConfigFieldList
s. - ConfigFieldList(Field, Object, List<Field>, List<Field>, List<Field>, List<Field>, List<Field>, List<ConfigFieldList>) - Constructor for record class org.samo_lego.config2brigadier.common.util.ConfigFieldList
-
Creates an instance of a
ConfigFieldList
record class.
D
- defaultOption() - Element in annotation interface org.samo_lego.config2brigadier.common.annotation.BrigadierDescription
-
Default option / value for the field.
- doubles() - Method in record class org.samo_lego.config2brigadier.common.util.ConfigFieldList
-
Returns the value of the
doubles
record component.
E
- EDIT_STR - Static variable in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
- editConfigAttribute(CommandContext<CommandSourceStack>, Object, IBrigadierConfigurator, Field, Object, Predicate<Field>) - Static method in class org.samo_lego.config2brigadier.common.command.CommandFeedback
-
Edits the config field.
- editConfigBoolean(CommandContext<CommandSourceStack>, Object, IBrigadierConfigurator, Field) - Static method in class org.samo_lego.config2brigadier.common.command.CommandFeedback
-
Edits the config boolean field.
- editConfigDouble(CommandContext<CommandSourceStack>, Object, IBrigadierConfigurator, Field) - Static method in class org.samo_lego.config2brigadier.common.command.CommandFeedback
-
Edits the config double field.
- editConfigFloat(CommandContext<CommandSourceStack>, Object, IBrigadierConfigurator, Field) - Static method in class org.samo_lego.config2brigadier.common.command.CommandFeedback
-
Edits the config float field.
- editConfigInt(CommandContext<CommandSourceStack>, Object, IBrigadierConfigurator, Field) - Static method in class org.samo_lego.config2brigadier.common.command.CommandFeedback
-
Edits the config integer field.
- editConfigObject(CommandContext<CommandSourceStack>, Object, IBrigadierConfigurator, Field) - Static method in class org.samo_lego.config2brigadier.common.command.CommandFeedback
-
Edits the config object field.
- enableSerializedNameComments() - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Whether to try getting comments from fields that are prefixed with
getCommentPrefix()
and have customSerializedName
values. - equals(Object) - Method in record class org.samo_lego.config2brigadier.common.util.ConfigFieldList
-
Indicates whether some other object is "equal to" this one.
F
- floats() - Method in record class org.samo_lego.config2brigadier.common.util.ConfigFieldList
-
Returns the value of the
floats
record component.
G
- generateCommand(LiteralCommandNode<CommandSourceStack>) - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Deprecated.
- generateConfigCommand(String, CommandDispatcher<CommandSourceStack>) - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
All-in-one solution for generating config command.
- generateFieldDescription(Object, Field) - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Gets the description for attribute field of parent object by checking relevant
SerializedName
annotations. - generateFieldInfo(CommandContext<CommandSourceStack>, Object, Field) - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Generates text information for field and sends it to command executor.
- generateReloadableConfigCommand(String, CommandDispatcher<CommandSourceStack>, Supplier<? extends IBrigadierConfigurator>) - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
All-in-one solution for generating config command.
- getCommentPrefix() - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Gets comment prefix of fields.
- getDescription(Field) - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Gets description for the field.
- GSON - Static variable in class org.samo_lego.config2brigadier.common.Config2Brigadier
H
- hashCode() - Method in record class org.samo_lego.config2brigadier.common.util.ConfigFieldList
-
Returns a hash code value for this object.
I
- IBrigadierConfigurator - Interface in org.samo_lego.config2brigadier.common
-
An interface your config should implement.
- integers() - Method in record class org.samo_lego.config2brigadier.common.util.ConfigFieldList
-
Returns the value of the
integers
record component.
L
- loadConfigFile(File, Class<C>, Supplier<C>) - Static method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Loads config file.
- loadConfigFile(File, Class<T>, Supplier<T>) - Static method in class org.samo_lego.config2brigadier.common.Config2Brigadier
-
Loads config file.
M
- MOD_ID - Static variable in class org.samo_lego.config2brigadier.common.Config2Brigadier
N
- nestedFields() - Method in record class org.samo_lego.config2brigadier.common.util.ConfigFieldList
-
Returns the value of the
nestedFields
record component.
O
- objects() - Method in record class org.samo_lego.config2brigadier.common.util.ConfigFieldList
-
Returns the value of the
objects
record component. - org.samo_lego.config2brigadier.common - package org.samo_lego.config2brigadier.common
- org.samo_lego.config2brigadier.common.annotation - package org.samo_lego.config2brigadier.common.annotation
- org.samo_lego.config2brigadier.common.command - package org.samo_lego.config2brigadier.common.command
- org.samo_lego.config2brigadier.common.util - package org.samo_lego.config2brigadier.common.util
P
- parent() - Method in record class org.samo_lego.config2brigadier.common.util.ConfigFieldList
-
Returns the value of the
parent
record component. - parentField() - Method in record class org.samo_lego.config2brigadier.common.util.ConfigFieldList
-
Returns the value of the
parentField
record component. - populateFields(Field, Object, IBrigadierConfigurator) - Static method in record class org.samo_lego.config2brigadier.common.util.ConfigFieldList
-
Generates a
ConfigFieldList
for selected object with recursion.
R
- recursiveEditCommand(LiteralCommandNode<CommandSourceStack>, ConfigFieldList, List<String>) - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Recursively generates the command for config editing and attaches it to child.
- recursiveReload(Object, Object) - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Loads changes from given config object into this object recursively.
- reload(IBrigadierConfigurator) - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Loads changes from given config object into this object.
- RELOAD_STR - Static variable in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
S
- save() - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Method called after a value is edited.
- shouldExclude(Field) - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Indicates whether this field should be excluded from command.
T
- toString() - Method in record class org.samo_lego.config2brigadier.common.util.ConfigFieldList
-
Returns a string representation of this record class.
V
- value() - Element in annotation interface org.samo_lego.config2brigadier.common.annotation.BrigadierDescription
-
Description for the field.
W
- writeToFile(File) - Method in interface org.samo_lego.config2brigadier.common.IBrigadierConfigurator
-
Saves the config to the given file.
All Classes and Interfaces|All Packages|Constant Field Values
generateReloadableConfigCommand(String, CommandDispatcher, Supplier)
orgenerateConfigCommand(String, CommandDispatcher)
instead. If you still want to manually generate the command, usebuildEditCommand(LiteralCommandNode, String)
.