StringData

Version:

Home Commands Examples Getting Started With Scripts Global Keywords

BoolData ByteArrayData ByteData DoubleData EmptyData FloatData IData IntArrayData IntData ListData LongArrayData LongData MapData ShortData StringData

BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

import crafttweaker.api.data.StringData;

Description

Implements

StringData implements the following interfaces:

IData

Undocumented Interfaces

Comparable<IData>,Iterable<IData>

Constructors

// new StringData(internal as string);
new StringData(myString);

Parameters:

internal: string Type: string

Operators

Applies a bitwise AND (&) operation to this IData and the other IData

// (StringData & (other as IData)) as IData
myStringData & myIData

Parameters:

other: IData Type: IData - the other data.

Return Type: IData

Divides the given IData from this IData.

// (StringData / (other as IData)) as IData
myStringData / myIData

Parameters:

other: IData Type: IData - the other data to divide by.

Return Type: IData

Gets the data at the given index.

// StringData[index as int] as IData
myStringData[myInt]

Parameters:

index: int Type: int - The index to get

Return Type: IData

Gets the data at the given key.

// StringData[key as string] as IData
myStringData[myString]

Parameters:

key: string Type: string - The key to get

Return Type: IData

Applies a modulo operation to this IData against the other IData.

// (StringData % (other as IData)) as IData
myStringData % myIData

Parameters:

other: IData Type: IData - the other data to modulo by.

Return Type: IData

Multiplies the given IData to this IData.

// (StringData * (other as IData)) as IData
myStringData * myIData

Parameters:

other: IData Type: IData - the other data to multiply by.

Return Type: IData

Negates this IData.

// (-StringData) as IData
-myStringData

Return Type: IData

Applies a NOT (!) operation to this IData.

// (!StringData) as IData
!myStringData

Return Type: IData

Applies a bitwise OR (|) operation to this IData and the other IData

// (StringData | (other as IData)) as IData
myStringData | myIData

Parameters:

other: IData Type: IData - the other data.

Return Type: IData

Puts the given value inside this IData at the given index.

// StringData[index as string] = (value as IData)
myStringData[myString] = myIData

Parameters:

index: string Type: string - The key to store the data at

value: IData Type: IData - The data to store.

Applies a SHL (<<) operation to this data by the other data

// (StringData << (other as IData)) as IData
myStringData << myIData

Parameters:

other: IData Type: IData - The data to SHL by.

Return Type: IData

Applies a SHR (>>) operation to this data by the other data

// (StringData >> (other as IData)) as IData
myStringData >> myIData

Parameters:

other: IData Type: IData - The data to SHR by.

Return Type: IData

Subtracts the given IData from this IData.

// (StringData - (other as IData)) as IData
-myStringData

Parameters:

other: IData Type: IData - the other data to remove.

Return Type: IData

Applies a bitwise XOR (^) operation to this IData and the other IData

// (StringData ^ (other as IData)) as IData
myStringData ^ myIData

Parameters:

other: IData Type: IData - the other data.

Return Type: IData

Members

Casts this IData to a byte array.

Returns: this data as a byte array

// StringData.asByteArray() as byte[];
myStringData.asByteArray();

Return Type: byte[]

Casts this IData to a byte array.

// StringData as byte[]
myStringData as byte[]

Return Type: byte[]

Casts this IData to an int array.

Returns: this data as an int array

// StringData.asIntArray() as int[];
myStringData.asIntArray();

Return Type: int[]

Casts this IData to an int array.

// StringData as int[]
myStringData as int[]

Return Type: int[]

Casts this IData to a list.

Returns: this data as a list

// StringData.asList() as List<IData>;
myStringData.asList();

Return Type: List<IData>

Casts this IData to a list.

// StringData as List<IData>
myStringData as List<IData>

Return Type: List<IData>

Casts this IData to a long array.

Returns: this data as a long array

// StringData.asLongArray() as long[];
myStringData.asLongArray();

Return Type: long[]

Casts this IData to a long array.

// StringData as long[]
myStringData as long[]

Return Type: long[]

Casts this IData to a map.

Returns: this data as a map

// StringData.asMap() as IData[string];
myStringData.asMap();

Return Type: IData[string]

Casts this IData to a map.

// StringData as IData[string]
myStringData as IData[string]

Return Type: IData[string]

Gets an escaped string version of this IData, quotes are included in the output

E.G println(("hello" as IData).asString()) prints "hello"

Returns: The escaped string version of this IData.

// StringData.asString() as string;
myStringData.asString();

Return Type: string

Gets the literal string version of this IData.

E.G println(("hello" as IData).getAsString()) prints hello

Returns: The literal string version of this IData.

// StringData.getAsString() as string;
myStringData.getAsString();

Return Type: string

Gets the literal string version of this IData.

E.G println(("hello" as IData).getAsString()) prints hello

// StringData as string
myStringData as string

Return Type: string

Gets the internal ID of this data.

Returns: the intenral ID of this data.

// StringData.getId() as byte;
myStringData.getId();

Return Type: byte

Checks if this data is empty.

// StringData.isEmpty as bool
myStringData.isEmpty

Return Type: bool

Checks if this data is empty.

Returns: True if empty.

// StringData.isEmpty() as bool;
myStringData.isEmpty();

Return Type: bool

Gets the keys of this IData

// StringData.keys as Set<string>
myStringData.keys

Return Type: Set<string>

Gets the keys of this IData

Returns: The keys of this IData.

// StringData.keys() as Set<string>;
myStringData.keys();

Return Type: Set<string>

Creates a collection of the given IData members.

This attempts to give the most accurate type for the given members, for example, if all the members are bytes, then it returns a ByteArrayData.
However if the types are mixed or do not have a *ArrayData version, then a ListData is returned.

Returns: A list of the given members.

// StringData.listOf(members as IData[]) as IData;
StringData.listOf(1, 2, 3);

Parameters:

members: IData[] Type: IData[] - The members to put in the list.

Return Type: IData

Maps this IData to another IData based on the given operation.

Returns: A new IData from the operation

// StringData.map(operation as function(r as IData) as IData) as IData;
myStringData.map((data) => 3);

Parameters:

operation: function(r as IData) as IData Type: function(r as IData) as IData - The operation to apply to this IData

Return Type: IData

Merges the given data with this data.

Returns: the result of merging the datas.

// StringData.merge(other as IData) as IData;
myStringData.merge(myIData);

Parameters:

other: IData Type: IData - the data to merge

Return Type: IData

Puts the given value inside this IData at the given index.

// StringData.put(index as string, value as IData);
myStringData.put("key", "value");

Parameters:

index: string Type: string - The key to store the data at

value: IData Type: IData - The data to store.

Removes the stored data at the given index.

// StringData.remove(index as int);
myStringData.remove(0);

Parameters:

index: int Type: int - The index to remove.

Removes the stored data at the given key.

// StringData.remove(key as string);
myStringData.remove("key");

Parameters:

key: string Type: string - The key to remove.

Sets the given value inside this IData at the given index.

// StringData.setAt(name as string, data as IData);
myStringData.setAt(myString, myIData);

Parameters:

name: string Type: string - The key to store the data at

data: IData Type: IData - The data to store.