Appendices

Glossary

Block (GBlockData)is an entity component that exists in a cell of the grid. 
Properties
  • Elevation (int) is the grid-space height of the block.
  • BlockColor (float4) is the RGBA color of the block.
  • EmissionColor (float4) is the RGBA emission color of the block.
  • TileType (int) is a code used for changing the materials on a block.
  • TileBlend (float) is a 0-1 value for blending between two material textures.
  • ChangeWait (float) is a time value for delaying changes to a block.
  • AnimationT (float) is a 0-1 t-value for animating block elevation changes.

  • GridPosition (FGridPosition) is the position that the block occupies.
  • WorldPosition (float3) is the world-space position of the top of a block.
  • TransPosition (float3) is the world-space position of a block (typically the bottom of a block).
  • Scale (float3) is the current world-space scale of a block.

Block Component (GBlockComponentData) is an entity component that is placed on top of blocks, like trees and rocks.
Properties
  • GridPosition (FGridPosition) is the position that the block component occupies. Keep in mind that the block component does use the CellLayer value to index within a cell.
  • GotoPosition (float3) is the position the block component is moving towards.
  • GotoRotation (float3) is the rotation the block component is rotating towards.
  • TransPosition (float3) is the current world position of the block component.
  • Scale (float3) is the current scale of the block component.
  • PositionOffset (float3) is the world position offset of a block component within a cell.
  • ScaleSpeed (float) is the scale of the speed at which the component scales.
  • ChangeWait (float) is a time value for delaying changes to a block component.
  • MoveState (int) determines whether the block component is currently moving.
  • AnimationT (float) is a 0-1 t-value for animating block component spawn.
  • IsTemp (bool) determines if this block component is being used temporarily (e.g. for display) without residing in an environment.

Grid Position (FGridPosition)is a data structure that indexes things – like blocks and block components – that reside on the grid. 
Properties
  • Position (int3) is an XYZ value for a given cell in a layer of a grid. 
    • X and Z correspond to the X and Z values of square and hex grids. 
    • Y is saved for use with hex grids. See W for voxel vertical position.
  • Layer (int) is the id of the layer the FGridPosition is associated with.
  • CellLayer (int) denotes the layer within the cell that this position occupies.
    • Note: this is generally used for block components, but you could use it for any number of things that layer on a position.
  • Id (int) is the id of the position. It’s generally not used for any built-in functionality.
  • W (int) is the vertical space position, generally used for voxel mode.

Generated Meshes are flat planes that sit on top of blocks.

Layers (FLayer) are movable planes that contain blocks and block components.
Properties
  • InstanceId (int) is the id of the layer used for indexing.
  • Visibility (byte) is the visibility of the layer. Layers can be invisible and visible.
  • BlockZeroHeight (float) is the height of each block at zero elevation.
  • BlockElevationStep (float) is the world distance between each block elevation difference.
  • Position (float3) is the world position of the layer. Currently only the vertical Y value is used, meaning layers can only move up and down.


Additional Resources