Class Item

Item animations are used to display items or blocks models in the world.

Hierarchy (view full)

Base
- Item

Constructors

constructor

new Item(x, y, z): Animation.Item
Constructs a new Item animation on the specified coordinates.
Parameters
- x: number
- y: number
- z: number
Returns Animation.Item
Overrides Base.constructor
- Defined in Animation.d.ts:176

Methods

createRenderIfNeeded

createRenderIfNeeded(): void
Creates render if it was not previously created and applies all the parameters from animation description.

Returns void
Inherited from Base.createRenderIfNeeded
- Defined in Animation.d.ts:95

describe

describe(description): void
Describes animation parameters for the future use. Call load or loadCustom to actually launch the animation.
Parameters
- description: {
      material?: string;
      mesh?: RenderMesh;
      render?: number;
      scale?: number;
      skin?: string;
  }
  an object containing all the required data about animation
  - Optionalmaterial?: string
    Animation material, can be used to apply custom materials to the animation.
    
    Since
    2.0.2b20
  - Optionalmesh?: RenderMesh
    RenderMesh object to be displayed with animation.
    
    Since
    2.0.2b20
  - Optionalrender?: number
    Numeric ID of the Render object to be displayed with animation. Can be obtained using Render.getId
  - Optionalscale?: number
    Animation scale.
    Default
    1
  - Optionalskin?: string
    Name of the texture to be used as render's skin.
Returns void
Inherited from Base.describe
- Defined in Animation.d.ts:130

describeItem

describeItem(item): void
Describes item to be used for the animation.
Parameters
- item: {
      count?: number;
      data?: number;
      extra?: ItemExtraData;
      glint?: boolean;
      id: number;
      material?: string;
      notRandomize?: boolean;
      rotation?: string | [number, number, number];
      size?: number;
      skin?: string;
  }
  item parameters object
  - Optionalcount?: number
    Item count, will be transform to display an appropriate animation.
  - Optionaldata?: number
    Item data.
  - Optionalextra?: ItemExtraData
    Item extra.
  - Optionalglint?: boolean
    Whether the item should be in glint state or not.
  - id: number
    Item ID.
  - Optionalmaterial?: string
    Shader material name.
    
    Since
    2.0.2b20
  - OptionalnotRandomize?: boolean
    If true, the position of the item will not be randomized.
  - Optionalrotation?: string | [number, number, number]
    If string "x" is passed, the item is rotated 90 along x axis, if "z" is passed, the item is rotated 90 along z axis, otherwise the item is rotated according to the rotation array along all the three axes.
  - Optionalsize?: number
    Item/block size.
    Default
    0.5
  - Optionalskin?: string
    Skin name to be used for the render. If no skin is passed, default item skin is used.
Returns void
- Defined in Animation.d.ts:182

describeItemDefault

describeItemDefault(item): void
Parameters
- item: any
Returns void
Deprecated
Consider using describeItem instead.
- Defined in Animation.d.ts:234

destroy

destroy(): void
Destroys animation and releases all the resources.

Returns void
Inherited from Base.destroy
- Defined in Animation.d.ts:161

exists

exists(): boolean
Returns boolean
Since
2.1.0b60
Inherited from Base.exists
- Defined in Animation.d.ts:166

getAge

getAge(): void
Returns void
Deprecated
Backwards compatibility, render doesn't have attributes.
Inherited from Base.getAge
- Defined in Animation.d.ts:117

getShaderUniforms

getShaderUniforms(): ShaderUniformSet
Returns ShaderUniformSet
Object for current animation's render.

Since
2.0.2b20
Inherited from Base.getShaderUniforms
- Defined in Animation.d.ts:71

load

load(): void
Loads animation in the world.

Returns void
Inherited from Base.load
- Defined in Animation.d.ts:105

loadCustom

loadCustom(func): void
Loads animation in the world registering it as an Updatable.
Parameters
- func: (() => void)
  function to be used as Updatable.update function
  - - (): void
    - Returns void
Returns void
Since
2.3.1b116 (client-side)
Inherited from Base.loadCustom
- Defined in Animation.d.ts:112

newTransform

newTransform(transformations, noClear): void
Creates a set of transformations for the current animation.
Parameters
- transformations: {
  name: string;
  params: any[];
  }[]
- noClear: boolean
Returns void
Inherited from Base.newTransform
- Defined in Animation.d.ts:78

refresh

refresh(): void
Refreshes the animation.

Returns void
Inherited from Base.refresh
- Defined in Animation.d.ts:122

resetBlockLightPos

