Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
Package pluginbase.Objects.World.Blocks

Classes

class  Air
 Air. This is a special block. More...
 
class  BlockBase
 A common base used to build all blocks More...
 
interface  IBlock
 An interface representing a block More...
 
interface  IBlockInteractable
 Describes a block that is interactable More...
 
class  MissingBlock
 Special block to represent a block that is missing More...
 

Enumerations

enum  BlockAnimationMode { BlockAnimationMode.None = 0, BlockAnimationMode.TextureSpritesheet = 1 }
 Defines the block animation mode More...
 
enum  BlockIconMode { BlockIconMode.Undefined =0, BlockIconMode.Cubified =1, BlockIconMode.Flat =2, BlockIconMode.Default = Cubified }
 An enumeration representing how a block is to be rendered More...
 
enum  BlockMeshLodMode { BlockMeshLodMode.None =0, BlockMeshLodMode.Skip, BlockMeshLodMode.Hidden }
 
enum  BlockMeshTransform { BlockMeshTransform.Static =0, BlockMeshTransform.DynamicTransform, BlockMeshTransform.DynamicClone }
 Define how a mesh in a block can be tranformed More...
 
enum  BlockPermeableMode { BlockPermeableMode.None =0, BlockPermeableMode.Permeable =1, BlockPermeableMode.Destroyable =2 }
 Describes how a block can behave when coming in contact with a liquid More...
 
enum  BlockRenderMode : int {
  BlockRenderMode.Invisible = 0, BlockRenderMode.Solid, BlockRenderMode.Transparent, BlockRenderMode.AllSides,
  BlockRenderMode.SolidMesh
}
 Defines how the block is rendered in the world More...
 
enum  BlockTextureMode : int { BlockTextureMode.Normal = 0, BlockTextureMode.Sided, BlockTextureMode.Stretched }
 Defines the way textures are rendered on a block More...
 
enum  BlockVertexMode : int { BlockVertexMode.Smoothed = 0, BlockVertexMode.Cubic, BlockVertexMode.TopFlat, BlockVertexMode.Unweighted }
 Defines the way verts are computed in the world geometry More...
 
enum  MaterialType : byte {
  MaterialType.Undefined =0, MaterialType.Metal =1, MaterialType.Crystalline =2, MaterialType.Mineral =3,
  MaterialType.Organic =4, MaterialType.Inorganic =5, MaterialType.Liquid =6, MaterialType.Gas =7,
  MaterialType.Plastic =8, MaterialType.Composite =9, MaterialType.Rare =10, MaterialType.Other =11,
  MaterialType.NonMaterial =255
}
 The best-estimated material type of a block More...
 

Enumeration Type Documentation

Defines the block animation mode

Enumerator
None 

No animation

TextureSpritesheet 

Animated texture

9  {
13  None = 0,
14 
19  }
Mouse movement will not be captured

An enumeration representing how a block is to be rendered

Enumerator
Undefined 

Undefined mode, will default

Cubified 

Rendered after the image is made to look like a cube

Flat 

Just the flat plain old image

Default 

Default. (Cubified)

9  {
13  Undefined=0,
14 
18  Cubified=1,
19 
23  Flat=2,
24 
29  }
Rendered after the image is made to look like a cube
Just the flat plain old image
Enumerator
None 

No LOD, will always display full geometry

Skip 

Skip triangles as it gets further away by the LodFactor

Hidden 

Hide geometry when Lod > LodFactor

6  {
10  None=0,
11 
15  Skip,
16 
20  Hidden,
21  }
Mouse movement will not be captured
Skip triangles as it gets further away by the LodFactor
Hide geometry when Lod > LodFactor

Define how a mesh in a block can be tranformed

Enumerator
Static 

The mesh is not transformed

DynamicTransform 

The mesh is transformed via a single Matrix (Defined in that method call)

DynamicClone 

The mesh is transformed by yielding instances of a matrix to determine its translation

9  {
13  Static=0,
14 
19 
24  }
The mesh is transformed by yielding instances of a matrix to determine its translation ...
The mesh is not transformed
The mesh is transformed via a single Matrix (Defined in that method call)

Describes how a block can behave when coming in contact with a liquid

Enumerator
None 

The block is not permeable (Either another liquid, or blocks liquid)

Permeable 

The block allows liquid to be transferred through it

Destroyable 

The block is destroyed when coming into contact with liquid

9  {
13  None=0,
14 
18  Permeable=1,
19 
23  Destroyable=2
24  }
Mouse movement will not be captured
The block allows liquid to be transferred through it
The block is destroyed when coming into contact with liquid

Defines how the block is rendered in the world

Enumerator
Invisible 

Invisible. The block is not renderable

Solid 

Solid. This is the normal appearance

Transparent 

Transparent block, eg water

AllSides 

Render all sides, all the time

SolidMesh 

The block is a mesh

7  : int
8  {
12  Invisible = 0,
13 
17  Solid,
18 
23 
27  AllSides,
28 
32  SolidMesh
33  }
Invisible. The block is not renderable
Solid. This is the normal appearance
Render all sides, all the time

Defines the way textures are rendered on a block

Enumerator
Normal 

Each face of the block contains the texture

Sided 

The texture is broken up into 4 quadrants in the following way: Top-Left: Top of block Top-Right: Bottom of block Bottom-Left: East and West of block Bottom-Right: North and south of block

Stretched 

The texture is stretched across the length of multiple blocks

7  : int
8  {
12  Normal = 0,
13 
21  Sided,
22 
26  Stretched
27  }
The texture is stretched across the length of multiple blocks
The texture is broken up into 4 quadrants in the following way: Top-Left: Top of block Top-Right: Bot...

Defines the way verts are computed in the world geometry

Enumerator
Smoothed 

Default. Smooths vertices to surrounding blocks

Cubic 

Forces vertices to be the exact edges of the block (eg 'Minecraft mode')

TopFlat 

Forces just the top and bottom plane to be aligned on the z-axis, but smooths X and Y

Unweighted 

The vertices are smoothed, but don't affect the weight of surrounding vertices

8  : int
9  {
13  Smoothed = 0,
14 
18  Cubic,
19 
23  TopFlat,
24 
29  }
Forces just the top and bottom plane to be aligned on the z-axis, but smooths X and Y ...
The vertices are smoothed, but don't affect the weight of surrounding vertices
Default. Smooths vertices to surrounding blocks
Forces vertices to be the exact edges of the block (eg 'Minecraft mode')