Confirmedusers
509
edits
Modding:Block Tessellator: Difference between revisions
From Vintage Story Wiki
Undo revision 137745 by Bluelightning32 (talk)
(Describe the json tessellator's level of detail handling) |
(Undo revision 137745 by Bluelightning32 (talk)) Tag: Undo |
||
| Line 1: | Line 1: | ||
Each visible chunk is tessellated into a mesh, and that mesh is reused until the chunk is unloaded, or the chunk is marked dirty. The chunk is retessellated on a [[Modding:Render_Stages|background thread]] when it is marked dirty. | |||
The chunk tessellator calls a block tessellator for each block in the chunk. Blocks select their tessellator through the [[Modding:Block_Json_Properties|drawtype]] property. The property value is an [https://apidocs.vintagestory.at/api/Vintagestory.API.Client.EnumDrawType.html EnumDrawType], and the parsing is case insensitive. | |||
== BlockLayer == | |||
The BlockLayer tessellators draw a cube with the top cut off. In vanilla it is only used by the charcoal pile block. The block properties should specify a texture for all 6 sides of the block, or specify the same texture for all sides through the "all" alias. The texture is anchored at the [https://github.com/anegostudios/VintageStory-Issues/issues/3167 top] of the block. | |||
The [[Modding:Block_Json_Properties#p_renderpass|renderpass]] property is respected. | |||
The <code>doNotRenderAtLod2</code> property is ignored. The block is always drawn at [[Modding:Level_of_detail|level]] 1. | |||
Specifically, this tessellator category contains 7 tessellators. The number at the end represents how tall to draw the block, in eighths of a block. BlockLayer_0 is not a valid tessellator, because the surface tessellator is more appropriate for a 0 high block. BlockLayer_8 is not a valid tessellator, because Cube should be used instead for full blocks. | |||
* BlockLayer_1 | |||
* BlockLayer_2 | |||
* BlockLayer_3 | |||
* BlockLayer_4 | |||
* BlockLayer_5 | |||
* BlockLayer_6 | |||
* BlockLayer_7 | |||
== JSON == | == JSON == | ||
Draws a json model. | |||
== Empty == | |||
Skips tessellating the block. | |||
== Cube == | |||
Draws a full height cube. The block properties should specify a texture for all 6 sides of the block, or specify the same texture for all sides through the "all" alias. | |||
The [[Modding:Block_Json_Properties#p_renderpass|renderpass]] property is respected. Typically the default Opaque <code>renderpass</code> is used with the cube tessellator. Transparent should be used for semitransparent blocks like glass. | |||
The <code>doNotRenderAtLod2</code> property is ignored. The cube is always drawn at [[Modding:Level_of_detail|level]] 1. | |||
== Cross == | |||
The CrossTesselator is used by tallgrass (and other heights). It only uses the "north" and "south" textures of the block. It draws the two rectangles from one corner the other such that they intersect at a line going from the center of the bottom face to the center of the top face. If the <code>randomizeRotations</code> property of the block is true, then the tesselator rotates the cross about the y axis. | |||
The [[Modding:Block_Json_Properties#p_renderpass|renderpass]] property is respected. | |||
The <code>doNotRenderAtLod2</code> property is respected. When false, the block is drawn at [[Modding:Level_of_detail|level]] 1 (always visible). When true, the block is drawn at level 2 (not visible far away). This was previously used to stop far away grass from rendering (set doNotRenderAtLod2 to true), but that property was removed from the tallgrass block in 1.17.0-pre.1. | |||
== Transparent == | |||
This tessellator appears to be deprecated. Instead use the cube tessellator with the <code>renderpass</code> property set to "transparent". | |||
== Liquid == | |||
Renders the block as a cube with the top chopped off, based on the [[Modding:Block_Json_Properties#p_liquidlevel liquidLevel]] block property. The tessellator also looks at the neighboring blocks to see if the liquid is flowing towards them, and if so it adjusts the angle of the top of the cube. It also adds custom ints and floats to the mesh to handle rendering waves in the liquid. | |||
The tessellator always uses the Liquid render pass; the <code>renderpass</code> block property is ignored. | |||
The <code>doNotRenderAtLod2</code> property is ignored. The block is always drawn at level 1 (visible everywhere within the frustum). | |||
Liquid blocks are recommended to set these properties: | |||
<syntaxhighlight lang="json"> | |||
sideopaque: { all: false }, | |||
drawtype: "liquid", | |||
renderpass: "liquid", | |||
matterstate: "liquid" | |||
</syntaxhighlight> | |||
== TopSoil == | |||
== CrossAndSnowlayer == | |||
This draws a cross just like the cross tessellator, but it also draws a snow layer at the bottom of the cube. These are the exact tessellators in this category: | |||
* CrossAndSnowlayer - 1/8th block of snow | |||
* CrossAndSnowlayer_2 - 2/8th block of snow | |||
* CrossAndSnowlayer_3 - 3/8th block of snow | |||
* CrossAndSnowlayer_4 - 4/8th block of snow | |||
The snow layer uses the top texture of the snowlayer-1 block. | |||
The <code>renderpass</code> property only affects the cross. The snow layer is always drawn in the Opaque pass. | |||
The <code>doNotRenderAtLod2</code> property only affects the cross. The snow layer is always drawn at level 1 (visible everywhere within the frustum). | |||
== JSONAndWater == | |||
== JSONAndSnowLayer == | |||
== SurfaceLayer == | |||
This draws decors on the surface of parent blocks. This only works for decor blocks. | |||
Only the culled faces are drawn, which is the opposite of most tessellators that draw everything except the culled faces. Typically the culled faces are those should not be drawn because they would not be seen anyway. The chunk renderer has special logic for decor blocks. It only marks only the face touching the parent block to be culled. That is correct for decor blocks with non-zero thickness, because the face touching the parent block is not visible. However, for decor blocks with 0 thickness, either the front or back face (normally culled) should be drawn, but not both. So the surface tessellator draws the culled face, because it is easier to find than the front face. This is also why the tessellator does not work for non-decor blocks. | |||
The texture is selected from the decor block based on which side of the parent block it is rendered on. So blocks using the renderer should include a texture for all 6 sides, typically through the "all" name. | |||
The decor subposition handling is hardcoded to only work with caveart type blocks. If the decor has a subposition, the tessellator selects a glyph from the texture. The [https://apidocs.vintagestory.at/api/Vintagestory.API.Config.GlobalConstants.html#Vintagestory_API_Config_GlobalConstants_CaveArtColsPerRow GlobalConstants.CaveArtColsPerRow] constant is used for both the glyphs per row and glyphs per column. If the decor extends past the end of the block, the extension is rendered if the neighboring block has the same material, otherwise the glyph is cropped at the end of the block so that the glyph isn't showing hanging off the end of the block. | |||
The [[Modding:Block_Json_Properties#p_renderpass|renderpass]] property is respected. | |||
The <code>doNotRenderAtLod2</code> property is respected. If the block is in the dark, then it is drawn at [[Modding:Level_of_detail|level]] 0 (only visible nearby). Else if <code>doNotRenderAtLod2</code> is true, then it is drawn at level 2 (visible up to medium distances). Else, it is drawn at level 1 (visible everywhere within the frustum). Most decors set <code>doNotRenderAtLod2</code> to true. | |||
{{Navbox/modding|Vintage Story}} | |||
