Home Migration Guide Getting Started With Scripts Commands Examples
BracketHandlers

NameUtils

Set of utility methods related to names and naming in general.

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

script.zs
import crafttweaker.util.NameUtils;

Static Methods

Attempts to automatically fix the given input string, if possible, so that it can be used to build a
well-formed MCResourceLocation.

Returns: The fixed string.
Return Type: string

script.zs
NameUtils.fixing(input as string) as string
ParameterTypeDescription
Parameter
input
Type
string
Description
The string that should be fixed to a MCResourceLocation-compatible format.

Attempts to automatically fix the given input string, if possible, so that it can be used to build a
well-formed MCResourceLocation.

Returns: The fixed string.
Return Type: string

script.zs
NameUtils.fixing(input as string, mistakeHandler as BiConsumer<string,stdlib.List<string>>) as string
ParameterTypeDescription
Parameter
input
Type
string
Description
The string that should be fixed to a MCResourceLocation-compatible format.
Parameter
mistakeHandler
Type
BiConsumer<string,stdlib.List<string>>
Description
A bi-consumer that gets called if there were any mistakes in the original string. The first
element is the fixed string, and the second is a list of strings containing explanations
for all the identified mistakes.

Creates a MCResourceLocation from the given input, if possible, while fixing mistakes that
may be present in the string.

Returns: A MCResourceLocation that represents the fixed input.
Return Type: MCResourceLocation

script.zs
NameUtils.fromFixedName(input as string) as MCResourceLocation
ParameterTypeDescription
Parameter
input
Type
string
Description
The string that should be fixed and converted to a MCResourceLocation.

Creates a MCResourceLocation from the given input, if possible, while fixing mistakes that
may be present in the string.

Returns: A MCResourceLocation that represents the fixed input.
Return Type: MCResourceLocation

script.zs
NameUtils.fromFixedName(input as string, mistakeHandler as BiConsumer<string,stdlib.List<string>>) as MCResourceLocation
ParameterTypeDescription
Parameter
input
Type
string
Description
The string that should be fixed and converted to a MCResourceLocation.
Parameter
mistakeHandler
Type
BiConsumer<string,stdlib.List<string>>
Description
A bi-consumer that gets called if there were any mistakes in the original string. The first
element is the fixed string, and the second is a list of strings containing explanations
for all the identified mistakes.

Verifies whether the given name has been autogenerated by CraftTweaker.

Returns: Whether the name has been autogenerated by CraftTweaker.
Return Type: boolean

script.zs
NameUtils.isAutogeneratedName(name as MCResourceLocation) as boolean
ParameterTypeDescription
Parameter
name
Type
MCResourceLocation
Description
The name to verify.