IData - CraftTweaker Documentation

Version:

Language:

Home Commands Examples Getting Started With Scripts Global Keywords

导入类

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.

ZenScript
 Copy
import crafttweaker.api.data.IData;

已实现的接口

IData implements the following interfaces. That means all methods defined in these interfaces are also available in IData

Comparable<IData>
stdlib.Iterable<IData>

Static Methods

listOf

Name: listOf

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.
Return Type: IData

ZenScript
 Copy
// IData.listOf(members as IData[]) as IData

IData.listOf(1, 2, 3);

参数	类型	描述
参数 members	类型 IData[]	描述 The members to put in the list.

Casters

Result Type	是否隐藏
Result Type 布尔值	是否隐藏 false
Result Type byte	是否隐藏 false
Result Type byte[]	是否隐藏 false
Result Type double	是否隐藏 false
Result Type float	是否隐藏 false
Result Type IData[string]	是否隐藏 false
Result Type int	是否隐藏 false
Result Type 整型[]	是否隐藏 false
Result Type long	是否隐藏 false
Result Type long[]	是否隐藏 false
Result Type short	是否隐藏 false
Result Type stdlib.List<IData>	是否隐藏 false
Result Type string	是否隐藏 false

使用方式

add

Name: add

Adds the given IData to this IData.

Returns: A new IData after adding the other data.
Return Type: IData

ZenScript
 Copy
// IData.add(other as IData) as IData

(1 as IData).add(2);

参数	类型	描述
参数 other	类型 IData #数据	描述 the other data to add.

asBool

Name: asBool

Casts this IData to a boolean.

Returns: this data as a bool
Return Type: boolean

ZenScript
 Copy
// IData.asBool() as boolean

(1 as IData).asBool();

asByte

Name: asByte

Casts this IData to a byte.

Returns: this data as a byte
Return Type: byte

ZenScript
 Copy
// IData.asByte() as byte

(1 as IData).asByte();

asByteArray

Name: asByteArray

Casts this IData to a byte array.

Returns: this data as a byte array
Return Type: byte[]

ZenScript
 Copy
// IData.asByteArray() as byte[]

(1 as IData).asByteArray();

asDouble

Name: asDouble

Casts this IData to a double.

Returns: this data as a double
Return Type: double

ZenScript
 Copy
// IData.asDouble() as double

(1 as IData).asDouble();

asFloat

Name: asFloat

Casts this IData to a float.

Returns: this data as a float
Return Type: float

ZenScript
 Copy
// IData.asFloat() as float

(1 as IData).asFloat();

asInt

Name: asInt

Casts this IData to an int.

Returns: this data as an int
Return Type: int

ZenScript
 Copy
// IData.asInt() as int

(1 as IData).asInt();

asIntArray

Name: asIntArray

Casts this IData to an int array.

Returns: this data as an int array
Return Type: int[]

ZenScript
 Copy
// IData.asIntArray() as int[]

(1 as IData).asIntArray();

asList

Name: asList

Casts this IData to a list.

Returns: this data as a list
Return Type: stdlib.List<IData>

ZenScript
 Copy
// IData.asList() as stdlib.List<IData>

(1 as IData).asList();

asLong

Name: asLong

Casts this IData to a long.

Returns: this data as a long
Return Type: long

ZenScript
 Copy
// IData.asLong() as long

(1 as IData).asLong();

asLongArray

Name: asLongArray

Casts this IData to a long array.

Returns: this data as a long array
Return Type: long[]

ZenScript
 Copy
// IData.asLongArray() as long[]

(1 as IData).asLongArray();

asMap

Name: asMap

Casts this IData to a map.

Returns: this data as a map
Return Type: IData[string]

ZenScript
 Copy
// IData.asMap() as IData[string]

(1 as IData).asMap();

asShort

Name: asShort

Casts this IData to a short.

Returns: this data as a short
Return Type: short

ZenScript
 Copy
// IData.asShort() as short

(1 as IData).asShort();

asString

Name: asString

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.
Return Type: string

ZenScript
 Copy
// IData.asString() as string

(1 as IData).asString();

compareTo

Name: compareTo

Compares this IData to the other IData

Returns: The comparison result.
Return Type: int

ZenScript
 Copy
// IData.compareTo(other as IData) as int

(1 as IData).compareTo(5);

参数	类型	描述
参数 other	类型 IData #数据	描述 the data to be compared.

copy

Name: copy

Return Type: IData

ZenScript
 Copy
// IData.copy() as IData

(1 as IData).copy();

getAsString

Name: getAsString

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.
Return Type: string

ZenScript
 Copy
// IData.getAsString() as string

(1 as IData).getAsString();

getId

Name: getId

Gets the internal ID of this data.

Returns: the intenral ID of this data.
Return Type: byte

ZenScript
 Copy
// IData.getId() as byte

(1 as IData).getId();

getKeys

Name: getKeys

Gets the keys of this IData

