FreeMinecraftModels/com.magmaguy.freeminecraftmodels.config.props/PropScriptConfigFields

PropScriptConfigFields

public class PropScriptConfigFields extends CustomConfigFields

Unified configuration fields for model YML config files.

Each model file (e.g. torch_01.bbmodel) can have a sibling YML file (e.g. torch_01.yml) that configures scripts and optionally item properties.

If material is set, the model is also available as a custom item that players can hold, with the specified material, enchantments, and lore. Script filenames resolve from the central scripts/ folder.

Constructors

PropScriptConfigFields

public void PropScriptConfigFields(String filename, boolean isEnabled)

Used when creating a new default config or loading an existing one.

Properties

enchantments

public List<String> enchantments

itemName

public String itemName

lore

public List<String> lore

material

public String material

parsedEnchantments

public Map<String, Integer> parsedEnchantments

scripts

public List<String> scripts

unavailableReason

public String unavailableReason

weapon

public MagicWeaponDefinition weapon

Inherited properties

file

protected File file

fileConfiguration

protected FileConfiguration fileConfiguration

filename

protected String filename

isEnabled

protected boolean isEnabled

writableFileConfiguration

public FileConfiguration writableFileConfiguration

Functions

getEnchantments

public List<String> getEnchantments()

getItemName

public String getItemName()

getLore

public List<String> getLore()

getMaterial

public String getMaterial()

getParsedEnchantments

public Map<String, Integer> getParsedEnchantments()

getParsedMaterial

public Material getParsedMaterial()

Parses the material string.

getScripts

public List<String> getScripts()

getUnavailableReason

public String getUnavailableReason()

getWeapon

public MagicWeaponDefinition getWeapon()

isCustomItem

public boolean isCustomItem()

Returns true if this model is also configured as a custom item (has a material defined).

isSolidify

public boolean isSolidify()

isVoxelize

public boolean isVoxelize()

processConfigFields

public void processConfigFields()

Inherited functions

configHas

protected boolean configHas(String configKey)

getFile

public File getFile()

getFileConfiguration

public FileConfiguration getFileConfiguration()

getFilename

public String getFilename()

getWritableFileConfiguration

public FileConfiguration getWritableFileConfiguration()

isEnabled

public boolean isEnabled()

processBoolean

protected boolean processBoolean(String path, boolean value, boolean pluginDefault, boolean forceWriteDefault)

processConfigurationSection

public ConfigurationSection processConfigurationSection(String path, Map<String, Object> value)

processDouble

protected double processDouble(String path, double value, double pluginDefault, boolean forceWriteDefault)

protected Double processDouble(String path, Double value, Double pluginDefault, boolean forceWriteDefault)

processEnum

public T processEnum<T extends Enum<T>>(String path, T value, T pluginDefault, Class<T> enumClass, boolean forceWriteDefault)

processEnumList

protected List<T> processEnumList<T extends Enum<T>>(String path, List<T> value, List<T> pluginDefault, Class<T> enumClass, boolean forceWriteDefault)

processInt

protected int processInt(String path, int value, int pluginDefault, boolean forceWriteDefault)

processItemStack

public ItemStack processItemStack(String path, ItemStack value, ItemStack pluginDefault, boolean forceWriteDefault)

processList

public List<Object> processList(String path, List<Object> value, List<Object> pluginDefault, boolean forceWriteDefault)

processLocation

protected Location processLocation(String path, Location value, String pluginDefault, boolean forceWriteDefault)

processLong

protected long processLong(String path, long value, long pluginDefault, boolean forceWriteDefault)

processMap

public Map<String, Object> processMap(String path, Map<String, Object> value)

processMapWithKey

public Map<String, Object> processMapWithKey(String path, Map<String, Object> value)

processString

protected String processString(String path, String value, String pluginDefault, boolean forceWriteDefault)

processStringList

public List<String> processStringList(String path, List<String> value, List<String> pluginDefault, boolean forceWriteDefault)

processVector

protected Vector processVector(String path, Vector value, Vector pluginDefault, boolean forceWriteDefault)

processWorldList

protected List<World> processWorldList(String path, List<World> value, List<World> pluginDefault, boolean forceWriteDefault)

setEnabled

public void setEnabled(boolean isEnabled)

setEnabledAndSave

public CompletableFuture<Void> setEnabledAndSave(boolean enabled)

setFile

public void setFile(File file)

setFileConfiguration

public void setFileConfiguration(FileConfiguration fileConfiguration)