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

Classes

CONDITION

internal

CONDITION:

Common superclass for all condition classes.

constructor

• new CONDITION(ptr: number): CONDITION

• @since

  2.3.1b116

  ---

  Parameters

  • ptr: number

  Returns CONDITION

CollisionShape

CollisionShape:

Class representing custom collision shapes used for block.

constructor

• new CollisionShape(): CollisionShape

• Constructs a base model that will be raycasted in world.

  ---

  Returns CollisionShape

addEntry

• addEntry(): CollisionEntry

• Adds new entry to the collision shape. You can then call CollisionEntry.setCondition to specify when to display the entry.

  ---

  Returns CollisionEntry

clear

• clear(): void

• @since

  2.2.1b96

  ---

  Returns void

getPtr

• getPtr(): number

• Returns number

Model

Model:

constructor

• new Model(model?: Model): Model

• Constructs a base model that will be displayed in world.

  ---

  Parameters

  • optionalmodel: Model

    optional model to be added without additional conditions

  Returns Model

addEntry

• addEntry(model?: Model): RenderEntry
• addEntry(mesh?: RenderMesh): RenderEntry

• Adds block model as an entry to the ICRender. You can then call RenderEntry.asCondition to specify when to display the entry.

  ---

  Parameters

  • optionalmodel: Model

  Returns RenderEntry

  Created ICRender.RenderEntry object.

clear

• clear(): void

• @since

  2.2.1b96

  ---

  Returns void

getPtr

• getPtr(): number

• Returns number

abstractRANDOM_CONDITION

RANDOM_CONDITION:

Condition depending on random value.

@since

2.0.2b23

constructor

• new RANDOM_CONDITION(): RANDOM_CONDITION

• Returns RANDOM_CONDITION

setAxisEnabled

• setAxisEnabled(axis: number, enabled: boolean): RANDOM_CONDITION

• Forces engine to treat blocks along some axis in same way if enabled parameter value is false.

  ---

  Parameters

  • axis: number

    0 fpr x, 1 for y, 2 for z axis

  • enabled: boolean

  Returns RANDOM_CONDITION

Interfaces

CollisionEntry

CollisionEntry:

Object representing collision shape entry with it's displaying condition.

addBox

• addBox(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number): CollisionEntry

• Adds new collision box to collision entry.

  ---

  Parameters

  • x1: number

  • y1: number

  • z1: number

  • x2: number

  • y2: number

  • z2: number

  Returns CollisionEntry

  Reference to itself to be used in sequential calls.

setCondition

• setCondition(condition: CONDITION): CollisionEntry

• Sets condition, all the boxes of the entry work only if the condition is true.

  ---

  Parameters

  • condition: CONDITION

  Returns CollisionEntry

  Reference to itself to be used in sequential calls.

Group

Group:

Groups (of blocks) are used to determine some render conditions; e.g., if a block exists on some relative coordinates, display some part of the model.

name

name: string

add

• add(id: number, data: number): void

• Adds a block to the group.

  ---

  Parameters

  • id: number

    block ID

  • data: number

    block data or -1 to use with all registered data values

  Returns void

getName

• getName(): string

• ---

  Returns string

  Group's name.

RenderEntry

RenderEntry:

Object representing render entry with it's displaying condition.

asCondition

• asCondition(x: number, y: number, z: number, group: string | Group, mode: number): RenderEntry
• asCondition(x: number, y: number, z: number, id: number, data: number, mode: number): RenderEntry

• Sets ICRender.BLOCK condition with specified parameters. Uses coordinates that are relative to current block's ones.

  ---

  Parameters

  • x: number

  • y: number

  • z: number

  • group: string | Group

    group name or object

  • mode: number

    one of the ICRender.MODE_INCLUDE and ICRender.MODE_EXCLUDE constants

  Returns RenderEntry

  Reference to itself to be used in sequential calls.

getParent

• getParent(): Model

• ---

  Returns Model

  Parent ICRender.Model object this entry belongs to.

setCondition

• setCondition(condition: CONDITION): RenderEntry

• Sets condition to be used for current entry.

  ---

  Parameters

  • condition: CONDITION

  Returns RenderEntry

  Reference to itself to be used in sequential calls.

setMesh

• setMesh(mesh: RenderMesh): RenderEntry

• Sets render mesh to be used for the entry.

  ---

  Parameters

  • mesh: RenderMesh

  Returns RenderEntry

  Reference to itself to be used in sequential calls.

setModel

• setModel(x: number, y: number, z: number, model: Model): RenderEntry
• setModel(model: Model): RenderEntry

• Sets block model used for the entry, specifying it's coordinates.

  ---

  Parameters

  • x: number

  • y: number

  • z: number

  • model: Model

  Returns RenderEntry

  Reference to itself to be used in sequential calls.

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

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

  @since

  2.3.1b116

  ---

  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 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

• Constructs new ICRender.RANDOM_CONDITION condition.

  @since

  2.0.2b23

  ---

  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