Package etithespirit.orimod.api.delegate

Interface ISpiritMaterialAcquisitionFunction

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ISpiritMaterialAcquisitionFunction

A function used to acquire a SpiritMaterial.

Author:

Eti

Method Summary

Modifier and Type	Method	Description
SpiritMaterial	getSpiritMaterial(net.minecraft.world.entity.Entity entity, net.minecraft.core.BlockPos standingOnTopOf, net.minecraft.core.BlockPos standingInsideOf, boolean isStandingIn)	Given an entity, the block it is above, and the block it is inside of, this is expected to return an appropriate SpiritMaterial based on an implementor-defined context.

Method Details

getSpiritMaterial

@Nonnull
SpiritMaterial getSpiritMaterial(@Nonnull
 net.minecraft.world.entity.Entity entity,
 @Nonnull
 net.minecraft.core.BlockPos standingOnTopOf,
 @Nonnull
 net.minecraft.core.BlockPos standingInsideOf,
 boolean isStandingIn)
                          throws ArgumentNullException

Given an entity, the block it is above, and the block it is inside of, this is expected to return an appropriate SpiritMaterial based on an implementor-defined context.

Parameters:

entity - The entity that is being tested, such as a player that is walking.

standingOnTopOf - The position of the block that the entity is standing on top of. This is not guaranteed to be the block that this function was registered with.

standingInsideOf - The position of the block occupying the same position as that entity. This is not guaranteed to be the block that this function was registered with.

isStandingIn - True if this function executed because the player is standing inside of an associated block, false if this function executed because the player is standing on top of an associated block.

Returns:

An SpiritMaterial best suited for the context of the two blocks.

Throws:

ArgumentNullException - If any of the input parameters are null.