Interface IBlockCollisionConsumer

All Known Implementing Classes:

SimplePhysicsProvider, StandardPhysicsProvider

public interface IBlockCollisionConsumer

An interface for processing collisions provided by BlockCollisionProvider.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IBlockCollisionConsumer.Result	Result codes to terminate processing of collisions.

Method Summary

Modifier and Type	Method	Description
IBlockCollisionConsumer.Result	onCollision(int blockX, int blockY, int blockZ, org.joml.Vector3d direction, BlockContactData contactData, BlockData blockData, Box collider)	Process a collision between a block and the collider.
void	onCollisionDamage(int blockX, int blockY, int blockZ, org.joml.Vector3d direction, BlockContactData collisionData, BlockData blockData)	Process damage caused by block.
void	onCollisionFinished()	Called when all blocks are processed.
IBlockCollisionConsumer.Result	onCollisionSliceFinished()	Called when BoxBlockIterator used for iteration ends a slice.
IBlockCollisionConsumer.Result	probeCollisionDamage(int blockX, int blockY, int blockZ, org.joml.Vector3d direction, BlockContactData collisionData, BlockData blockData)	Test if the damage caused by block should stop processing and stop movement of collider.

Method Details

onCollision

IBlockCollisionConsumer.Result onCollision(int blockX,
 int blockY,
 int blockZ,
 org.joml.Vector3d direction,
 BlockContactData contactData,
 BlockData blockData,
 Box collider)

Process a collision between a block and the collider.

collisionData and blockData are only valid until this call returns.

Parameters:

blockX - X position of block

blockY - Y position of block

blockZ - Z position of block

direction - Direction collider is moving

contactData - Information about collision contact

blockData - Information about block

collider - Sub hitbox collision happens with

Returns:

Return IBlockCollisionConsumer.Result.STOP or IBlockCollisionConsumer.Result.STOP_NOW to stop processing after this block or IBlockCollisionConsumer.Result.CONTINUE to continue

probeCollisionDamage

IBlockCollisionConsumer.Result probeCollisionDamage(int blockX,
 int blockY,
 int blockZ,
 org.joml.Vector3d direction,
 BlockContactData collisionData,
 BlockData blockData)

Test if the damage caused by block should stop processing and stop movement of collider.

collisionData and blockData are only valid until this call returns. The actual damage should be processed using onCollisionDamage(int, int, int, Vector3d, BlockContactData, BlockData).

Parameters:

blockX - X position of block

blockY - Y position of block

blockZ - Z position of block

direction - Direction collider is moving

collisionData - Information about collision contact

blockData - Information about block

Returns:

Return IBlockCollisionConsumer.Result.STOP or IBlockCollisionConsumer.Result.STOP_NOW to stop processing after this block or IBlockCollisionConsumer.Result.CONTINUE to continue

onCollisionDamage

void onCollisionDamage(int blockX,
 int blockY,
 int blockZ,
 org.joml.Vector3d direction,
 BlockContactData collisionData,
 BlockData blockData)

Process damage caused by block.

collisionData and blockData are only valid until this call returns.

Parameters:

blockX - X position of block

blockY - Y position of block

blockZ - Z position of block

direction - Direction collider is moving

collisionData - Information about collision contact

blockData - Information about block

onCollisionSliceFinished

IBlockCollisionConsumer.Result onCollisionSliceFinished()

Called when BoxBlockIterator used for iteration ends a slice.

Returns:

Return IBlockCollisionConsumer.Result.STOP or IBlockCollisionConsumer.Result.STOP_NOW to stop processing after this block or IBlockCollisionConsumer.Result.CONTINUE to continue

onCollisionFinished

void onCollisionFinished()

Called when all blocks are processed.