Returns: The keys of this IData.
Return Type: Set<string>

ZenScript
 Copy
// IData.getKeys() as Set<string>

(1 as IData).getKeys();

isEmpty

Name: isEmpty

Checks if this data is empty.

Returns: True if empty.
Return Type: boolean

ZenScript
 Copy
// IData.isEmpty() as boolean

(1 as IData).isEmpty();

length

Name: length

Gets the length of this IData.

Returns: The length of this IData.
Return Type: int

ZenScript
 Copy
// IData.length() as int

(1 as IData).length();

map

Name: map

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

Returns: A new IData from the operation
Return Type: IData

ZenScript
 Copy
// IData.map(operation as Function<IData,IData>) as IData

(1 as IData).map((data) => 3);

参数	类型	描述
参数 operation	类型 Function<IData,IData>	描述 The operation to apply to this IData

merge

Name: merge

Merges the given data with this data.

Returns: the result of merging the datas.
Return Type: IData

ZenScript
 Copy
IData.merge(other as IData) as IData

参数	类型	描述
参数 other	类型 IData #数据	描述 the data to merge

put

Name: put

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

ZenScript
 Copy
// IData.put(index as string, value as IData?)

new MapData().put("key", "value");

参数	类型	描述
参数 index	类型 string	描述 The key to store the data at
参数 value	类型 IData?	描述 The data to store.

remove

Name: remove

Removes the stored data at the given index.

ZenScript
 Copy
// IData.remove(index as int)

[1, 2, 3] as IData.remove(0);

参数	类型	描述
参数 index	类型 int	描述 The index to remove.

remove

Name: remove

Removes the stored data at the given key.

ZenScript
 Copy
// IData.remove(key as string)

{key: "value"} as IData.remove("key");

参数	类型	描述
参数 key	类型 string	描述 The key to remove.

setAt

Name: setAt

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

ZenScript
 Copy
IData.setAt(name as string, data as IData?)

参数	类型	描述
参数 name（名称）	类型 string	描述 The key to store the data at
参数 data	类型 IData?	描述 The data to store.

运算符

ADD

Name: ADD

Adds the given IData to this IData.

ZenScript
 Copy
myIData + other as IData
(1 as IData) + 2

AND

Name: AND

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

ZenScript
 Copy
myIData & other as IData
(1 as IData) & 2

CAT

Name: CAT

Concatenates the given IData to this IData.

ZenScript
 Copy
myIData ~ other as IData
(1 as IData) ~ 2

COMPARE

Name: COMPARE

Compares this IData to the other IData

ZenScript
 Copy
myIData < other as IData
(1 as IData) < 5

CONTAINS

Name: CONTAINS

Checks if this IData contains the other IData

For most data types, this will check equality of the data, but for map data, it will check if the other data is a string, and then check if it contains a key with that name

ZenScript
 Copy
other as IData in myIData

DIV

Name: DIV

Divides the given IData from this IData.

ZenScript
 Copy
myIData / other as IData
(1 as IData) / 2

EQUALS

Name: EQUALS

Checks if this IData is equal to the other IData.

ZenScript
 Copy
myIData == other as IData

INDEXGET

Name: INDEXGET

Gets the data at the given index.

ZenScript
 Copy
[myIData]
[[1, 2, 3] as IData]

INDEXSET

Name: INDEXSET

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

ZenScript
 Copy
[myIData] = index as string
[new MapData()] = "key"

MOD

Name: MOD

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

ZenScript
 Copy
myIData % other as IData
(1 as IData) % 2

MUL

Name: MUL

Multiplies the given IData to this IData.

ZenScript
 Copy
myIData * other as IData
(1 as IData) * 2

NEG

Name: NEG

Negates this IData.

ZenScript
 Copy
-myIData
-(1 as IData)

NOT

Name: NOT

Applies a NOT (!) operation to this IData.

ZenScript
 Copy
!myIData
!true

Name: OR

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

ZenScript
 Copy
myIData | other as IData
(1 as IData) | 2

SHL

Name: SHL

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

ZenScript
 Copy
myIData << other as IData
(1 as IData) << 2

SHR

Name: SHR

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

ZenScript
 Copy
myIData >> other as IData
(1 as IData) >> 2

SUB

Name: SUB

Subtracts the given IData from this IData.

ZenScript
 Copy
myIData - other as IData
(1 as IData) - 2

XOR

Name: XOR

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

ZenScript
 Copy
myIData ^ other as IData
(1 as IData) ^ 2

参数

名称	类型	可获得	可设置	描述
名称 isEmpty #是否为空	类型布尔值	可获得 true	可设置 false	描述 Checks if this data is empty.
名称 keys	类型 Set<string>	可获得 true	可设置 false	描述 Gets the keys of this IData
名称 length	类型 int	可获得 true	可设置 false	描述 Gets the length of this IData.

IData #数据

导入类

已实现的接口

Static Methods

Casters

使用方式

运算符

参数