‪GamecraftModdingAPI  ‪v1.8.0
‪The unofficial Gamecraft modding API
GamecraftModdingAPI.Blocks.BlockEngine Class Reference

‪Engine for executing general block actions More...

Inheritance diagram for GamecraftModdingAPI.Blocks.BlockEngine:

Classes

struct  BlockInitData
 ‪Holds information needed to construct a component initializer More...
 

Public Member Functions

bool BlockExists (EGID blockID)
 
float4 ConvertBlockColor (byte index)
 
void Dispose ()
 
EGID? FindBlockEGID (uint id)
 
GetBlockInfo< T, U > (Block block, Func< T, U > getter, U def=default)
 
bool GetBlockInfoExists< T > (Block block)
 
ref T GetBlockInfoViewStruct< T > (EGID blockID)
 
GetBlockInfoViewStruct< T, U > (Block block, Func< T, U > getter, U def=default)
 
Block[] GetBodyBlocks (uint sbid)
 
Cluster GetCluster (uint sbid)
 
SimBody[] GetClusterBodies (uint cid)
 
Block[] GetConnectedBlocks (EGID blockID)
 
SimBody[] GetConnectedSimBodies (uint id)
 
ObjectIdentifier[] GetObjectIDsFromID (byte id, bool sim)
 
SimBody[] GetSimBodiesFromID (byte id)
 
void Ready ()
 
void SetBlockInfo< T, U > (Block block, Setter< T, U > setter, U value)
 
void SetBlockInfoViewStruct< T, U > (Block block, Setter< T, U > setter, U value)
 
delegate void Setter< T, U > (ref T component, U value)
 
void UpdateDisplayedBlock (EGID id)
 

Public Attributes

bool isRemovable => false
 

Package Functions

delegate FasterDictionary< RefWrapperType, ITypeSafeDictionary > GetInitGroup (EntityInitializer initializer)
 

Static Package Functions

static TDelegate CreateAccessor< TDelegate > (string memberName)
 

Package Attributes

GetInitGroup InitGroup = CreateAccessor<GetInitGroup>("_group")
 ‪Accesses the group field of the initializer More...
 

Properties

EntitiesDB entitiesDB [set]
 
string Name = "GamecraftModdingAPIBlockGameEngine" [get]
 

Detailed Description

Engine for executing general block actions

Member Function Documentation

◆ BlockExists()

bool GamecraftModdingAPI.Blocks.BlockEngine.BlockExists ( EGID  blockID)
inline

◆ ConvertBlockColor()

float4 GamecraftModdingAPI.Blocks.BlockEngine.ConvertBlockColor ( byte  index)
inline

◆ CreateAccessor< TDelegate >()

static TDelegate GamecraftModdingAPI.Blocks.BlockEngine.CreateAccessor< TDelegate > ( string  memberName)
inlinestaticpackage
Type Constraints
TDelegate :Delegate 

◆ Dispose()

void GamecraftModdingAPI.Blocks.BlockEngine.Dispose ( )
inline

◆ FindBlockEGID()

EGID? GamecraftModdingAPI.Blocks.BlockEngine.FindBlockEGID ( uint  id)
inline

◆ GetBlockInfo< T, U >()

U GamecraftModdingAPI.Blocks.BlockEngine.GetBlockInfo< T, U > ( Block  block,
Func< T, U >  getter,
def = default 
)
inline
Type Constraints
T :unmanaged 
T :IEntityComponent 

◆ GetBlockInfoExists< T >()

bool GamecraftModdingAPI.Blocks.BlockEngine.GetBlockInfoExists< T > ( Block  block)
inline
Type Constraints
T :struct 
T :IEntityComponent 

◆ GetBlockInfoViewStruct< T >()

ref T GamecraftModdingAPI.Blocks.BlockEngine.GetBlockInfoViewStruct< T > ( EGID  blockID)
inline
Type Constraints
T :struct 
T :INeedEGID 
T :IEntityViewComponent 

◆ GetBlockInfoViewStruct< T, U >()

U GamecraftModdingAPI.Blocks.BlockEngine.GetBlockInfoViewStruct< T, U > ( Block  block,
Func< T, U >  getter,
def = default 
)
inline
Type Constraints
T :struct 
T :IEntityViewComponent 

◆ GetBodyBlocks()

Block [] GamecraftModdingAPI.Blocks.BlockEngine.GetBodyBlocks ( uint  sbid)
inline

◆ GetCluster()

Cluster GamecraftModdingAPI.Blocks.BlockEngine.GetCluster ( uint  sbid)
inline

◆ GetClusterBodies()

SimBody [] GamecraftModdingAPI.Blocks.BlockEngine.GetClusterBodies ( uint  cid)
inline

◆ GetConnectedBlocks()

Block [] GamecraftModdingAPI.Blocks.BlockEngine.GetConnectedBlocks ( EGID  blockID)
inline

◆ GetConnectedSimBodies()

SimBody [] GamecraftModdingAPI.Blocks.BlockEngine.GetConnectedSimBodies ( uint  id)
inline

◆ GetInitGroup()

delegate FasterDictionary<RefWrapperType, ITypeSafeDictionary> GamecraftModdingAPI.Blocks.BlockEngine.GetInitGroup ( EntityInitializer  initializer)
package

◆ GetObjectIDsFromID()

ObjectIdentifier [] GamecraftModdingAPI.Blocks.BlockEngine.GetObjectIDsFromID ( byte  id,
bool  sim 
)
inline

◆ GetSimBodiesFromID()

SimBody [] GamecraftModdingAPI.Blocks.BlockEngine.GetSimBodiesFromID ( byte  id)
inline

◆ Ready()

void GamecraftModdingAPI.Blocks.BlockEngine.Ready ( )
inline

◆ SetBlockInfo< T, U >()

void GamecraftModdingAPI.Blocks.BlockEngine.SetBlockInfo< T, U > ( Block  block,
Setter< T, U >  setter,
value 
)
inline
Type Constraints
T :unmanaged 
T :IEntityComponent 

◆ SetBlockInfoViewStruct< T, U >()

void GamecraftModdingAPI.Blocks.BlockEngine.SetBlockInfoViewStruct< T, U > ( Block  block,
Setter< T, U >  setter,
value 
)
inline
Type Constraints
T :struct 
T :IEntityViewComponent 

◆ Setter< T, U >()

delegate void GamecraftModdingAPI.Blocks.BlockEngine.Setter< T, U > ( ref T  component,
value 
)
Type Constraints
T :struct 
T :IEntityComponent 

◆ UpdateDisplayedBlock()

void GamecraftModdingAPI.Blocks.BlockEngine.UpdateDisplayedBlock ( EGID  id)
inline

Member Data Documentation

◆ InitGroup

GetInitGroup GamecraftModdingAPI.Blocks.BlockEngine.InitGroup = CreateAccessor<GetInitGroup>("_group")
package

‪Accesses the group field of the initializer

◆ isRemovable

bool GamecraftModdingAPI.Blocks.BlockEngine.isRemovable => false

Property Documentation

◆ entitiesDB

EntitiesDB GamecraftModdingAPI.Blocks.BlockEngine.entitiesDB
set

◆ Name

string GamecraftModdingAPI.Blocks.BlockEngine.Name = "GamecraftModdingAPIBlockGameEngine"
get

The documentation for this class was generated from the following files: