mod.bespectacled.modernbetaforge.api.property

Class ListProperty

java.lang.Object

mod.bespectacled.modernbetaforge.api.property.Property<java.lang.String>

mod.bespectacled.modernbetaforge.api.property.StringProperty

mod.bespectacled.modernbetaforge.api.property.ListProperty

public final class ListProperty
extends StringProperty

Constructor Summary

Constructors

Constructor and Description
ListProperty(int index, java.lang.String[] values) Constructs a new ListProperty with the index of the initial value from an array of valid values.
ListProperty(java.lang.String value, java.lang.String[] values) Constructs a new ListProperty with the String value of the initial value from an array of valid values.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getType() Gets the string id specifying the property type.
java.lang.String[]	getValues() Gets the array of valid String values.
int	indexOf(java.lang.String value) Gets the index of the matching given value from the values array.
void	visitEntryValue(EntryValuePropertyVisitor visitor, int guiIdentifier, java.lang.Object value, net.minecraft.util.ResourceLocation registryKey) Accept a GUI generator settings visitor for the property.
void	visitFactory(FactoryPropertyVisitor visitor, ModernBetaGeneratorSettings.Factory factory, net.minecraft.util.ResourceLocation registryKey, com.google.gson.JsonObject jsonObject) Accept a Factory visitor for the property.
net.minecraft.client.gui.GuiPageButtonList.GuiListEntry	visitGui(GuiPropertyVisitor visitor, int guiIdentifier) Accept a GUI visitor for the property.
java.lang.String	visitNameFormatter(PropertyVisitor visitor) Accept a name formatter visitor for the property.

Methods inherited from class mod.bespectacled.modernbetaforge.api.property.StringProperty

getFormatter

Methods inherited from class mod.bespectacled.modernbetaforge.api.property.Property

equals, getValue, hashCode, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

ListProperty

public ListProperty(int index,
                    java.lang.String[] values)

Constructs a new ListProperty with the index of the initial value from an array of valid values.

Parameters:

index - Index of the initial value from values.

values - Array of valid String values.

ListProperty

public ListProperty(java.lang.String value,
                    java.lang.String[] values)

Constructs a new ListProperty with the String value of the initial value from an array of valid values. If the initial value isn't actually valid, then the value at index 0 of values is used.

Parameters:

value - The initial value from values.

values - Array of valid String values.

Method Detail

getType

public java.lang.String getType()

Description copied from class: Property

Gets the string id specifying the property type.

Overrides:

getType in class StringProperty

Returns:

The property type

visitFactory

public void visitFactory(FactoryPropertyVisitor visitor,
                         ModernBetaGeneratorSettings.Factory factory,
                         net.minecraft.util.ResourceLocation registryKey,
                         com.google.gson.JsonObject jsonObject)

Description copied from class: Property

Accept a Factory visitor for the property.

Overrides:

visitFactory in class StringProperty

Parameters:

visitor - The property visitor.

factory - The generator settings factory.

registryKey - The registry key associated with this property.

jsonObject - The JSON object to read/write the property from/to.

visitGui

public net.minecraft.client.gui.GuiPageButtonList.GuiListEntry visitGui(GuiPropertyVisitor visitor,
                                                                        int guiIdentifier)

Description copied from class: Property

Accept a GUI visitor for the property.

Overrides:

visitGui in class StringProperty

Parameters:

visitor - The property visitor.

guiIdentifier - The id of the GUI button.

Returns:

A new GUI button entry.

visitEntryValue

public void visitEntryValue(EntryValuePropertyVisitor visitor,
                            int guiIdentifier,
                            java.lang.Object value,
                            net.minecraft.util.ResourceLocation registryKey)

Description copied from class: Property

Accept a GUI generator settings visitor for the property.

Overrides:

visitEntryValue in class StringProperty

Parameters:

visitor - The property visitor.

guiIdentifier - The id of the GUI button.

value - The value to set.

registryKey - The registry key associated with this property.

visitNameFormatter

public java.lang.String visitNameFormatter(PropertyVisitor visitor)

Description copied from class: Property

Accept a name formatter visitor for the property.

Overrides:

visitNameFormatter in class StringProperty

Parameters:

visitor - The property visitor.

Returns:

The formatted name for the property.

getValues

public java.lang.String[] getValues()

Gets the array of valid String values.

Returns:

A String array of valid values.

indexOf

public int indexOf(java.lang.String value)

Gets the index of the matching given value from the values array.

Parameters:

value - The String value to search with.

Returns:

The index from values if the search value is present, -1 otherwise.