Previous
ListData LongData
Next

LongArrayData

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.

script.zs
import crafttweaker.api.data.LongArrayData;

Description

Implements

LongArrayData implements the following interfaces:

IData

Undocumented Interfaces

Comparable<IData>,Iterable<IData>

Constructors

new
new(internal as long[])
script.zs
// new LongArrayData(internal as long[]);
new LongArrayData(myLong[]);

Parameters:

internal Type: long[]

Operators

+
+(other as IData) as IData
Adds the given IData to this IData.
script.zs
// (LongArrayData + (other as IData)) as IData
myLongArrayData + myIData

Parameters:

other Type: IData - the other data to add.

Return Type: IData

&
&(other as IData) as IData
Applies a bitwise AND (&) operation to this IData and the other IData
script.zs
// (LongArrayData & (other as IData)) as IData
myLongArrayData & myIData

Parameters:

other Type: IData - the other data.

Return Type: IData

~
~(other as IData) as IData
Concatenates the given IData to this IData.
script.zs
// (LongArrayData ~ (other as IData)) as IData
myLongArrayData ~ myIData

Parameters:

other Type: IData - the other data to concatenate.

Return Type: IData

/
/(other as IData) as IData
Divides the given IData from this IData.
script.zs
// (LongArrayData / (other as IData)) as IData
myLongArrayData / myIData

Parameters:

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

Return Type: IData

[]
[](key as string) as IData
Gets the data at the given key.
script.zs
// LongArrayData[key as string] as IData
myLongArrayData[myString]

Parameters:

key Type: string - The key to get

Return Type: IData

%
%(other as IData) as IData
Applies a modulo operation to this IData against the other IData.
script.zs
// (LongArrayData % (other as IData)) as IData
myLongArrayData % myIData

Parameters:

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

Return Type: IData

*
*(other as IData) as IData
Multiplies the given IData to this IData.
script.zs
// (LongArrayData * (other as IData)) as IData
myLongArrayData * myIData

Parameters:

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

Return Type: IData

-
- as IData
Negates this IData.
script.zs
// (-LongArrayData) as IData
-myLongArrayData

Return Type: IData

!
! as IData
Applies a NOT (!) operation to this IData.
script.zs
// (!LongArrayData) as IData
!myLongArrayData

Return Type: IData

|
|(other as IData) as IData
Applies a bitwise OR (|) operation to this IData and the other IData
script.zs
// (LongArrayData | (other as IData)) as IData
myLongArrayData | myIData

Parameters:

other Type: IData - the other data.

Return Type: IData

<<
<<(other as IData) as IData
Applies a SHL (<<) operation to this data by the other data
script.zs
// (LongArrayData << (other as IData)) as IData
myLongArrayData << myIData

Parameters:

other Type: IData - The data to SHL by.

Return Type: IData

>>
>>(other as IData) as IData
Applies a SHR (>>) operation to this data by the other data
script.zs
// (LongArrayData >> (other as IData)) as IData
myLongArrayData >> myIData

Parameters:

other Type: IData - The data to SHR by.

Return Type: IData

-
-(other as IData) as IData
Subtracts the given IData from this IData.
script.zs
// (LongArrayData - (other as IData)) as IData
-myLongArrayData

Parameters:

other Type: IData - the other data to remove.

Return Type: IData

^
^(other as IData) as IData
Applies a bitwise XOR (^) operation to this IData and the other IData
script.zs
// (LongArrayData ^ (other as IData)) as IData
myLongArrayData ^ myIData

Parameters:

other Type: IData - the other data.

Return Type: IData

Members

add
add(other as IData) as IData
Adds the given IData to this IData.

Returns: A new IData after adding the other data.

script.zs
// LongArrayData.add(other as IData) as IData;
myLongArrayData.add(2);

Parameters:

other Type: IData - the other data to add.

Return Type: IData

asBool
asBool() as bool
Casts this IData to a boolean.

Returns: this data as a bool

script.zs
// LongArrayData.asBool() as bool;
myLongArrayData.asBool();

Return Type: bool

as bool
Casts this IData to a boolean.
script.zs
// LongArrayData as bool
myLongArrayData as bool

Return Type: bool

asByte
asByte() as byte
Casts this IData to a byte.

Returns: this data as a byte

script.zs
// LongArrayData.asByte() as byte;
myLongArrayData.asByte();

Return Type: byte

as byte
Casts this IData to a byte.
script.zs
// LongArrayData as byte
myLongArrayData as byte

Return Type: byte

