|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmoapi.ModOptions
public class ModOptions
An abstract representation of a set of options for a single mod
Constructor Summary | |
---|---|
ModOptions(java.lang.String name)
Create a new set of options with no parent. |
|
ModOptions(java.lang.String name,
ModOptions p)
Create a sub options menu for a mod package |
|
ModOptions(java.lang.String id,
java.lang.String name)
Create a sub option menu with no parent |
Method Summary | |
---|---|
ModOption |
addKeyBinding(java.lang.String name)
Adds a character binding which is unique and will not class with any other character binding. |
ModOption |
addKeyOption(java.lang.String name)
Adds a character binding which is unique and will not class with any other character binding. |
ModOption |
addMappedOption(java.lang.String name,
int[] keys,
java.lang.String[] values)
Adds a mapped option |
ModOption |
addMappedOption(java.lang.String name,
java.lang.Integer[] keys,
java.lang.String[] values)
Adds a mapped option |
ModOption |
addMultiOption(java.lang.String name,
java.lang.String[] values)
Add a multiple selector |
ModOption |
addOption(ModOption option)
Add a manually created option to this menu |
ModOptions |
addOptionFormatter(ModOption option,
DisplayStringFormatter formatter)
Add a formatter to the set of formatters for the given option |
ModOptions |
addOptionFormatter(java.lang.String id,
DisplayStringFormatter formatter)
Add a formatter to the set of formatters for the given option |
ModOption |
addSlider(java.lang.String name)
Add a numeric slider ranging from 0 to 100 |
ModOption |
addSlider(java.lang.String name,
int low,
int high)
Add a numeric slider with a range |
ModOptions |
addSubOptions(ModOptions m)
Add a sub menu of options |
ModOption |
addTextOption(java.lang.String name)
Add a text option with infinite max length |
ModOption |
addTextOption(java.lang.String name,
int maxlen)
Add a text option with infinite max length |
ModOption |
addTextOption(java.lang.String name,
java.lang.String value)
Add a text option with infinite max length with a default value |
ModOption |
addTextOption(java.lang.String name,
java.lang.String value,
int maxlen)
Add a text option with infinite max length with a default value |
ModOption |
addTextOption(java.lang.String name,
java.lang.String value,
java.lang.Integer maxlen)
Add a text option with infinite max length with a default value |
ModOption |
addToggle(java.lang.String name)
Add a toggle/boolean selector |
boolean |
containsSubOptions(java.lang.String id)
Check if this mod options has a given sub options menu |
GuiController |
getGuiController()
Return the GUI controller for this menu |
java.lang.String |
getID()
Return the ID for this menu |
int |
getMappedValue(java.lang.String id)
Returns a single named mapped option's value |
ModOptions[] |
getMultiplayerSubOptions()
Get all sets of sub-options for this set for multiplayer return Array of all sub options for this set |
java.lang.String |
getName()
Return name for this menu |
ModOption |
getOption(java.lang.String id)
Return a single named option |
ModOption[] |
getOptions()
Return all option selectors for this menu |
java.lang.String |
getOptionValue(java.lang.String id)
Returns a single named option's internal value |
ModOptions |
getParent()
Get parent for this menu |
ModOptions[] |
getSingleplayerSubOptions()
Get all sets of sub-options for this set for singleplayer return Array of all sub options for this set |
float |
getSliderValue(java.lang.String id)
Returns a single named slider option's value |
ModOptions |
getSubOption(java.lang.String id)
Get a named set of sub-options |
ModOptions[] |
getSubOptions()
Get all sets of sub-options for this set return Array of all sub options for this set |
java.lang.String |
getTextValue(java.lang.String id)
Get the value of a text input field |
boolean |
getToggleValue(java.lang.String id)
Returns a single named toggle value |
void |
globalReset(boolean global)
Sets all values global values to the parameter |
boolean |
isMultiplayerMod()
Checks if this mod is available in multiplayer server menus |
boolean |
isSingleplayerMod()
Checks if this mod is available in single player world menus |
ModOptions |
loadValues()
Loads global values from disk into memory for this and all sub-menus |
ModOptions |
loadValues(java.lang.String worldName,
boolean multi)
Loads values from disk into memory for this and all sub-menus |
ModOptions |
save()
Saves options to disk |
ModOptions |
save(java.lang.String name,
boolean multiplayer)
Save options to disk for a particular world |
ModOptions |
setMultiplayerMode(boolean multi)
Set multiplayer value |
ModOptions |
setOptionStringFormat(ModOption option,
DisplayStringFormatter formatter)
Set an option's string format, will remove any other formatters |
ModOptions |
setOptionStringFormat(java.lang.String id,
DisplayStringFormatter formatter)
Set an option's string format, will remove any other formatters |
ModOptions |
setOptionValue(java.lang.String id,
boolean value)
Set a single named boolean options global value |
ModOptions |
setOptionValue(java.lang.String id,
int value)
Set a single slider or mapped multi option's global value |
ModOptions |
setOptionValue(java.lang.String id,
java.lang.Integer value)
Set a single slider or mapped multi option's global value |
ModOptions |
setOptionValue(java.lang.String id,
java.lang.String value)
Set a single multi option's global value |
ModOptions |
setParent(ModOptions o)
Set the parent for this menu |
ModOptions |
setSingleplayerMode(boolean single)
Set singleplayer value |
ModOptions |
setWideOption(ModOption option)
Set a given option to wide |
ModOptions |
setWideOption(java.lang.String id)
Set a named Option to wide |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ModOptions(java.lang.String name)
name
- Name of option list (menu name). Valid folder names only.
java.util.regex.PatternSyntaxException
- When an invalid folder name is specifiedpublic ModOptions(java.lang.String name, ModOptions p)
name
- Name of this option listp
- Parent of this option list
java.util.regex.PatternSyntaxException
- When an invalid folder name is specifiedpublic ModOptions(java.lang.String id, java.lang.String name)
id
- ID of this option listname
- Name of this option set
java.util.regex.PatternSyntaxException
- When an invalid folder name is specifiedMethod Detail |
---|
public ModOption addOption(ModOption option)
option
- Option selector to add
public ModOption addTextOption(java.lang.String name)
name
- Name of text input
public ModOption addTextOption(java.lang.String name, java.lang.String value)
name
- Name of text inputvalue
- Default value of input
public ModOption addTextOption(java.lang.String name, int maxlen)
name
- Name of text inputmaxlen
- Maximum length the user can input. 0 or less is infinite
public ModOption addTextOption(java.lang.String name, java.lang.String value, int maxlen)
name
- Name of text inputvalue
- Default value for inputmaxlen
- Maximum length the user can input. 0 or less is infinite
public ModOption addTextOption(java.lang.String name, java.lang.String value, java.lang.Integer maxlen)
name
- Name of text inputvalue
- Default value for inputmaxlen
- Maximum length the user can input. 0 or less is infinite
public ModOption addKeyBinding(java.lang.String name)
name
- Name of character binding
public ModOption addKeyOption(java.lang.String name)
name
- Name of character binding
public ModOption addMultiOption(java.lang.String name, java.lang.String[] values)
name
- Name of selectorvalues
- Set of values to display
public ModOption addMappedOption(java.lang.String name, java.lang.Integer[] keys, java.lang.String[] values) throws java.lang.IndexOutOfBoundsException
name
- Name of selectorkeys
- Keys for selectorvalues
- Values for selector
java.lang.IndexOutOfBoundsException
public ModOption addMappedOption(java.lang.String name, int[] keys, java.lang.String[] values) throws java.lang.IndexOutOfBoundsException
name
- Name of selectorkeys
- Keys for selectorvalues
- Values for selector
java.lang.IndexOutOfBoundsException
public ModOption addToggle(java.lang.String name)
name
- Name of boolean selector
public ModOption addSlider(java.lang.String name)
name
- Name of slider
public ModOption addSlider(java.lang.String name, int low, int high)
name
- Name of sliderlow
- Lowest value of sliderhigh
- Highest value of slider
public ModOptions addSubOptions(ModOptions m)
m
- Set of sub-options
public boolean containsSubOptions(java.lang.String id)
id
- of sub options
public ModOptions[] getSubOptions()
public ModOptions[] getMultiplayerSubOptions()
public ModOptions[] getSingleplayerSubOptions()
public ModOptions getSubOption(java.lang.String id)
id
- ID of sub-options
public void globalReset(boolean global)
global
- New valuepublic ModOption getOption(java.lang.String id)
id
- ID of option selector
public java.lang.String getOptionValue(java.lang.String id)
public java.lang.String getTextValue(java.lang.String id) throws NoSuchOptionException
id
- ID of option
NoSuchOptionException
- When no option is present
IncompatibleOptionTypeException
public boolean getToggleValue(java.lang.String id) throws NoSuchOptionException
id
- ID of the option
NoSuchOptionException
- When no option is present
IncompatibleOptionTypeException
public float getSliderValue(java.lang.String id) throws NoSuchOptionException
id
- ID of the option
NoSuchOptionException
- When no option is present
IncompatibleOptionTypeException
public int getMappedValue(java.lang.String id) throws NoSuchOptionException
id
- ID of the option
NoSuchOptionException
- When no option is present
IncompatibleOptionTypeException
public ModOptions setOptionValue(java.lang.String id, boolean value)
id
- ID of boolean toggle to changevalue
- New value of toggle
IncompatibleOptionTypeException
NoSuchOptionException
- When the option doesn't already existpublic ModOptions setOptionValue(java.lang.String id, java.lang.Integer value)
id
- ID of slider option to changevalue
- New value of toggle
IncompatibleOptionTypeException
NoSuchOptionException
- When the option doesn't already existpublic ModOptions setOptionValue(java.lang.String id, int value)
id
- ID of slider option to changevalue
- New value of toggle
IncompatibleOptionTypeException
NoSuchOptionException
- When the option doesn't already existpublic ModOptions setOptionValue(java.lang.String id, java.lang.String value)
id
- ID of multi toggle to changevalue
- New value of toggle
IncompatibleOptionTypeException
NoSuchOptionException
- When the option doesn't already existpublic ModOption[] getOptions()
public ModOptions setWideOption(java.lang.String id)
id
- ID of option to set wide
public ModOptions setWideOption(ModOption option)
option
- Option object
public ModOptions setOptionStringFormat(java.lang.String id, DisplayStringFormatter formatter)
id
- ID of optionformatter
- Formatter
public ModOptions addOptionFormatter(java.lang.String id, DisplayStringFormatter formatter)
id
- ID of optionformatter
- Formatter to add
public ModOptions setOptionStringFormat(ModOption option, DisplayStringFormatter formatter)
option
- Option to add formatter toformatter
- Formatter
public ModOptions addOptionFormatter(ModOption option, DisplayStringFormatter formatter)
option
- Option to add formatter toformatter
- Formatter to add
public java.lang.String getID()
public java.lang.String getName()
public ModOptions getParent()
public ModOptions setParent(ModOptions o)
o
- Parent menu
public GuiController getGuiController()
public ModOptions setMultiplayerMode(boolean multi)
multi
- True if visible in multiplayer
public ModOptions setSingleplayerMode(boolean single)
single
- True if visible in singleplayer
public boolean isSingleplayerMod()
public boolean isMultiplayerMod()
public ModOptions loadValues()
public ModOptions loadValues(java.lang.String worldName, boolean multi)
worldName
- Name of world/ server to load formulti
- True if multiplayer word
public ModOptions save(java.lang.String name, boolean multiplayer)
name
- worldnamemultiplayer
- Save to a multiplayer file if true
public ModOptions save()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |