Voxel model

Load a .vox file from the project's Files folder.

Load a .vox file from a URL (must allow cross-origin access).

Switch between orthographic and perspective camera.

Set the extra scale of the model on each axis, in percent (100 = normal).

Shift the model inside its box, in pixels along the model's own axes.

Change how the model is sized inside the object's box.

Turn the soft shading in creases on or off.

Change every model colour that matches a colour to another colour, for example to make colour variants of one model. Use rgb(r, g, b) for the colours. The change stays until Reset colours or a new model is loaded.

Change one colour of the model by its MagicaVoxel palette index (1-255).

Bring back the colours stored in the .vox file.

Remove one voxel, for example where the model was hit. The cut goes through all animation frames. Restore voxels brings it back.

Put a voxel of a palette colour (1-255) at a position inside the model's box, or recolour the voxel that is there.

Fill empty space enclosed inside the model (a hollow shell), so a hole cut into the surface shows a solid interior. Each new voxel takes the colour of the nearest voxel.

Bring back the voxels stored in the .vox file (undoes every removal and addition).

The whole model bursts into cubes that fly away from the explosion point, tumble and fall to the floor (the object's Z elevation). Use Restore voxels to get the model back. Works in 3D scene mode.

Voxels within a radius of a point are thrown off as debris and removed from the model, for example where it was hit.

Triggered when a .vox file has finished loading.

Triggered when loading a .vox file failed. See LastError.

True if a model is currently loaded.

True while the performance option is switched on (see Set option).

Triggered when all debris has come to rest (or has disappeared).

True while pieces are still flying, sliding or turning.

True when a straight path between two layout positions (for example a bullet's last and current position, each with X, Y and height Z) passes through a voxel. Picks the model instances that are hit, so the actions of the same event only affect those. Every voxel on the path is tested, so a bullet cannot skip a thin part. HitX, HitY and HitZ give the first voxel on the path.

Triggered each time a piece of debris hits the floor or the model hard enough, once per piece and per impact (a piece that bounces reports every bounce), strongest first and at most a few per tick (see Set landing limit). Read where and how hard with LandX, LandY, LandZ and LandSpeed, for example to play a sound.

True when the last Path hits model (or SegmentHit) of this model hit a voxel of the model (every voxel, in this edition). False when nothing was hit.

Triggered when the rest of the model falls apart because fewer voxels are left than Collapse below (see Collapse when few voxels are left). BrokenCount is how many voxels fell apart, BrokenX, BrokenY and BrokenZ where the middle of them was: use it for the sound of a collapse.

Model width in voxels.

Model depth in voxels.

Model height in voxels.

Number of voxels in the model.

Number of exposed voxel faces.

Palette index (1-255) of the voxel at a 0-based position, or 0 if empty.

Message of the last load error.

Colour of a palette index (1-255), as a number you can pass to the colour actions. Use GetRValue / GetGValue / GetBValue-style maths or compare it with rgb(r, g, b).

How many voxels have been removed from the model so far (in the current animation frame).

Number of debris pieces that are still visible.

X index of the voxel cell at a layout position (0-based; can be outside the model).

Y index of the voxel cell at a layout position (0-based; can be outside the model).

Z index of the voxel cell at a layout position (0-based; can be outside the model).

1 if the first voxel found by the last SegmentHit or Path hits model that returned true is glass, otherwise 0 (always 0 for a model that has Glass shatters switched off).

1 if the voxel at a layout position (X, Y and height Z) is glass, otherwise 0 (also 0 where there is no voxel, and for a model that has Glass shatters switched off).

1 if there is a voxel at a layout position (X, Y and height Z), otherwise 0. Use it to test where a bullet really hits the model.

1 if a straight path from one layout position to another (for example a bullet's last and current position, each with X, Y and height Z) passes through a voxel, otherwise 0. Unlike SolidAt a fast bullet cannot jump over the model. When it returns 1, HitX, HitY and HitZ give the first voxel on the path.

Layout X of the first voxel found by the last SegmentHit that returned 1.

Layout Y of the first voxel found by the last SegmentHit that returned 1.

Layout height (Z elevation) of the first voxel found by the last SegmentHit that returned 1.

Lowest of the model's box in the layout (the whole voxel space of the model, following the object's angle, size and offset): X.

Highest of the model's box in the layout (the whole voxel space of the model, following the object's angle, size and offset): X.

Lowest of the model's box in the layout (the whole voxel space of the model, following the object's angle, size and offset): Y.

Highest of the model's box in the layout (the whole voxel space of the model, following the object's angle, size and offset): Y.

Lowest of the model's box in the layout (the whole voxel space of the model, following the object's angle, size and offset): height (Z elevation).

Highest of the model's box in the layout (the whole voxel space of the model, following the object's angle, size and offset): height (Z elevation).

The height (Z) where debris comes to rest right now.

Milliseconds the plugin spends drawing this object per frame (building and sorting the geometry and handing the quads to the renderer), averaged over about ten frames. The graphics card's own time is not included. Use it to see whether the plugin is what slows the game down.

Number of quads (faces) the plugin handed to the renderer in the last frame, including debris. Fewer quads means less work for the engine and the graphics card.

Part of DrawMs spent building, culling and sorting the geometry for the camera (averaged over about ten frames; drops towards 0 when nothing needs rebuilding).

Part of DrawMs spent handing the quads to the renderer (averaged over about ten frames). It grows with QuadCount.

Layout X of the landing that On debris landed is reporting.

Layout Y of the landing that On debris landed is reporting.

Height (Z) of the landing that On debris landed is reporting.

Impact speed (pixels per second) of the landing that On debris landed is reporting: use it for the volume of a sound.

What the piece hit: 0 = the floor, 1 = the model.

How the rock broke in the last On rock broken: 0 = the whole rock broke into its first pieces, 1 = a piece broke into smaller pieces, 2 = a piece crumbled into cubes.

How many voxels broke in the hit that On voxels broken is reporting.

Layout X of the hit that On voxels broken is reporting.

Layout Y of the hit that On voxels broken is reporting.

Height (Z) of the hit that On voxels broken is reporting.

1 when the model was drawn from a mesh kept in the graphics card in the last frame (it stands still), 0 when it was drawn face by face.

A short text that tells which features this build of the plugin has, for example when you are not sure that the newest addon file is the one that is loaded.

1 while the model is outside the view of the 3D Camera and is therefore skipped, otherwise 0. Use it to see whether a model that seems to disappear is being skipped.