ICRender

Class used to define block models that depend on surrounding blocks. Some examples of such blocks are wires, pipes, block structure parts, etc.

Index

Classes

• CONDITION
• CollisionShape
• Model
• RANDOM_CONDITION

Interfaces

• CollisionEntry
• Group
• RenderEntry

Variables

• MODE_EXCLUDE
• MODE_INCLUDE

Functions

• AND
• BLOCK
• BlockState
• NOT
• OR
• RANDOM
• getGroup
• getUnnamedGroup

Variables

constMODE_EXCLUDE

MODE_EXCLUDE: 1 = 1

Used to specify that the block should be absent to satisfy condition.

constMODE_INCLUDE

MODE_INCLUDE: 0 = 0

Used to specify that the block should be present to satisfy condition.

Functions

AND

• AND(...conditions: CONDITION[]): CONDITION

• Constructs new ICRender.AND condition.

  ---

  Parameters

  • rest...conditions: CONDITION[]

  Returns CONDITION

BLOCK

• BLOCK(x: number, y: number, z: number, group: Group, exclude: boolean): CONDITION

• Constructs new ICRender.BLOCK condition.

  ---

  Parameters

  • x: number

    is relative x coordinate

  • y: number

    is relative y coordinate

  • z: number

    is relative z coordinate

  • group: Group

    blocks group to check the condition for

  • exclude: boolean

    if true, the blocks from the group make the condition evaluate as false, as true otherwise

  Returns CONDITION

BlockState

• BlockState(x: number, y: number, z: number, state: number, value: number): CONDITION
• BlockState(state: number, value: number): CONDITION

• since: 2.3.1b116

  Constructs new ICRender.BlockState condition that uses block state data (it must match the value) to display.

  ---

  Parameters

  • x: number

    is relative x coordinate

  • y: number

    is relative y coordinate

  • z: number

    is relative z coordinate

  • state: number

    one of EBlockStates values or custom one of relative block

  • value: number

    value to match selected state

  Returns CONDITION

NOT

• NOT(condition: CONDITION): CONDITION

• Constructs new ICRender.NOT condition.

  ---

  Parameters

  • condition: CONDITION

    condition to be inverted

  Returns CONDITION

OR

• OR(...conditions: CONDITION[]): CONDITION

• Constructs new ICRender.OR condition.

  ---

  Parameters

  • rest...conditions: CONDITION[]

  Returns CONDITION

RANDOM

• RANDOM(value: number, max: number, seed?: number): RANDOM_CONDITION
• RANDOM(max: number): RANDOM_CONDITION

• since: 2.0.2b23

  Constructs new ICRender.RANDOM_CONDITION condition.

  ---

  Parameters

  • value: number

    value that a generated random integer number should be for the condition to evaluate as true

  • max: number

    maximum value for the generator

  • optionalseed: number

    seed to be used for random numbers generation

  Returns RANDOM_CONDITION

getGroup

• getGroup(name: string): ICRender.Group

• Parameters

  • name: string

    group name

  Returns ICRender.Group

  Block group by it's name, if no group with specified name exist, this function creates a new one.

getUnnamedGroup

• getUnnamedGroup(): ICRender.Group

• Creates a new group with a unique name.

  ---

  Returns ICRender.Group