asDouble
asDouble() as double
Casts this IData to a double.

Returns: this data as a double

script.zs
// LongArrayData.asDouble() as double;
myLongArrayData.asDouble();

Return Type: double

as double
Casts this IData to a double.
script.zs
// LongArrayData as double
myLongArrayData as double

Return Type: double

asFloat
asFloat() as float
Casts this IData to a float.

Returns: this data as a float

script.zs
// LongArrayData.asFloat() as float;
myLongArrayData.asFloat();

Return Type: float

as float
Casts this IData to a float.
script.zs
// LongArrayData as float
myLongArrayData as float

Return Type: float

asInt
asInt() as int
Casts this IData to an int.

Returns: this data as an int

script.zs
// LongArrayData.asInt() as int;
myLongArrayData.asInt();

Return Type: int

as int
Casts this IData to an int.
script.zs
// LongArrayData as int
myLongArrayData as int

Return Type: int

asLong
asLong() as long
Casts this IData to a long.

Returns: this data as a long

script.zs
// LongArrayData.asLong() as long;
myLongArrayData.asLong();

Return Type: long

as long
Casts this IData to a long.
script.zs
// LongArrayData as long
myLongArrayData as long

Return Type: long

asMap
asMap() as IData[string]
Casts this IData to a map.

Returns: this data as a map

script.zs
// LongArrayData.asMap() as IData[string];
myLongArrayData.asMap();

Return Type: IData[string]

as IData[string]
Casts this IData to a map.
script.zs
// LongArrayData as IData[string]
myLongArrayData as IData[string]

Return Type: IData[string]

asShort
asShort() as short
Casts this IData to a short.

Returns: this data as a short

script.zs
// LongArrayData.asShort() as short;
myLongArrayData.asShort();

Return Type: short

as short
Casts this IData to a short.
script.zs
// LongArrayData as short
myLongArrayData as short

Return Type: short

asString
asString() as 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.

script.zs
// LongArrayData.asString() as string;
myLongArrayData.asString();

Return Type: string

getAsString
getAsString() as 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.

script.zs
// LongArrayData.getAsString() as string;
myLongArrayData.getAsString();

Return Type: string

as string
Gets the literal string version of this IData.

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

script.zs
// LongArrayData as string
myLongArrayData as string

Return Type: string

getId
getId() as byte
Gets the internal ID of this data.

Returns: the intenral ID of this data.

script.zs
// LongArrayData.getId() as byte;
myLongArrayData.getId();

Return Type: byte

isEmpty
Getter
Checks if this data is empty.
script.zs
// LongArrayData.isEmpty as bool
myLongArrayData.isEmpty

Return Type: bool

isEmpty() as bool
Checks if this data is empty.

Returns: True if empty.

script.zs
// LongArrayData.isEmpty() as bool;
myLongArrayData.isEmpty();

Return Type: bool

keys
Getter
Gets the keys of this IData
script.zs
// LongArrayData.keys as Set<string>
myLongArrayData.keys

Return Type: Set<string>

keys() as Set<string>
Gets the keys of this IData

Returns: The keys of this IData.

script.zs
// LongArrayData.keys() as Set<string>;
myLongArrayData.keys();

Return Type: Set<string>

listOf
static listOf(members as IData[]) as IData
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.

script.zs
// LongArrayData.listOf(members as IData[]) as IData;
LongArrayData.listOf(1, 2, 3);

Parameters:

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

Return Type: IData

map
map(operation as function(r as IData) as IData) as IData
Maps this IData to another IData based on the given operation.

Returns: A new IData from the operation

script.zs
// LongArrayData.map(operation as function(r as IData) as IData) as IData;
myLongArrayData.map((data) => 3);

Parameters:

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

Return Type: IData

merge
merge(other as IData) as IData
Merges the given data with this data.

Returns: the result of merging the datas.

script.zs
// LongArrayData.merge(other as IData) as IData;
myLongArrayData.merge(myIData);

Parameters:

other Type: IData - the data to merge

Return Type: IData

remove
remove(key as string)
Removes the stored data at the given key.
script.zs
// LongArrayData.remove(key as string);
myLongArrayData.remove("key");

Parameters:

key Type: string - The key to remove.
setAt
setAt(name as string, data as IData)
Sets the given value inside this IData at the given index.
script.zs
// LongArrayData.setAt(name as string, data as IData);
myLongArrayData.setAt(myString, myIData);

Parameters:

name Type: string - The key to store the data at
data Type: IData - The data to store.
Previous
ListData LongData
Next