Class Base

Base animations are used to display arbitrary model in the world.

Hierarchy (view full)

Base
- Animation.Item

Constructors

constructor

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

Methods

createRenderIfNeeded

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

Returns void
- 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
- Defined in Animation.d.ts:130

destroy

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

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

exists

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

getAge

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

getShaderUniforms

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

Since
2.0.2b20
- Defined in Animation.d.ts:71

load

load(): void
Loads animation in the world.

Returns void
- 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)
- 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
- Defined in Animation.d.ts:78

refresh

refresh(): void
Refreshes the animation.

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

resetBlockLightPos

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

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

setBlocklightMode

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

Returns void
- 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
- Defined in Animation.d.ts:39

setIgnoreBlocklight

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

setIgnoreLightMode

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

Returns void
- 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
- Defined in Animation.d.ts:27

setPos

setPos(x, y, z): void
Changes the animation's position.
Parameters
- x: number
- y: number
- z: number
Returns void
- 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
- Defined in Animation.d.ts:50

transform

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

updateRender

updateRender(): void
Refreshes the animation.

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

Class Base

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Base

Methods

createRenderIfNeeded

Returns void

describe

Parameters

Optionalmaterial?: string

Since

Optionalmesh?: RenderMesh

Since

Optionalrender?: number

Optionalscale?: number

Default

Optionalskin?: string

Returns void

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

setBlocklightMode

Returns void

setBlockLightPos

Parameters

Returns void

setIgnoreBlocklight

Parameters

Returns void

Deprecated

setIgnoreLightMode

Returns void

setInterpolationEnabled

Parameters

Returns void

setPos

Parameters

Returns void

setSkylightMode

Returns void

transform

Returns Render.Transform

updateRender

Returns void

Settings

On This Page

`Optional`material?: string

`Optional`mesh?: RenderMesh

`Optional`render?: number

`Optional`scale?: number

`Optional`skin?: string