resetBlockLightPos(): void
Resets light measuring position for the animation (to it's coordinates).

Returns void
Inherited from Base.resetBlockLightPos
- Defined in Animation.d.ts:44

resetTransform

resetTransform(): void
Resets all the transformations made via transform calls.

Returns void
- Defined in Animation.d.ts:239

setBlocklightMode

setBlocklightMode(): void
Sets light measuring to match the animation coordinated.

Returns void
Inherited from Base.setBlocklightMode
- Defined in Animation.d.ts:55

setBlockLightPos

setBlockLightPos(x, y, z): void
Sets specified coordinates as light measuring position for the animation. In other words, animation lightning will be calculated as if animation was at the specified coordinates.
Parameters
- x: number
- y: number
- z: number
Returns void
Inherited from Base.setBlockLightPos
- Defined in Animation.d.ts:39

setIgnoreBlocklight

setIgnoreBlocklight(ignore): void
Parameters
- ignore: boolean
Returns void
Deprecated
Use setBlockLightPos and related methods instead.
Inherited from Base.setIgnoreBlocklight
- Defined in Animation.d.ts:32

setIgnoreLightMode

setIgnoreLightMode(): void
Makes the animation ignore light at all.

Returns void
Inherited from Base.setIgnoreLightMode
- Defined in Animation.d.ts:60

setInterpolationEnabled

setInterpolationEnabled(enabled): void
Parameters
- enabled: boolean
  if true, animation position will be interpolated between tick calls
Returns void
Inherited from Base.setInterpolationEnabled
- Defined in Animation.d.ts:27

setItemRotation

setItemRotation(x, y, z): void
Specifies item rotation along the three axes.
Parameters
- x: number
- y: number
- z: number
Returns void
Default
```
x: 0, y: 0, z: 0
```
- Defined in Animation.d.ts:245

setItemSize

setItemSize(size): void
Specifies item size.
Parameters
- size: number
Returns void
Default
```
0.5
```
- Defined in Animation.d.ts:251

setItemSizeAndRotation

setItemSizeAndRotation(size, x, y, z): void
Specifies item size and rotation via single function call.
Parameters
- size: number
- x: number
- y: number
- z: number
Returns void
- Defined in Animation.d.ts:256

setPos

setPos(x, y, z): void
Changes the animation's position.
Parameters
- x: number
- y: number
- z: number
Returns void
Inherited from Base.setPos
- Defined in Animation.d.ts:21

setSkylightMode

setSkylightMode(): void
Sets light measuring position to always match day/night lightning, even when the animation is not directly illuminated.

Returns void
Inherited from Base.setSkylightMode
- Defined in Animation.d.ts:50

transform

transform(): Render.Transform
Returns Render.Transform
Object for current animation's render.
Inherited from Base.transform
- Defined in Animation.d.ts:65

updateRender

updateRender(): void
Refreshes the animation.

Returns void
Inherited from Base.updateRender
- Defined in Animation.d.ts:100

Class Item

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Animation.Item

Methods

createRenderIfNeeded

Returns void

describe

Parameters

Optionalmaterial?: string

Since

Optionalmesh?: RenderMesh

Since

Optionalrender?: number

Optionalscale?: number

Default

Optionalskin?: string

Returns void

describeItem

Parameters

Optionalcount?: number

Optionaldata?: number

Optionalextra?: ItemExtraData

Optionalglint?: boolean

id: number

Optionalmaterial?: string

Since

OptionalnotRandomize?: boolean

Optionalrotation?: string | [number, number, number]

Optionalsize?: number

Default

Optionalskin?: string

Returns void

describeItemDefault

Parameters

Returns void

Deprecated

destroy

Returns void

exists

Returns boolean

Since

getAge

Returns void

Deprecated

getShaderUniforms

Returns ShaderUniformSet

Since

load

Returns void

loadCustom

Parameters

Returns void

Returns void

Since

newTransform

Parameters

Returns void

refresh

Returns void

resetBlockLightPos

Returns void

resetTransform

Returns void

setBlocklightMode

Returns void

setBlockLightPos

Parameters

Returns void

setIgnoreBlocklight

Parameters

Returns void

Deprecated

setIgnoreLightMode

Returns void

`Optional`material?: string

`Optional`mesh?: RenderMesh

`Optional`render?: number

`Optional`scale?: number

`Optional`skin?: string

`Optional`count?: number

`Optional`data?: number

`Optional`extra?: ItemExtraData

`Optional`glint?: boolean

`Optional`material?: string

`Optional`notRandomize?: boolean

`Optional`rotation?: string | [number, number, number]

`Optional`size?: number

`Optional`skin?: string